Manejo del CAso
En esta sección se describen las operaciones relacionadas con el manejo de casos (creación, edición, consulta).
Creación del Caso
Detalles de la petición
-
URI: api/v8.6/item/add/{itemType}
-
Tipo: POST
-
Encabezados requeridos:
- content-type: application/json
- Authorization: TOKEN
- content-type: application/json
Parámetros:
| Nombre | Tipo de dato | Obligatorio | Descripción |
|---|---|---|---|
| AuthorId | Número | Si | Id del usuario que se registrará como autor del caso. |
| CategoryId | Número | Si | Id de la categoría asociada al caso. |
| CustomerId | Número | No | Id del cliente al que se le registrará el caso. Solo se requiere si el tipo de caso es diferente a problema. |
| CompanyId | Número | No | Id de la compañía al que se le registrará el caso. |
| ResponsibleId | Número | No | ID del usuario responsable del caso |
| Description | Texto | Si | Descripción del caso. |
| GroupId | Número | Si | Id del grupo de especialistas encargado de gestionar el caso. |
| ServiceId | Número | Si | Id del servicio relacionado al caso. |
| Subject | Texto | No | Asunto del caso |
| SlaId | Número | Si | Id del SLA relacionado al caso. |
| ProjectId | Número | Si | Id del proyecto en el que se creará el caso. |
| itemType | Número | Si | Tipo de caso a crear. Las opciones son: 1. Incidente 2. Problema 3. Cambio 4. Requerimiento de servicio |
| RegistryTypeId | Número | Si | Id del medio por el cual se registra el caso. |
| CiId | Número | No | Id del CI asociado al caso. Solo se requiere si el tipo de caso es problema. |
Cuerpo de la petición
La petición consiste de un arreglo json de tipo field-value con los posibles parámetros según se requiera. Ejemplo:
[
{"Field":"AuthorId","Value":3913},
{"Field":"CategoryId","Value":2499},
{"Field":"CustomerId","Value":8},
{"Field":"Description","Value":"Item description"},
{"Field":"GroupId","Value":33},
{"Field":"ProjectId","Value":2},
{"Field":"RegistryTypeId","Value":6},
{"Field":"ServiceId","Value":2418},
{"Field":"Sunbject","Value":"Item subject"},
{"Field":"SlaId","Value":2454},
{"Field":"UrgencyId","Value":3}
]
Respuesta
Como respuesta se obtiene un objeto json, con la siguiente información:
[
{
"Field": "itemId",
"Value": "4158"
},
{
"Field": "qs",
"Value": "?64B24DED26791E23A72364E9AF0E0430E93E2CF2F6D66AA4CB23CAAF7D8F"
},
{
"Field": "composedItemId", "Value": "IM-55175-2-19537"
},
{
"Field": "isClosed",
"Value": "False"
},
{
"Field": "result",
"Value": "True"
}
]
Mensajes de error
| Código | Estado HTTP | Mensaje de error |
|---|---|---|
| 400 | BadRequest | InvalidCaseData |
| 400 | BadRequest | InvalidAuthorId |
| 400 | BadRequest | InvalidCategory |
| 400 | BadRequest | InvalidCompany |
| 400 | BadRequest | InvalidDescription |
| 400 | BadRequest | InvalidGroup |
| 400 | BadRequest | InvalidItemType |
| 400 | BadRequest | InvalidStateConfiguraton |
| 400 | BadRequest | InvalidRegistryType |
| 400 | BadRequest | InvalidService |
| 400 | BadRequest | InvalidSla |
| 400 | BadRequest | InvalidUrgencyId |
| 400 | BadRequest | InvalidSessionId |
| 401 | Unauthorized | UnauthorizedIncidentCreation |
| 401 | Unauthorized | UnauthorizedChangeCreation |
| 401 | Unauthorized | UnauthorizedProblemCreation |
| 401 | Unauthorized | UnauthorizedServiceCallCreation |
| 500 | InternalServerError | FailureAddItem |