ES
Español
English
Português
    Lista de Campos Adicionales

    Detalles de la petición

    • URL Base: {host}/ASMSAPI/
    • Uri: /api/v9/company/additionalfields
    • Tipo: POST

    • Encabezados requeridos:

      • content-type: application/json
      • X-Authorization: Bearer {token}

    Descripción de la URL

    • {host}: Representa el dominio del ambiente en el que se encuentra la API.
    • ASMSAPI/: Prefijo fijo de la API.
    • Uri: Endpoint específico para la petición.

    ⚐ EJEMPLO URL:

    https://{host}/ASMSAPI/api/v9/company/additionalfield


    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    id Número No Identificador de la compañía, se envía en caso de requerir los valores de campos adicionales de una compañía.
    itemType Texto Sí Tipo de caso. Valores posibles: 1. Incidente 2. Problema 3. Cambio 4. Requerimiento de servicio 13. Liberación
    consoleType Texto Sí Tipo de consola
    modelId Número Sí Identificador del modelo
    stateId Número Sí Identificador del estado
    categoryId Número No Identificador de la categoría, por el cual filtrar
    asdkWeb Booleano Sí Origen Web ASDK
    parentId Número No Indica qué folder contiene el servicio
    projectId Número No Identificador del proyecto, por el cual filtrar
    serviceId Número No Identificador del servicio, por el cual filtrar

    Cuerpo de la petición

    • Cuando es creación de caso:
      {
      "asdkWeb": true,
      "categoryId": 520,
      "itemType": 4,
      "modelId": 31,
      "stateId": 25,
      "consoleType": "specialist"
  }
    • Cuando se requiere conocer los datos adicionales de un caso:
    {
    "asdkWeb": true,
    "id": 3018,
    "itemType": 4,
    "modelId": 31,
    "stateId": 25,
    "categoryId": 521,
    "consoleType": "specialist"
}

    respuesta

    {
    "content": [
        {
            "boolValue": null,
            "catalogId": null,
            "dataSourceId": null,
            "dateValue": null,
            "description": "[ES] Campo que contiene el id compuesto del caso en V8",
            "enable": false,
            "fieldId": 802,
            "fieldType": 1,
            "fieldTypeName": "ShortText",
            "floatValue": null,
            "identifier": "casov8",
            "inputStream": null,
            "intValue": null,
            "itemId": null,
            "mandatory": false,
            "name": "[ES] N° Caso en V8",
            "order": 1,
            "projectId": null,
            "stringValue": null,
            "type": null,
            "url": null,
            "visible": true
        },
        {
            "boolValue": null,
            "catalogId": null,
            "dataSourceId": null,
            "dateValue": null,
            "description": "[ES] Tiempo de desarrollo del reporte",
            "enable": true,
            "fieldId": 834,
            "fieldType": 14,
            "fieldTypeName": "Time",
            "floatValue": null,
            "identifier": "Tiempo de desarrollo del reporte",
            "inputStream": null,
            "intValue": null,
            "itemId": null,
            "mandatory": false,
            "name": "[ES] Tiempo de desarrollo del reporte",
            "order": 2,
            "projectId": null,
            "stringValue": null,
            "type": null,
            "url": null,
            "visible": true
        }
    ],
    "totalItems": 2
}

    Parámetros de Respuesta

    Nombre Tipo de dato Descripción
    totalItems Número Total de objetos encontrados en la búsqueda
    totalPage Número Total de objetos por página
    content Lista Listado de objetos

    Content

    Nombre Tipo de dato Descripción
    boolValue Booleano Valor booleano del campo adicional
    catalogId Número Valor del catálogo del campo adicional
    dateValue Fecha Valor fecha del campo adicional
    fieldId Número Identificador del campo adicional
    fieldType Número Tipo del campo
    floatValue Número Valor decimal del campo adicional
    identifier Texto Identificador del campo adicional
    inputStream Stream Valor en bytes del archivo para el campo adicional
    intValue Número Valor en número del campo adicional
    stringValue Texto Valor en texto del campo adicional
    mandatory Booleano Si el campo adicional es obligatorio o no
    description Texto Descripción del campo
    name Texto Nombre del campo
    order Número Orden del campo
    dataSourceId Número Identificador de sección
    enable Booleano Determina si está habilitado o no
    fieldTypeName Texto Descripción del tipo del campo
    hasDependencies Booleano Determina si el campo adicional tiene dependencias
    length Número Máximo de caracteres permitidos para un texto corto
    restrictLevel Booleano Valida el último nivel
    itemId Número Identi

    Mensajes de Error

    Código Estado HTTP Mensaje de error
    400 BadRequest Nombre del parámetro: ItemType
    400 BadRequest Nombre del parámetro: ConsoleType
    400 BadRequest InvalidStateId
    400 BadRequest InvalidItemType
    400 BadRequest RequestNeedsSomeArguments
    500 InternalServerError FailureGetAdditionalFields