EN
Español
English
Português
Getting Values from an Additional Combo Field
Petition Details
- Base URL: {host}/ASMSAPI/
- Uri: api/v9/additionalfields/{id}/type/{fieldType}/values?dataType={dataType}&parentId={par entId}&catalogId=
{catalogId}&userId={userId} - Type: GET
-
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/additionalfields/{id}/type/{fieldType}/values?dataType={dataType}&parentId={par entId}&catalogId=
{catalogId}&userId={userId}
Parameters
| Name | Data type | Obligatory | Description |
|---|---|---|---|
| Id | Number | Yes | Identifier of the list-type object. |
| fieldType | Text | Yes | Data Type - List = 3 - Recursive = 7 - CatalogList = 11 - CatalogTree = 12 |
| Datatype | Text | No | Type of data to list - All = 0, - Child = 1, - Parent = 2 If it is not sent, the parents will be listed by default. |
| parentId | Number | No | Parent ID. |
| catalogId | Number | No | Catalog Type - CatalogList = 11 - CatalogTree = 12 |
| UserId | Number | No | Identify the customer of the case |
Body of the petition
N/A
Examples of uri
- api/v9/additionalsfields/5970/type/7/Values
- api/v9/additionalsfields/5970/type/7/Values?datatype=parent
- additionalsfields/5970/type/7/Values?dataType=child&parentId=2323
- api/v9/additionalsfields/5970/type/7/Values?datatype=all
Answer
List of parents only:
{
"content": [
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2323,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre2" },
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2324,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre3" }
],
"totalItems": 2
}
List of children only:
{
"content": [
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": false, "id": 2328,
"key": null,
"order": 0,
"parentId": 2327, "status": 0,
"value": "hijo311" }
],
"totalItems": 1
}
List of all:
{
"content": [
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2323,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre2" },
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2324,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre3" },
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": true,
"id": 2327,
"key": null,
"order": 0,
"parentId": 2324,
"status": 0,
"value": "hijo31"
},
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": false,
"id": 2333,
"key": null,
"order": 0,
"parentId": null,
"status": 0,
"value": "padre1" }
],
"totalItems": 9
}
Response Parameters:
| Name | Data type | Description |
|---|---|---|
| Id | Int | Task ID |
| IdByProject | String | Task Project Identifier |
| totalItems | Number | Total objects in the search |
| totalPage | Number | Total objects per page |
| content | Lists | List of Objects Cases |
Error messages
| Code | HTTP status | Error Message |
|---|---|---|
| 400 | BadRequest | \r\nParameter Name: id |
| 400 | BadRequest | \r\nParameter Name: fieldType |
| 400 | BadRequest | \r\nParameter name: catalogId |
| 400 | BadRequest | \r\nParameter name: parentId |
| 400 | BadRequest | InvalidFieldType |
| 403 | Forbidden | DoNotHavePermissionForThisAction |
| 500 | InternalServerError | FailureGetLookupValues |