Detalles de la petición
- Uri: / api/v9/item/{id}/type/{itemType}/relations/list?repository={repository}
- Tipo: POST
-
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 caso. |
| itemType | Texto | Si | Tipo del caso |
| relatedItemType | Texto | Si | Tipo de caso a relacionar. Cuando NO se envía se listarán todos los tipos de casos relacionados a un ítem. |
| repository | Texto | Si | Indica si son abiertos - cerrados Valores:- Opened = 1, - Closed = 2, - All = 3 En caso de no ir por defecto se asignará Opened. |
| relationTypeId | Número | No | Identificador del tipo de relación, cuando no se envía se listaran todos los tipo de relación |
| isReverse | Booleano | No | Para la única relación que SI es obligatoria es para la relación que se haría entre casos.- true = Listado de padres - false = listado de hijos |
| language | Texto | Si | Idioma del sistema - Esp = 0, - Ing = 1, - Por = 2, - Pt = 3 |
| isClosed | Booleano | Si | Indica si el caso al que se le están buscando las relaciones está abierto o cerrado. |
Cuerpo de la petición
Casos relacionado con todos los tipos de casos
- api/v9/item/17828/type/1/relations/list?repository=&language=0
- api/v9/item/17828/type/incidents/relations/list?repository=&language=esp
- Body:
{
` `“isClosed”:false }
- **Casos con tipos de casos y tipo de relación**
- *Incidents:*
- *Problem:*
- *Change:*
- *Release:*
- *ServiceCall:*
- *Maintenance:*
- api/v9/item/17828/type/1/relations/list?repository=&language=0
- api/v9/item/17828/type/incidents/relations/list?repository=&language=e sp
- Body:
*{*
*"isReverse":false,*
*"relatedItemType":2,*
*"relationTypeId":6,*
` `*"isClosed":false*
*}*
- **Casos con tipos de casos SIN tipo de relación.**
- *Incidents:*
- *Problem:*
- *Change:*
- *Release:*
- *ServiceCall:*
- *Maintenance:*
- api/v9/item/18261/type/1/relations/list?repository=3&language=0
- api/v9/item/18261/type/incidents/relations/list?repository=&language=esp
- Body:
*{*
*"isReverse":false,*
*"relatedItemType":3,*
` `*"isClosed":false*
*}*
- **Casos con solo el tipo de caso relacionado.**
- *Incidents:*
- *Problem:*
- *Change:*
- *Release:*
- *ServiceCall:*
- *Maintenance:*
- api/v9/item/18261/type/1/relations/list?repository=3&language=0
- api/v9/item/18261/type/incidents/relations/list?repository=&language=esp
- Body:
{
"relatedItemType":3,
` `"isClosed":false
}
- **Casos relacionados con:**
- Ci:
- Packages:
- Tipo de relación
- api/v9/item/17828/type/1/relations/list?repository=&language=0
- api/v9/item/17828/type/incidents/relations/list?repository=&lang uage=0
- Body :
{
"relatedItemType":21,
` `"relationTypeId":40,
` `"isClosed":false
}
- Todos los tipos de relación
- api/v9/item/17828/type/1/relations/list?repository=&language=0
- api/v9/item/17828/type/incidents/relations/list?repository=&lang uage=0
- Body :
{
"relatedItemType":21,
` `"isClosed":false
}
- Article:
- Tipo de relación
- api/v9/item/17828/type/1/relations/list?repository=&language=0
- api/v9/item/17828/type/incidents/relations/list?repository=&lang uage=0
- Body :
{
"relatedItemType":7,
"relationTypeId":36,
` `"isClosed":false
}
- Todos los tipos de relación
- api/v9/item/17828/type/1/relations/list?repository=&language=0
- api/v9/item/17828/type/incidents/relations/list?repository=&lang uage=0
- Body :
{
"relatedItemType":7,
` `"isClosed":false
}
Respuesta
{
"content": [
{
"assetTag": null,
"authorId": null,
"backgroundColorRgb": null,
"brandName": null,
"categoryId": null,
"categoryName": null,
"checkOutDate": null,
"closedDate": null,
"companyId": null,
"companyName": null,
"content": "",
"created": null,
"createdDate": null,
"description": "APROVALS",
"groupId": null,
"id": 1698,
"idByProject": null,
"identifier": "APROVALS",
"interfaceId": null,
"ispublic": false,
"itemType": 7,
"itemTypeName": "Artículo",
"keyWords": "",
"lastModified": 1504708702607, "modifierUserId": null,
"name": null,
"openedDate": 1493661749783,
"parentId": 0,
"published": 0,
"ratingTotal": 0,
"relationTypeId": 36,
"relationTypeIsReverse": false,
"relationTypeName": "Soluciona", "responsibleId": null,
"responsibleName": null, "serial": null,
"serviceId": null,
"serviceName": null,
"stateColor": "21.94.214", "stateId": 1866,
"stateName": "Nuevo",
"subject": null,
"title": "APROVALS",
"totalHit": null,
"type": null,
"typeId": 1091,
"typeName": "FAQ"
` }
],
` `"totalItems": 1
}
Parámetros Response:
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| content | Lista | Listado de objetos encontrados en la búsqueda. |
| totalItems | Número | Número total de objetos encontrados |
##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: ItemType |
| 400 | BadRequest | InvalidProjectId |
| 400 | BadRequest | InvalidRelations |
| 400 | BadRequest | IsClosedIsRequired |
| 400 | BadRequest | IsReverseIsRequired |
| 400 | BadRequest | RelatedItemTypeIsRequired |
| 400 | BadRequest | RequestNeedsSomeArguments |
| 403 | Forbidden | DoNotHavePermissionForThisAction |
| 500 | InternalServerError | FailureGetRelations |