Saltar al contenido
XOS para desarrolladores

Create a requirement

Módulo Places

POST/requirementsrequirements.create

A requirement or a capability: one shape with a direction facet, so reconciliation is a join. Creates a requirement. 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 projects.scope.write.
  • Alcances de OAuth: projects.
  • 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: RequirementCreate

requirements.create: RequirementCreate
CampoTipoObligatorioDescripción
direction"Require" | "Provide"SíRequire for a requirement of the project, Provide for a capability a venue or counterparty offers.
project_idstring (uuid)SíIdentifier of the project.
venue_idstring (uuid) | nullNoIdentifier of the venue.
uridUridAtAnyGrainSíURID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Restricciones: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
descriptionstringSíWhat is required or provided.Restricciones: length 1 to 20000
quantitynumber | nullNoQuantity required or provided.
unit_basisUnitCodeNoUnit basis from the controlled unit list in `xpms.dim_unit_alias`.Restricciones: pattern ^[a-z][a-z0-9_-]*$
is_criticalbooleanNoWhether the requirement is critical.
counterparty_idstring (uuid) | nullNoIdentifier of the counterparty that provides a capability.
assertion_word"CERTIFIED" | "DOCUMENTED" | "CLAIMED" | "INFERRED" | "UNKNOWN"NoCanon capability assertion word (Bible tab 22); silence is UNKNOWN, which reconciles as Unknown.
{
  "direction": "Require",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "urid": "4000.01",
  "description": "Three-phase 400 A power at stage left.",
  "quantity": 1,
  "is_critical": true,
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "assertion_word": "DOCUMENTED"
}

Respuesta 201: Requirement

requirements.create: Requirement
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the requirement.
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.
direction"Require" | "Provide"SíRequire for a requirement of the project, Provide for a capability a venue or counterparty offers.
project_idstring (uuid)SíIdentifier of the project.
venue_idstring (uuid) | nullSíIdentifier of the venue.
uridUridAtAnyGrainSíURID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Restricciones: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
descriptionstringSíWhat is required or provided.Restricciones: length 1 to 20000
quantitynumber | nullSíQuantity required or provided.
unit_basisUnitCodeSíUnit basis from the controlled unit list in `xpms.dim_unit_alias`.Restricciones: pattern ^[a-z][a-z0-9_-]*$
is_criticalbooleanSíWhether the requirement is critical.
counterparty_idstring (uuid) | nullSíIdentifier of the counterparty that provides a capability.
assertion_word"CERTIFIED" | "DOCUMENTED" | "CLAIMED" | "INFERRED" | "UNKNOWN"SíCanon capability assertion word (Bible tab 22); silence is UNKNOWN, which reconciles as Unknown.
{
  "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",
  "direction": "Require",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "urid": "4000.01",
  "description": "Three-phase 400 A power at stage left.",
  "quantity": 1,
  "unit_basis": "each",
  "is_critical": true,
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "assertion_word": "DOCUMENTED"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/requirements" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"direction":"Require","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","urid":"4000.01","description":"Three-phase 400 A power at stage left.","quantity":1,"is_critical":true,"counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","assertion_word":"DOCUMENTED"}'
const { data } = await xos.requirements.create({
    "direction": "Require",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "urid": "4000.01",
    "description": "Three-phase 400 A power at stage left.",
    "quantity": 1,
    "is_critical": true,
    "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "assertion_word": "DOCUMENTED"
  });
response = xos.requirements.create({"direction": "Require", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "urid": "4000.01", "description": "Three-phase 400 A power at stage left.", "quantity": 1, "is_critical": True, "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "assertion_word": "DOCUMENTED"})
xos requirements create --data '{"direction":"Require","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","urid":"4000.01","description":"Three-phase 400 A power at stage left.","quantity":1,"is_critical":true,"counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","assertion_word":"DOCUMENTED"}'