Saltar al contenido

Update a scope node

Módulo Projects

PATCH/scope-nodes/{id}scopeNodes.update

A node of the project scope tree: engagement root, standing venue or show. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad projects.scope.write.
  • Alcances de OAuth: projects.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

scopeNodes.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the scope node.

Cuerpo de la solicitud: ScopeNodeUpdate

scopeNodes.update: ScopeNodeUpdate
CampoTipoObligatorioDescripción
scope_codestringNoScope code, unique in the project.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
namestringNoScope node name.Restricciones: length 1 to 300
node_kindstringNoKind of node. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
{
  "scope_code": "E01",
  "name": "Opening Weekend",
  "node_kind": "Show"
}

Respuesta 200: ScopeNode

scopeNodes.update: ScopeNode
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the scope node.
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.
project_idstring (uuid)SíIdentifier of the project.
parent_idstring (uuid) | nullSíIdentifier of the parent scope node.
scope_codestringSíScope code, unique in the project.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
namestringSíScope node name.Restricciones: length 1 to 300
node_kindstringSíKind of node. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
pathstringSíMaterialized ltree path, derived.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "parent_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_code": "E01",
  "name": "Opening Weekend",
  "node_kind": "Show",
  "path": "root.e01"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/scope-nodes/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"scope_code":"E01","name":"Opening Weekend","node_kind":"Show"}'
const { data, etag } = await xos.scopeNodes.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "scope_code": "E01",
    "name": "Opening Weekend",
    "node_kind": "Show"
  }, { ifMatch: etag });
response = xos.scope_nodes.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"scope_code": "E01", "name": "Opening Weekend", "node_kind": "Show"}, if_match=etag)
xos scope-nodes update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"scope_code":"E01","name":"Opening Weekend","node_kind":"Show"}' --if-match auto