Detalles de la petición
-
Uri: api/v9/additionalfields/{id}/type/{fieldType}/values?dataType={dataType}&parentId={par entId}&catalogId=
{catalogId}&userId={userId} -
Tipo: GET
-
Encabezados requeridos: content-type: application/json
X-Authorization: Bearer {token}
Parámetros
| Nombre | Tipo de dato | Obligatorio | Descripción |
|---|---|---|---|
| id | Número | Si | Identificador del objeto tipo lista. |
| fieldType | Texto | Si | Tipo de datos - List = 3 - Recursive = 7 - CatalogList = 11 - CatalogTree = 12 |
| dataType | Texto | No | Tipo de datos a listar - All = 0, - Child = 1, - Parent = 2 Si no se envía se tomará por defecto listar los padres. |
| parentId | Número | No | Identificador del padre. |
| catalogId | Número | No | Tipo de catálogo - CatalogList = 11 - CatalogTree = 12 |
| UserId | Número | No | Identificar del cliente del caso |
Cuerpo de la petición
N/A
Ejemplos de 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
Respuesta
Listado de solo padres:
{
"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
}
Listado de solo hijos:
{
"content": [
{
"catalogId": 0,
"description": null, "fieldId": 5970,
"hasChild": false, "id": 2328,
"key": null,
"order": 0,
"parentId": 2327, "status": 0,
"value": "hijo311" }
],
"totalItems": 1
}
Listado de todos:
{
"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
}
Parámetros Response:
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| Id | Int | Identificador de la tarea |
| IdByProject | String | Identificador por proyecto de la tarea |
| totalItems | Número | Total de objetos en la búsqueda |
| totalPage | Número | Total de objetos por página |
| content | Listas | Listado de objetos casos |
Mensajes de error
| Código | Estado HTTP | Mensaje de error |
|---|---|---|
| 400 | BadRequest | \r\nNombre del parámetro: id |
| 400 | BadRequest | \r\nNombre del parámetro: fieldType |
| 400 | BadRequest | \r\nNombre del parámetro: catalogId |
| 400 | BadRequest | \r\nNombre del parámetro: parentId |
| 400 | BadRequest | InvalidFieldType |
| 403 | Forbidden | DoNotHavePermissionForThisAction |
| 500 | InternalServerError | FailureGetLookupValues |