Skip to content
XOS Developers

Delete a requirement

Places module

DELETE/requirements/{id}requirements.delete

A requirement or a capability: one shape with a direction facet, so reconciliation is a join. Soft-deletes the requirement: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability projects.scope.write.
  • OAuth scopes: projects.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

requirements.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the requirement.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/requirements/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.requirements.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.requirements.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos requirements delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f