Create a role assignment

Módulo People

POST/role-assignmentsroleAssignments.create

A canon workforce role staffed on a project, with its staffing ratio basis. Creates a role assignment. 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 people.role.write.
Alcances de OAuth: people.
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: RoleAssignmentCreate

roleAssignments.create: RoleAssignmentCreate
Campo	Tipo	Obligatorio	Descripción
project_id	string (uuid)	Sí	Identifier of the project.
role_code	RoleCode	Sí	Workforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
scope_node_id	string (uuid) \| null	No	Identifier of the scope node.
person_id	string (uuid)	Sí	Identifier of the assigned person.
requisition_id	string (uuid) \| null	No	Identifier of the requisition the assignment fills.
staffing_basis	"Declared" \| "Ratio" \| "Fixed"	No	How the role was sized: from the canon staffing ratio, a fixed canon count per tier, or declared.
starts_on	string (date) \| null	No	First day of the assignment.
ends_on	string (date) \| null	No	Last day of the assignment.

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_code": "5000.50.01",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "staffing_basis": "Declared",
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08"
}

Respuesta 201: RoleAssignment

roleAssignments.create: RoleAssignment
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the role assignment.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_id	string (uuid)	Sí	Identifier of the project.
role_code	RoleCode	Sí	Workforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
scope_node_id	string (uuid) \| null	Sí	Identifier of the scope node.
person_id	string (uuid)	Sí	Identifier of the assigned person.
requisition_id	string (uuid) \| null	Sí	Identifier of the requisition the assignment fills.
staffing_basis	"Declared" \| "Ratio" \| "Fixed"	Sí	How the role was sized: from the canon staffing ratio, a fixed canon count per tier, or declared.
starts_on	string (date) \| null	Sí	First day of the assignment.
ends_on	string (date) \| null	Sí	Last day of the assignment.
assignment_state	"Proposed" \| "Active" \| "Complete" \| "Canceled"	Sí	Assignment state.

{
  "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",
  "role_code": "5000.50.01",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "staffing_basis": "Declared",
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08",
  "assignment_state": "Proposed"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/role-assignments" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","role_code":"5000.50.01","scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","requisition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","staffing_basis":"Declared","starts_on":"2026-10-08","ends_on":"2026-10-08"}'

const { data } = await xos.roleAssignments.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "role_code": "5000.50.01",
    "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "staffing_basis": "Declared",
    "starts_on": "2026-10-08",
    "ends_on": "2026-10-08"
  });

response = xos.role_assignments.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "role_code": "5000.50.01", "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "staffing_basis": "Declared", "starts_on": "2026-10-08", "ends_on": "2026-10-08"})

xos role-assignments create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","role_code":"5000.50.01","scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","requisition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","staffing_basis":"Declared","starts_on":"2026-10-08","ends_on":"2026-10-08"}'