Detalles de la petición:
-
URI: api/v8.6/ci/add
-
Tipo: POST
-
Encabezados requeridos:
- Content-Type: application/json
- Authorization: TOKEN
Parámetros:
Nombre | Tipo | Obligatorio | Descripción |
---|---|---|---|
Name | Texto | Si | Nombre del CI. |
ProjectId | Número | No | Id del Proyecto. |
GuId | Texto | No | Id externo del CI. Este campo es obligatorio sólo si el CI proviene de una integración. |
Type | Número | No | Tipo de CI. Este campo es obligatorio sólo si el CI proviene de una integración. Las opciones son: 1. Application 2. BusinessProcess 3. Catalog 4. Computer 5. Hub 6. Monitor 7. Phone 8. Printer 9. Router 10. Server 11. Service 12. SoftwareProduct 13. SystemSoftware 14. Tablet |
CategoryID | Número | No | Id de la categoría. Si se envía el campo Type en la petición, este campo no debe ser ingresado. |
AuthorId | Número | No | Id del autor. Si no se envía, se obtiene el del usuario asociado al token que se utiliza en la petición. |
Description | Texto | No | Descripción del Ci. |
Building | Texto | No | Nombre del edificio. |
City | Texto | No | Nombre de ciudad. |
Company | Texto | No | Nombre de la compañía. |
CostCenter | Texto | No | Centro de costo. |
Country | Texto | No | Nombre del país. |
CurrentStatus | Texto | No | Nombre del estado actual. |
Department | Texto | No | Nombre del departamento, Ej: Desarrollo. |
DepreciationMethod | Número | No | Id del método de depreciación (1: Línea recta, 2: Suma de dígitos). |
Floor | Texto | No | Nombre del piso, ej: 25-Sotano |
GroupId | Número | No | Id de la agrupación del CI. |
Impact | Número | No | Impacto del CI en la organización. |
Manufacturer | Texto | No | Nombre de la compañía fabricante del CI. |
Model | Texto | No | Modelo del CI. |
DepartmentNumber | Texto | No | Número del departamento. |
Price | Decimal | No | Precio del CI. |
CIProfile | Texto | No | Perfil del CI. |
ProgrammedStatus | Texto | No | Nombre del estado futuro del CI. |
Provider | Texto | No | Nombre de la compañía proveedora del CI. |
ResidualValue | Decimal | No | Valor a salvar del precio del CI. |
Alias | Texto | No | Usuario responsable del CI, puede ir en los siguientes formatos: Dominio\Usuario ó Usiario@Dominio |
Site | Texto | No | Sitio. |
Unit | Texto | No | Unidad de medida del CI ej: pulgadas |
UsefulLife | Número | No | Años de vida util del CI, para el cálculo de la depreciación |
Brand | Texto | No | Marca. |
AdditionalField: | |||
Type | Número | No | Los tipos de campos adicionales son: 1.Texto 2. Fecha 3. Lista 4. Texto largo 5. Check box 6. Número |
Value | - | No | Información que se va a ingresar al campo adicional, depende del tipo de dato que espere el campo adicional |
Id | Número | No | Id del campo adicional |
Observaciones :
-
El campo CITotal no hace parte de los parámetros, ya que se calcula automáticamente por la herramienta y es de uso interno.
-
La petición es sensible a mayúsculas y minúsculas, por tanto, se deben dejar los nombres de los parámetros tal como están en la tabla de parámetros.
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:
{
"Name": "Nombre del Ci",
"CategoryId": 19,
"GroupId": -1,
"CurrentStatus": "En uso",
"AuthorId": 3,
"ProgrammedStatus": "Estado Programado Prueba",
"Model": "GXP1200",
"Alias": " Usuario@Dominio ",
"AdditionalField": [
{
"Id": ###,
"Type": #,
"Value": "Valor"
}
]
}
Respuesta:
Como respuesta se obtiene un identificador único del CI creado.
Mensajes de error:
Código | Estado HTTP | Mensaje de error |
---|---|---|
400 | BadRequest | InvalidEventName |
400 | BadRequest | InvalidUserId |
400 | BadRequest | InvalidGuId |
400 | BadRequest | InvalidType |
400 | BadRequest | InvalidApplicationName |
400 | BadRequest | InvalidApplicationId |
400 | BadRequest | InvalidCiId |
400 | BadRequest | InvalidProjectIdByDefault |
400 | BadRequest | InvalidSubcategoryId |
400 | BadRequest | InvalidStateName |
400 | BadRequest | InvalidCompany |
400 | BadRequest | InvalidIdSettingGeneral |
400 | BadRequest | CatalogDescriptionIsRequired |
400 | BadRequest | InvalidCategoryId |
404 | NotFound | NotFoundStatesOfCMDB |
500 | InternalServerError | FailureAddCi |
500 | InternalServerError | FailureAddCiOrGetIdCi |