Document Phases

Entity›Datastore›Datastore.Phase›Datastore.Phase.ActivityDocument

Document Phases define the workflow stages for Documents. Use this endpoint to query the available phases and their IDs, which are needed to update the phase of a document.

Use the Datastore_Phase_ActivityDocument endpoint to query phases for this activity type.

Endpoints

List Document Phases

GET/v1/odata/Datastore_Phase_ActivityDocument

Single Phase

GET/v1/odata/Datastore_Phase_ActivityDocument({id})

Fields

Inherited Fields (from Phase)

See Phase Fields for all inherited fields including Name, Code, Icon, ActionName, IsAssignable, and IsTerminal.

Relationships

Relationship	Target Entity	Cardinality	Description
Document	Activity_Document	1:N	Document

Expanding Relationships

GET/v1/odata/Datastore_Phase_ActivityDocument({id})?$expand=Document

Navigating Relationships

GET/v1/odata/Datastore_Phase_ActivityDocument({id})/Document

Usage

Query Available Phases

GET/v1/odata/Datastore_Phase_ActivityDocument?$select=Name,Code,IsTerminal

Update Phase on Document

POST/v1/odata/Activity_Document

Filtering Examples

GET/v1/odata/Datastore_Phase_ActivityDocument?$filter=Name eq '{Name}'&$top={top}

GET/v1/odata/Datastore_Phase_ActivityDocument?$filter=Code eq '{Code}'&$top={top}

GET/v1/odata/Datastore_Phase_ActivityDocument?$filter=IsTerminal eq {IsTerminal}&$top={top}

GET/v1/odata/Datastore_Phase_ActivityDocument?$filter=IsAssignable eq {IsAssignable}&$top={top}

GET/v1/odata/Datastore_Phase_ActivityDocument?$filter=IsDefault eq {IsDefault}&$top={top}

Custom Query

Build your own OData query against Datastore_Phase_ActivityDocument. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.

GET/v1/odata/Datastore_Phase_ActivityDocument?$top=10