Skip to content
XOS Developers

templateItems

Platform module · 5 operations

List template item rows

GET/template-items

An item of a template version (1032): a scope node created under the new project's engagement root ({KEY}-{suffix}), or a record due a number of days after the project start. Items of a published version are frozen (template_version_published: 422). Returns a cursor page of template item rows the caller may see. The default order is `template_version_id`, then `sort_order` ascending. Supports sparse fieldsets and the filter grammar.

Create a template item

POST/template-items

An item of a template version (1032): a scope node created under the new project's engagement root ({KEY}-{suffix}), or a record due a number of days after the project start. Items of a published version are frozen (template_version_published: 422). Creates a template item. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a template item

GET/template-items/{id}

An item of a template version (1032): a scope node created under the new project's engagement root ({KEY}-{suffix}), or a record due a number of days after the project start. Items of a published version are frozen (template_version_published: 422). Returns one template item with its `ETag`. A template item the caller may not see returns 404.

Update a template item

PATCH/template-items/{id}

An item of a template version (1032): a scope node created under the new project's engagement root ({KEY}-{suffix}), or a record due a number of days after the project start. Items of a published version are frozen (template_version_published: 422). 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.

Delete a template item

DELETE/template-items/{id}

An item of a template version (1032): a scope node created under the new project's engagement root ({KEY}-{suffix}), or a record due a number of days after the project start. Items of a published version are frozen (template_version_published: 422). Soft-deletes the template item: it moves to Trash and can be restored for its table's retention period.