Saltar al contenido

Create a record checklist item

Módulo Work

POST/record-checklist-itemsrecordChecklistItems.create

One checklist item of a record. Items are rows, never array positions. Creates a record checklist item. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad work.punch_list.write.
  • Alcances de OAuth: work.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: RecordChecklistItemCreate

recordChecklistItems.create: RecordChecklistItemCreate
CampoTipoObligatorioDescripción
record_idstring (uuid)SíIdentifier of the record.
positionintegerSíDisplay position.Restricciones: range 1 to any
labelstringSíItem label.Restricciones: length 1 to 300
donebooleanSíWhether the item is done.
evidence_document_idstring (uuid) | nullNoIdentifier of the photo or document evidence.
{
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "label": "Check the safety cables",
  "done": false,
  "evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: RecordChecklistItem

recordChecklistItems.create: RecordChecklistItem
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the record checklist item.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
record_idstring (uuid)SíIdentifier of the record.
positionintegerSíDisplay position.Restricciones: range 1 to any
labelstringSíItem label.Restricciones: length 1 to 300
donebooleanSíWhether the item is done.
done_bystring (uuid) | nullSíIdentifier of the person who ticked the item.
done_atstring (date-time) | nullSíWhen the item was ticked.
evidence_document_idstring (uuid) | nullSíIdentifier of the photo or document evidence.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "label": "Check the safety cables",
  "done": false,
  "done_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "done_at": "2026-10-08T14:30:00Z",
  "evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/record-checklist-items" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"label":"Check the safety cables","done":false,"evidence_document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.recordChecklistItems.create({
    "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "position": 1,
    "label": "Check the safety cables",
    "done": false,
    "evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.record_checklist_items.create({"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "position": 1, "label": "Check the safety cables", "done": False, "evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos record-checklist-items create --data '{"record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"label":"Check the safety cables","done":false,"evidence_document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'