Skip to main content

Appointment Phases

Entity›Datastore›Datastore.Phase›Datastore.Phase.ActivityAppointment

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

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

Endpoints​

List Appointment Phases​

GET/v1/odata/Datastore_Phase_ActivityAppointment

Single Phase​

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

Fields​

Inherited Fields (from Phase)​

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

Relationships​

RelationshipTarget EntityCardinalityDescription
AppointmentActivity_Appointment1:NAppointment

Expanding Relationships​

GET/v1/odata/Datastore_Phase_ActivityAppointment({id})?$expand=Appointment
GET/v1/odata/Datastore_Phase_ActivityAppointment({id})/Appointment

Usage​

Query Available Phases​

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

Update Phase on Appointment​

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

Filtering Examples​

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