Saltar al contenido principal

Crear un equipo

POSThttps://carchost.fieldcontrol.com.br/equipments

Crea un equipo de un cliente (customer) o guardado en un inventario (storage), ya con las respuestas de los campos personalizados.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

namestringobligatorio

Nombre del equipo.

De 5 a 150 caracteres.

numberstringobligatorio

Número de serie. Debe ser único en la cuenta.

De 1 a 150 caracteres.

notesstring

Observaciones del equipo.

Hasta 500 caracteres.Acepta: null.

qrCodestring

Código QR. Debe ser único en la cuenta. Hasta 150 caracteres, o 255 cuando es una URL de código QR público de Field Control (contiene /qrcode-publico/#/ o /equipamentos/gerador-qrcodes/#/).

Acepta: null.

avatarUrlstring

URL de la foto del equipo.

Hasta 150 caracteres.Acepta: null.

archivedboolean

Archiva el equipo.

Predeterminado: false.

typeobjectobligatorio

Tipo del equipo, por id o por name (nombre exacto). Si se envían los dos, vale el id.

Campos de type
idstring

Identificador del tipo de equipo.

namestring

Nombre del tipo de equipo.

De 5 a 150 caracteres.

customerobject

Cliente dueño del equipo, por id o por name (nombre exacto). Si se envían los dos, vale el id.

Campos de customer
idstring

Identificador del cliente.

namestring

Nombre del cliente.

De 5 a 150 caracteres.

locationobject

Ubicación del cliente donde está el equipo.

Campos de location
idstringobligatorio

Identificador de la ubicación.

storageobject

Inventario donde se guarda el equipo.

Campos de storage
idstringobligatorio

Identificador del inventario.

customFieldslista de objetos

Respuestas de los campos personalizados del tipo de equipo. En la actualización, cuando se envía, reemplaza todas las respuestas actuales.

Un campo con condición de visualización (configurada en el Panel del Gestor) solo se muestra cuando el disparador tiene la respuesta esperada entre las respuestas enviadas. Responder un campo oculto devuelve 422 (hidden by condition), y un campo obligatorio con condición que queda visible sin respuesta devuelve 422 (required).

Campos de customFields
namestringobligatorio

Nombre del campo, igual al registrado en el tipo de equipo.

De 5 a 150 caracteres.

valuestringobligatorio

Respuesta. En multiple-choice, debe ser una de las opciones registradas.

De 1 a 500 caracteres.

typestringobligatorio

Tipo del campo.

Valores aceptados: question, date, multiple-choice, number.

positionstring

Posición de visualización.

Hasta 150 caracteres.Acepta: null.

Respuestas

  • 201

    Equipo creado. La respuesta no incluye labels ni status.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 422

    Cuerpo inválido (resourceValidationErr): customer y storage ausentes, number o qrCode ya usados en la cuenta (reason: duplicated), tipo o cliente no encontrados por el nombre (reason: not found), o respuesta de campo personalizado con nombre, tipo u opción inexistentes.

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.