Skip to main content

Project Phases

EntityDatastoreDatastore.PhaseDatastore.Phase.ActivityProject

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

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

Endpoints

List Project Phases

GET/v1/odata/Datastore_Phase_ActivityProject

Single Phase

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

Fields

Inherited Fields (from Phase)

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

Relationships

RelationshipTarget EntityCardinalityDescription
ProjectActivity_Project1:NProject

Expanding Relationships

GET/v1/odata/Datastore_Phase_ActivityProject({id})?$expand=Project
GET/v1/odata/Datastore_Phase_ActivityProject({id})/Project

Usage

Query Available Phases

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

Update Phase on Project

POST /v1/odata/ActivityProject
{
"ID": "{activity-id}",
"Phase": {
"ID": "{phase-id}"
}
}

Filtering Examples

GET/v1/odata/Datastore_Phase_ActivityProject?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Datastore_Phase_ActivityProject?$filter=Code eq '{Code}'&$top={top}
GET/v1/odata/Datastore_Phase_ActivityProject?$filter=IsTerminal eq {IsTerminal}&$top={top}
GET/v1/odata/Datastore_Phase_ActivityProject?$filter=IsAssignable eq {IsAssignable}&$top={top}
GET/v1/odata/Datastore_Phase_ActivityProject?$filter=IsDefault eq {IsDefault}&$top={top}