List Request Transitions

Purpose

List all the possible transitions that can be performed on a request. E.g. if a request is in the New status, then the transitions that can be performed on that request are Cancel, Terminate, etc.

Request URL

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

record_id - The unique ID of the record. You can obtain this ID from the List Requests API.

Request Method

GET

Scope

scope=ZohoFSM.modules.Requests.READ

Sample Request

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

Sample Response

Copied{
    "code": "SUCCESS",
    "process_info": {
        "field_id": "1439000000116816",
        "api_name": "Status",
        "field_label": "Status",
        "name": "Requests",
        "field_value": "New"
    },
    "transitions": [
        {
            "action_type": "RECORDACTION",
            "next_field_value": "Work In Progress",
            "name": "Convert to Work Order",
            "id": "1439000000214120",
            "type": "primary",
            "enabled": true
        },
        {
            "action_type": "RECORDACTION",
            "next_field_value": "Estimate Created",
            "name": "Convert to Estimate",
            "id": "1439000000214129",
            "enabled": true
        },
        {
            "action_type": "RECORDACTION",
            "next_field_value": "Cancelled",
            "name": "Cancel",
            "id": "1439000000214132",
            "fields": [
                {
                    "display_label": "Notes",
                    "data_type": "notes",
                    "id": "0",
                    "transition_sequence": 1,
                    "mandatory": true
                }
            ],
            "enabled": true
        },
        {
            "action_type": "RECORDACTION",
            "next_field_value": "Cannot Complete",
            "name": "Terminate",
            "id": "1439000000214135",
            "fields": [
                {
                    "display_label": "Notes",
                    "data_type": "notes",
                    "id": "0",
                    "transition_sequence": 1,
                    "mandatory": true
                }
            ],
            "enabled": true
        },
        {
            "action_type": "UIACTION",
            "next_field_value": null,
            "name": "Download",
            "id": "1439000000584002",
            "enabled": true
        },
        {
            "action_type": "UIACTION",
            "next_field_value": null,
            "name": "Print",
            "id": "1439000000584006",
            "enabled": true
        },
        {
            "action_type": "UIACTION",
            "next_field_value": null,
            "name": "Change Territory",
            "id": "1439000001353005",
            "enabled": true
        }
    ],
    "status": "success"
}