List Service Appointment Transitions

Purpose

List all the possible transitions that can be performed on a service appointment. E.g. if a service appointment is in the Dispatched status, then the transitions that can be performed on that service appointment are Start Work, Terminate, Cancel, etc.

The transitions that are supported for a service appointment are:

Reschedule, Dispatch, Start Work, Complete Work, Cancel, and Terminate

Request URL

https://fsm.zoho.com/fsm/v1/Service_Appointments/<record_id>/actions/blueprint/transitions

record_id - The unique ID of the record.

Request Method

GET

Scope

scope=ZohoFSM.modules.serviceappointments.READ

Sample Request

Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/Service_Appointments/2287000000425290/actions/blueprint/transitions' \
--header 'Authorization: Zoho-oauthtoken 1000.xxxxxx.xxxxxxe'

Sample Response

Copied{
    "code": "SUCCESS",
    "process_info": {
        "field_id": "2287000000115398",
        "api_name": "Status",
        "field_label": "Status",
        "name": "Service Appointments",
        "field_value": "Dispatched"
    },
    "transitions": [
        {
            "next_field_value": "In Progress",
            "name": "Start Work",
            "id": "2287000000169063",
            "type": "primary",
            "enabled": true
        },
        {
            "next_field_value": "Cannot Complete",
            "name": "Terminate",
            "id": "2287000000169069",
            "fields": [
                {
                    "display_label": "Notes",
                    "data_type": "notes",
                    "id": "0",
                    "transition_sequence": 1,
                    "mandatory": true
                }
            ],
            "enabled": true
        },
        {
            "next_field_value": "Cancelled",
            "name": "Cancel",
            "id": "2287000000169066",
            "fields": [
                {
                    "display_label": "Notes",
                    "data_type": "notes",
                    "id": "0",
                    "transition_sequence": 1,
                    "mandatory": true
                }
            ],
            "enabled": true
        },
        {
            "next_field_value": null,
            "name": "Download",
            "id": "2287000000410004",
            "enabled": true
        },
        {
            "next_field_value": null,
            "name": "Print",
            "id": "2287000000410008",
            "enabled": true
        }
    ],
    "status": "success"
}