PT
Español
English
Português
Lista de relacionamentos
Detalhes da petição
- URL base: {host}/ASMSAPI/
- Uri: /api/v9/item/{id}/type/{itemType}/relations/list?repository={repository}
- Tipo: POST
-
Títulos obrigatórios:
- tipo de conteúdo: application/json
- Autorização X: Portador {token}
Descrição do URL
- {host}: Ele representa o domínio do ambiente no qual a API está localizada.
- ASMSAPI/: Prefixo de API fixo.
- URI: Ponto de extremidade específico para a solicitação.
⚐ URL DE EXEMPLO:
https://{host}/ASMSAPI/ api/v9/item/{id}/type/{itemType}/relations/list?repository={repository}
Parâmetros
| Nome | Tipo de dado | Obrigatório | Descrição |
|---|---|---|---|
| Id | Número | Sim | Identificador de caso. |
| tipo de item | Texto | Sim | Tipo de caixa |
| relatedItemType | Texto | Sim | Tipo de caso a ser relacionado. Quando NÃO enviado, todos os tipos de casos relacionados a um item serão listados. |
| repositório | Texto | Sim | Indica se eles estão abertos - fechados Valores:- Aberto = 1, - Fechado = 2, - Todos = 3 Se não for por padrão, Aberto será atribuído. |
| relationTypeId | Número | Não | Identificador de tipo de relacionamento, quando não for enviado, todos os tipos de relacionamento serão listados. |
| é reverso | Booleano | Não | Para o único relacionamento que SIM É obrigatório para a relação que seria feita entre os casos.- true = Listagem principal - false = lista de crianças |
| Idioma | Texto | Sim | Idioma do sistema - esp = 0, - Ing = 1, - Por = 2, - Pt = 3 |
| está fechado | Booleano | Sim | Indica se o caso para o qual os relacionamentos estão sendo solicitados está aberto ou encerrado. |
Corpo da petição
Casos relacionados a todos os 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 de resposta:
| Nome | Tipo de dado | Descrição |
|---|---|---|
| conteúdo | Lista | Lista de objetos encontrados na pesquisa. |
| totalItems | Número | Número total de objetos encontrados |
##Mensajes de erro
| Código | Status HTTP | Mensagem de erro |
|---|---|---|
| 400 | Solicitação BadRequest | \r\nNome do parâmetro: id |
| 400 | Solicitação BadRequest | \r\nNome do parâmetro: ItemType |
| 400 | Solicitação BadRequest | InvalidProjectId |
| 400 | Solicitação BadRequest | Relações inválidas |
| 400 | Solicitação BadRequest | IsClosedIsRequired |
| 400 | Solicitação BadRequest | IsReverseIsRequired |
| 400 | Solicitação BadRequest | RelatedItemTypeIsRequired |
| 400 | Solicitação BadRequest | RequestNeedsSomeArguments |
| 403 | Proibido | DoNotHavePermissionForThisAction |
| 500 | Erro de servidor interno | FalhaGetRelations |