EN
Español
English
Português
    List of Additional Fields

    Petition Details

    • URL Base: {host}/ASMSAPI/
    • URI: /api/v9/company/additionalfields
    • Guy: 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/company/additionalfield


    Parameters

    Name Data type Obligatory Description
    Id Number No Company Identifier, sent in case you require additional field values from a company.
    itemType Text Yes Type of case. Possible values: 1. Incident 2. Problem 3. Substitution 4. Service requirement 13. Liberation
    consoleType Text Yes Console Type
    modelId Number Yes Model identifier
    stateId Number Yes State ID
    categoryId Number No Category identifier, by which to filter
    asdkWeb Boolean Yes ASDK Web Source
    parentId Number No Indicates which folder the service contains
    projectId Number No Project ID, by which to filter
    serviceId Number No Service identifier, by which to filter

    Body of the petition

    • When it is case creation:
      {
      "asdkWeb": true,
      "categoryId": 520,
      "itemType": 4,
      "modelId": 31,
      "stateId": 25,
      "consoleType": "specialist"
  }
    • When additional data of a case is required:
    {
    "asdkWeb": true,
    "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

    Content

    Name Data type Description
    boolValue Boolean Boolean value of the additional field
    catalogId Number Additional field catalog value
    dateValue Date Date value of the additional field
    fieldId Number Additional field identifier
    fieldType Number Field Type
    floatValue Number Decimal value of the additional field
    identifier Text Additional field identifier
    inputStream Stream Byte value of the file for the additional field
    intValue Number Number value of the additional field
    stringValue Text Text value of the additional field
    mandatory Boolean Whether the additional field is required or not
    Description Text Course Description
    Name Text Field Name
    order Number Field Order
    dataSourceId Number Section ID
    enable Boolean Determine whether or not it’s enabled
    fieldTypeName Text Field Type Description
    hasDependencies Boolean Determines if the additional field has dependencies
    Length Number Maximum characters allowed for a short text
    restrictLevel Boolean Validate the last level
    itemId Number Identi

    Error Messages

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