x-cpod-domain: operations

Operations

Access requests, HR requests, pending items, equipment, and travel.

Try in explorer client.operations

AccessRequest

A request to grant, modify, or revoke system access.

REST path/api/v1/operations/access-requests

Operations

listgetcreateupdatedeleteapproveprovision

SDK

// list — returns only your records; add filters/search:
await client.operations.accessRequests.list()

// create:
await client.operations.accessRequests.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  requester_id: "example requester_id",
  system_id: "example system_id",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
requester_id*	string	User ID of the person requesting access.
system_id*	string	Target system identifier (e.g., github, aws, slack).
access_type*	enum	Type of access change requested.`newmodifyrevoke`
status	enum	Request lifecycle status.`pendingapprovedrejectedprovisionedcompleted`
justification*	string	Business justification for the access request.
approver_id	string	User ID of the approver.
approved_at	date-time	ISO 8601 timestamp when approved.
provisioned_at	date-time	ISO 8601 timestamp when access was provisioned.
asset_id	uuid	UUID of the TechnologyAsset to which this entitlement grants access.
principal_id	uuid	UUID of the Person or Group that holds this entitlement.
principal_type	enum	Whether principal_id refers to a Person or a Group.`persongroup`
entitlement_type	string	The specific permission role or access level granted.
granted_at	date-time	ISO 8601 timestamp when this entitlement was originally granted.
granted_by_id	uuid	UUID of the Person who approved or provisioned this entitlement.
expires_at	date-time	ISO 8601 timestamp when this entitlement is scheduled to expire.
tags	json	Free-form tags.

HRRequest

A request for an HR document or service deliverable.

REST path/api/v1/operations/hr-requests

Operations

listgetcreateupdatedeletefulfill

SDK

// list — returns only your records; add filters/search:
await client.operations.hrRequests.list()

// create:
await client.operations.hrRequests.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  requester_id: "example requester_id",
  type: "employment_letter",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
requester_id*	string	User ID of the person requesting the document/service.
type*	enum	Type of HR request.`employment_lettercertificateverificationdocumentother`
status	enum	Request lifecycle status.`pendingin_progresscompletedrejected`
description*	string	Description of the request.
deliverable_type	enum	How the deliverable will be provided.`digitalphysical`
deliverable_url	string	URL to the generated deliverable.
fulfilled_by	string	User ID of the HR person who fulfilled the request.
fulfilled_at	date-time	ISO 8601 timestamp when fulfilled.
tags	json	Free-form tags.

Pending

A generic pending item queued for processing or action.

REST path/api/v1/operations/pending

Operations

listgetcreateupdatedelete

SDK

// list — returns only your records; add filters/search:
await client.operations.pending.list()

// create:
await client.operations.pending.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  type: "example type",
  source_id: "example source_id",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
type*	string	Type of pending item (approval, task, review, etc.).
source_id*	string	ID of the source record (approval, task, etc.).
status	enum	Pending item status.`queuedprocessingblockedcompleted`
priority	number	Priority level (1 = highest, 5 = lowest).
assignee_id	string	User ID of the person assigned to this item.
due_at	date-time	ISO 8601 due date/time.
title	string	Human-readable title for the pending item.
entity_type	string	EDM entity type being approved (e.g. 'Expense', 'LeaveRequest', 'Contract').
entity_id	uuid	UUID of the specific entity instance awaiting approval.
requested_by_id	uuid	UUID of the Person who initiated this approval request.
description	string	Optional longer description or justification for the approval request.
current_step_index	integer	Zero-based index of the currently active approval step.
total_steps	integer	Total number of approval steps required before fully approved.
completed_at	date-time	ISO 8601 timestamp when the approval reached a terminal state.
tags	json	Free-form tags.

Equipment

An equipment provisioning request.

REST path/api/v1/operations/equipment

Operations

listgetcreateupdatedeleteprovision

SDK

// list — returns only your records; add filters/search:
await client.operations.equipment.list()

// create:
await client.operations.equipment.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  requester_id: "example requester_id",
  equipment_type: "example equipment_type",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
requester_id*	string	User ID of the person requesting equipment.
equipment_type*	string	Type of equipment (laptop, monitor, phone, etc.).
specification*	string	Detailed specification of the requested equipment.
status	enum	Equipment request lifecycle status.`requestedapprovedorderedshippeddeliveredreturned`
approver_id	string	User ID of the approver.
ordered_at	date-time	ISO 8601 timestamp when ordered.
delivered_at	date-time	ISO 8601 timestamp when delivered.
cost	number	Cost of the equipment.
tags	json	Free-form tags.

Travel

A business travel request.

REST path/api/v1/operations/travel

Operations

listgetcreateupdatedeletebook

SDK

// list — returns only your records; add filters/search:
await client.operations.travel.list()

// create:
await client.operations.travel.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  requester_id: "example requester_id",
  purpose: "example purpose",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
requester_id*	string	User ID of the person traveling.
purpose*	string	Business purpose of the travel.
destination*	string	Travel destination.
departure_at*	date-time	ISO 8601 departure date/time.
return_at*	date-time	ISO 8601 return date/time.
status	enum	Travel request lifecycle status.`requestedapprovedbookedcompletedcancelled`
approver_id	string	User ID of the approver.
booked_at	date-time	ISO 8601 timestamp when booked.
estimated_cost	number	Estimated total cost (flights, hotel, meals).
actual_cost	number	Actual total cost after travel.
tags	json	Free-form tags.

Docs

AccessRequest

HRRequest

Pending

Equipment

Travel