Detalhes da petição
- URL base: {host}/ASMSAPI/
- Uri: /api/v9/item/{id}/relation
- 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}/relation
Parâmetros:
Nome | Tipo de dado | Obrigatório | Descrição |
---|---|---|---|
Id | Número | Sim | ID do caso |
tipo de item | Texto | Sim | Tipo de caixa |
relatedItemType | Texto | Sim | Tipo de caso a ser relacionado |
relatedItemId | Número | Sim | Identificador do item a ser relacionado |
relationTypeId | Número | Sim | Identificador do tipo de relação; Não é obrigatório para o tipo de relacionamento com artigos. |
éSolução | Bool | Não | Indica se um item é uma solução; só é obrigatório para quando um artigo vai ser relacionado ao caso |
typeIsReverse | Bool | Não | Só é necessário para quando os tipos de caixa são: - Incidentes - Problema - Mudar - Soltar - Chamada de serviço - Tarefa - Manutenção |
Corpo da petição
Ejemplo de relación de **incidente** con **artículo**. {
"itemType":"Incidents", "relatedItemType":"Article", "relatedItemId":1704, "isSolution":"true"
}
Ejemplo de cuerpo de la relación de ***Incidente*** con ***ServiceCall***: {
"itemType":"1",
"relatedItemType":"1",
"relatedItemId":3328,
"relationTypeId":8,
"typeIsReverse":"false"
}
Ejemplo de ítem con ***ci***
{
"itemType":"Incidents",
"relatedItemType":"Ci",
"relatedItemId":890,
"relationTypeId":65,
"typeIsReverse":"false" }
*Respuesta*
{
"result": true }
Parâmetros de resposta
Nome | Tipo de dado | Descrição |
---|---|---|
resultado | Booleano | Indica se a operação foi bem-sucedida |
Mensagens de erro
Código | Status HTTP | Mensagem de erro |
---|---|---|
400 | Solicitação BadRequest | \r\nNome do parâmetro: id |
400 | Solicitação BadRequest | InvalidItemType |
400 | Solicitação BadRequest | InvalidRelatedItemId |
400 | Solicitação BadRequest | InvalidRelatedItemType |
400 | Solicitação BadRequest | InvalidRelationTypeId |
400 | Solicitação BadRequest | InvalidProjectId |
400 | Solicitação BadRequest | RequestNeedsSomeArguments |
403 | Proibido | DoNotHavePermissionForThisAction |
500 | Erro de servidor interno | FailureAddRelatedItem |