Saltar al contenido principal

Comentar en la orden

POSThttps://carchost.fieldcontrol.com.br/orders/{id}/comments

Agrega un comentario a la orden de servicio en nombre de un autor de su sistema. La respuesta de éxito usa el estado 200.

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

Solicitud​

Parámetros de ruta

idstringobligatorio

Identificador de la orden de servicio.

Ejemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

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.

messagestringobligatorio

Texto del comentario.

Hasta 500 caracteres.

typestringobligatorio

Visibilidad: team (equipo), public (cliente), manager (gestores) o corporate.

Valores aceptados: team, public, manager, corporate.

archivedboolean

Crea el comentario ya archivado.

Predeterminado: false.

postedByobjectobligatorio

Autor del comentario en su sistema.

Campos de postedBy
externalIdstringobligatorio

Identificador del autor en su sistema. El mismo valor genera siempre el mismo postedBy.id.

Hasta 50 caracteres.

namestringobligatorio

Nombre del autor.

Hasta 50 caracteres.

avatarUrlstring

URL de la foto del autor.

Hasta 500 caracteres.Acepta: null.

Respuestas

  • 200

    Comentario creado.

  • 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.

  • 404

    Recurso no encontrado. El cuerpo de la respuesta está vacío.

  • 422

    Cuerpo inválido (resourceValidationErr): postedBy, message o type ausentes, type fuera de la lista o textos por encima del límite. Identificador de la orden inválido: uriValidationErr.

  • 429

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

  • 500

    Error inesperado en el servidor.