EN
Español
English
Português
    Handling Additional Fields

    List of Additional Fields

    Petition Details

    • Base URL: {host}/ASMSAPI/
    • Uri: /api/v9/item/additionalfields
    • Type: POST
    • Required headings:

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

    URL Description

    • {host}: It represents the domain of the environment in which the API is located.
    • ASMSAPI/: Fixed API prefix.
    • URI: Specific endpoint for the request.


    EXAMPLE URL:

    https://{host}/ASMSAPI/api/v9/item/additionalfields
    


    Parameters

    Name Data type Obligatory Description
    Id Number No Case ID, this is sent if you require the additional field values of a case.
    itemType Text Yes Case Type
    consoleType Text Yes Console Type
    modelId Number Yes Model identifier
    stateId Number Yes State ID
    categoryId Number No If you have the data, it is sent.

    Body of the petition

    When is case creation

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

    Answer

    {
    
          "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
    
    }
    

    Response Parameters:

    Name Data type Description
    totalItems Number Total objects found in the search
    totalPage Number Total objects per page
    content List Item listing

    Error messages

    Code HTTP status Error Message
    400 BadRequest \r\nParameter Name: ItemType
    400 BadRequest \r\nParameter Name: ConsoleType
    400 BadRequest InvalidStateId
    400 BadRequest InvalidItemType
    400 BadRequest RequestNeedsSomeArguments
    500 InternalServerError FailureGetAdditionalFields