EN
Español
English
Português
    Task List

    Petition Details

    • Base URL: {host}/ASMSAPI/
    • Uri: /api/v9/item/{id}/type/{itemType}/relations/list?repository={repository}
    • 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/{id}/type/{itemType}/relations/list?repository={repository}
    


    Parameters

    Name Data type Obligatory Description
    Id Number Yes Case ID
    itemType Number Yes Case Type
    repository Number Yes Opened = 1, Closed - 2, All = 3.
    relatedItemType Number Yes Related Case Type
    isClosed Boolean Yes If the case is closed
    isReverse Boolean No True if the search is for your children. False if the search is for their parents.
    relationTypeId Number No Relationship ID

    Body of the petition

    {
    
          "isClosed": false,
    
          "isReverse": null,
    
          "relatedItemType": 6,     "relationTypeId": null 
    }
    

    Answer

    {
    
          "content": [
    
             {
    
                 "addInt1": 31680,
    
                 "addInt3": 84411,
    
                 "addInt4": null,
    
                 "addInt6": 1,
    
                 "addStr1": "IM-84411-19-100866",
    
                 "assetTag": null,
    
                 "authorId": 4826,
    
                 "authorName": "Cliente2",
    
                 "backgroundColorRgb": "255.212.0",             "brandName": null,
    
                 "categoryHierarchy": null,
    
                 "categoryId": 3,
    
                 "categoryName": "Aranda 360",
    
                 "checkOutDate": null,
    
                 "ciId": null,
    
                 "ciName": null,
    
                 "closedDate": null,
    
                 "companyId": null,
    
                 "companyName": null,
    
                 "content": null,
    
                 "created": null,
    
                 "createdDate": null,
    
                 "customerId": null,
    
                 "customerName": null,
    
                 "description": "mmm\n",
    
                 "groupId": 5,
    
                 "groupName": "CYS - Desarrollo",
    
                 "id": 84417,
    
                 "idByProject": "2076",
    
                 "identifier": null,
    
                 "interfaceId": null,
    
                 "isClosed": false,
    
                 "isInitStatus": false,
    
                 "isUserFavorite": false,
    
                 "ispublic": false,
    
                 "itemType": 6,
    
                 "itemTypeName": "Task",
    
                 "keyWords": null,
    
                 "lastModified": null,
    
                 "modelId": 62,
    
                 "modelName": "[ES] Tareas\_",
    
                 "modifierUserId": null,
    
                 "name": null,
    
                 "openedDate": 1630100444307,
    
                 "parentId": 0,
    
                 "projectId": 19,
    
                 "projectName": "Soporte - ASC",
    
                 "published": 0,
    
                 "ratingTotal": null,
    
                 "reasonName": null,
    
                 "relationTypeId": 143,
    
                 "relationTypeIsReverse": false,
    
                 "relationTypeName": "Manual",
    
                 "responsibleId": 4826,
    
                 "responsibleName": "Cliente2",
    
                 "serial": null,
    
                 "serviceId": 1,
    
                 "serviceName": "Consulta de configuración y\/o manejo",             "stateColor": "255.212.0",
    
                 "stateId": 324,
    
                 "stateName": "[ES] en proceso",
    
                 "subject": "mm",
    
                 "title": null,
    
                 "totalHit": null,
    
                 "type": null,
    
                 "typeId": null,
    
                 "typeName": null
    
             },
    
             {
    
                 "addInt1": 18720,
    
                 "addInt3": 84411,
    
                 "addInt4": null,
    
                 "addInt6": 1,
    
                 "addStr1": "IM-84411-19-100866",
    
                 "assetTag": null,
    
                 "authorId": 4826,
    
                 "authorName": "Cliente2",
    
                 "backgroundColorRgb": "204.204.204",
    
                 "brandName": null,
    
                 "categoryHierarchy": null,
    
                 "categoryId": 3,
    
                 "categoryName": "Aranda 360",
    
                 "checkOutDate": null,
    
                 "ciId": null,
    
                 "ciName": null,
    
                 "closedDate": null,
    
                 "companyId": null,
    
                 "companyName": null,
    
                 "content": null,
    
                 "created": null,
    
                 "createdDate": null,
    
                 "customerId": null,
    
                 "customerName": null,
    
                 "description": "aaaa\n",
    
                 "groupId": 5,
    
                 "groupName": "CYS - Desarrollo",
    
                 "id": 84420,
    
                 "idByProject": "2077",
    
                 "identifier": null,
    
                 "interfaceId": null,
    
                 "isClosed": false,
    
                 "isInitStatus": true,
    
                 "isUserFavorite": false,
    
                 "ispublic": false,
    
                 "itemType": 6,
    
                 "itemTypeName": "Task",
    
                 "keyWords": null,
    
                 "lastModified": null,
    
                 "modelId": 149,
    
                 "modelName": "[ES] Ingreso de personal10",
    
                 "modifierUserId": null,
    
                 "name": null,
    
                 "openedDate": 1630104764183,
    
                 "parentId": 0,
    
                 "projectId": 19,
    
                 "projectName": "Soporte - ASC",
    
                 "published": 0,
    
                 "ratingTotal": null,
    
                 "reasonName": null,
    
                 "relationTypeId": 73,
    
                 "relationTypeIsReverse": false,
    
                 "relationTypeName": "Automática",
    
                 "responsibleId": 4826,
    
                 "responsibleName": "Cliente2",
    
                 "serial": null,
    
                 "serviceId": 1,
    
                 "serviceName": "Consulta de configuración y\/o manejo",             "stateColor": "204.204.204",
    
                 "stateId": 6527,
    
                 "stateName": "[ES] estado t2",
    
                 "subject": "aaa",
    
                 "title": null,
    
                 "totalHit": null,
    
                 "type": null,
    
                 "typeId": null,
    
                 "typeName": null
    
             }
    
          ],
    
          "totalItems": 2 
    }
    

    Error messages

    Code HTTP status Error Message
    400 BadRequest InvalidRelations
    400 BadRequest IsReverseIsRequired
    400 BadRequest ValidationError
    500 InternalServerError FailureGetRelations