Detalles de la petición
- URL Base: {host}/ASMSAPI/
- Uri: /api/v9/item/{id}/relation
- Tipo: POST
-
Encabezados requeridos:
- content-type: application/json
- X-Authorization: Bearer {token}
Descripción de la URL
- {host}: Representa el dominio del ambiente en el que se encuentra la API.
- ASMSAPI/: Prefijo fijo de la API.
- Uri: Endpoint específico para la petición.
⚐ EJEMPLO URL:
https://{host}/ASMSAPI/api/v9/item/{id}/relation
Parámetros:
| Nombre | Tipo de dato | Obligatorio | Descripción |
|---|---|---|---|
| id | Número | Si | Identificador del caso |
| itemType | Texto | Si | Tipo de caso |
| relatedItemType | Texto | Si | Tipo de caso a relacionar |
| relatedItemId | Número | Si | Identificador del ítem a relacionar |
| relationTypeId | Número | Si | Identificador del tipo de relación; no es obligatorio para el tipo de relación con artículos. |
| isSolution | bool | No | Indica si un artículo es solución; solo es obligatorio para cuando se va a relacionar un artículo con el caso |
| typeIsReverse | bool | No | Solo es obligatorio para cuando los tipos de caso son: - Incidents - Problem - Change - Release - ServiceCall - Task - Maintenance |
Cuerpo de la petición
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 Response
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| result | Booleano | Indica si la operación se realizó con éxito |
Mensajes de error
| Código | Estado HTTP | Mensaje de error |
|---|---|---|
| 400 | BadRequest | \r\nNombre del parámetro: Id |
| 400 | BadRequest | InvalidItemType |
| 400 | BadRequest | InvalidRelatedItemId |
| 400 | BadRequest | InvalidRelatedItemType |
| 400 | BadRequest | InvalidRelationTypeId |
| 400 | BadRequest | InvalidProjectId |
| 400 | BadRequest | RequestNeedsSomeArguments |
| 403 | Forbidden | DoNotHavePermissionForThisAction |
| 500 | InternalServerError | FailureAddRelatedItem |