EN
Español
English
Português
    Case List

    Petition Details

    • Base URL: {host}/ASMSAPI/
    • Uri: /api/v9/item/search
    • 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/search


    Parameters

    Name Data type Obligatory Description
    projects List Yes List of projects.
    Project Number Yes Project ID.
    Criteria Object Yes Object with lookup parameter.
    Note: It is mandatory that the object be included in the body of the request. However, there are no search parameters required; These may be empty.
    fieldValue Text No Field by which you want to search
    fieldName Text No Name of the field.
    operatorName Text No Carrier name.
    operatorValue Text No Operator value.
    value Text No Lookup value.
    valueName Text No Search value
    type Text No Data Type Value - None = 0, ShortText = 1, - Datetime = 2, - List = 3, - LongText = 4, - CheckBox = 5, - Numeric = 6, - Recursive = 7, - List2 = 8, - Decimal = 9, - File = 10, - CatalogList = 11, - CatalogTree = 12
    filterText Text No Text by which you want to search for a case within a case type, when this filter is used only this is required.
    types Object No List of case types.
    itemType Text No Type of case.
    orderField Text Yes Parameter by which sorting is required.
    Note: The parameters by which the ordering can be carried out are those that are included in the response to the request.
    orderType Text Yes Type of ordering - Asc - Desc
    pageSize Number Yes Amount of data to be returned for pagination.
    pageIndex Number Yes Page number.
    viewId Number No View identifier.
    repository Text No Identifier of the repository, if it is not sent, the default value of open will be taken.- Opened = 1 - Closed = 2 - All = 3

    Body of the petition

    {

      "criteria": [],

      "level": 0,

      "orderField": "openedDate",     "orderType": "desc",

      "pageIndex": 4,

      "pageSize": 50,

      "projects": [

         {

             "project": 25

         },

         {

             "project": 19

         }

      ],

      "repository": 1,

      "types": [

         {

             "itemType": 2         },

         {

             "itemType": 1         },

         {

             "itemType": 4         },

         {

             "itemType": 3         },

         {

             "itemType": 13         }

      ],

      "viewId": -6

}

    Answer

    {

      "content": [

        {

             "authorId": 4832,

             "authorName": "Especialista 1",

             "backgroundColorRgb": "0.174.239",

             "buildingId": null,

             "buildingName": null,

             "categoryHierarchy": "Corrección de Reporte",             "categoryId": 520,

             "categoryName": "Corrección de Reporte",

             "ciAssetTag": null,

             "ciId": null,

             "ciName": null,

             "ciSerial": null,

             "cityId": null,

             "cityName": null,

             "closedDate": null,

             "closenessToExpiration": 0,

             "companyId": 421,

             "companyName": "ACH COLOMBIA",

             "cost": null,

             "countryId": null,

             "countryName": null,

             "currentprogress": 0,

             "currenttime": 0,

             "customerId": null,

             "customerName": null,

             "departmentCode": null,

             "departmentCodeName": null,

             "descriptionNoHtml": "CambioCuota2FONDO DE EMPLEADOS DE ARANDA SOFTWARE - FAS OFT\nN.I.T. 901067439-6 
              FORMATO DE ACTUALIZACIÓN DE CUOTA DE AHORRO FECHA MES DIA AÑO 
              INFORMACION PERSONAL Nombres Apellidos Documento de indentidad Teléfono Celular Correo Electrónico                    
              TIPO DE AHORRO  (Seleccione con una X)        Ahorro Permanente   \ nAhorro Navideño \ nValor $ \ nPorcentaje %  \n
              Tipo de descuento:    Quincenal               Mensual             Quincena 1               Quincena 2 AUTORIZACIONES \nAutorizo a Aranda Software  ,  a la cual me encuentro vinculado para que deduzca de mi salario mensual , las cuotas que aquí rel aciono, los cuales deberán ser entregados a FASOFT por concepto de ahorros.\nFirma                                                                                             Observaciones:\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_C. C.No.",

             "duration": null,

             "effort": null,

             "estimatedTime": 1440,

             "expectedDate": 1632340067323,

             "finalDate": null,

             "finalStateId": 0,

             "floorId": null,

             "floorName": null,

             "foregroundColorRgb": "255.255.255",

             "groupId": 2,

             "groupName": "Soporte Nivel 1",

             "id": 84482,

             "idByProject": "RF-84482-19-407609",

             "impactId": 1,

             "impactName": "[ES] BAJO",

             "initialDate": null,

             "initialStatus": true,

             "isClosed": false,

             "isVotingProcess": false,

             "isimported": false,

             "itemType": 4,

             "itemTypeName": "Requerimiento de Servicio",

             "itemVersion": 1,

             "knownError": null,

             "majorProblem": null,

             "modelId": 31,

             "modelName": "[ES] RS Servicio Soporte",

             "modifiedDate": 1632253667323,

             "olaId": null,

             "olaName": null,

             "openedDate": 1632253667323,

             "parentId": null,

             "parentIdByProject": null,

             "parentItemType": null,

             "parentItemTypeId": null,

             "price": null,

             "priorityId": 8,

             "priorityName": "[ES] MEDIA",

             "progress": 0,

             "projectId": 19,

             "projectName": "Soporte - ASC",

             "providerId": null,

             "providerName": null,

             "realDate": null,

             "reasonId": null,

             "reasonName": null,

             "receptorId": 4557,

             "receptorName": "Victor Samuel Huertas Orjuela",

             "registryTypeId": 7199,

             "registryTypeName": "[ES] Chat",

             "responsibleId": 4557,

             "responsibleName": "Victor Samuel Huertas Orjuela",             "riskName": null,

             "serviceId": 10,

             "serviceName": "Reportes",

             "slaId": 1,

             "slaName": "Acuerdo Soporte",

             "stateId": 25,

             "stateName": "Registrado",

             "subject": "Test postman",

             "templateId": null,

             "time": 0,

             "ucId": null,

             "ucName": null,

             "unitId": null,

             "unitName": null,

             "urgencyId": 5,

             "urgencyName": "[ES] ALTA"

         }

      ],

      "totalItems": 36460,

      "totalPage": 1

}

    Response Parameters

    Name Data type Description
    totalItems Number Total number of items in the query.
    totalPage Number Total number of items per page
    content List List of found objects
    closenessToExpiration Enumerator OnProgress = 0, (<=79) - AlmostExpired = 1, ( between 80 and 99) - Expired = 2 (>= 100)

    Error messages

    Code HTTP status Error Message
    400 BadRequest \r\nParameter Name: TemplateId
    400 BadRequest InvalidProjectsList
    400 BadRequest NoPermission
    400 BadRequest InvalidTypesList
    400 BadRequest ProjectsListNeedsSomeArguments
    400 BadRequest TypesListNeedsSomeArguments
    500 InternalServerError FailureGetItems