Get during actions for instance transition API in Zoho WorkDrive

Get During Actions for an Instance Transition

This API retrieves the During Actions configured for a specific transition in a workflow instance.

Endpoints

get https://www.zohoapis.com/workdrive/api/v1/workflowinstances/{instance_id}/workflowactions

Copy full URL

OAuth Scope

WorkDrive.workflowinstances.READCopied!

curl --request GET \
  --url 'https://www.zohoapis.com/workdrive/api/v1/workflowinstances/{instance_id}/workflowactions?filter%5Btransition_id%5D={transition_id}' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

header = Map();
header.put("Accept","application/vnd.api+json");
response = invokeurl
[
url : "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/{instance_id}/workflowactions?filter%5Btransition_id%5D={transition_id}"
type : GET
headers : header
connection : "wdconnection"
];
info response;

Path Parameters

instance_idstring(Required)

The unique ID of the workflow instance.

Query Parameters

Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here

filter[transition_id]string(Required)

The transition ID for which the During actions must be retrieved.

  {
    "data": [
      {
        "id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003082",
        "type": "workflowactions",
        "attributes": {
          "action_type": "CREATE_OR_UPDATE_CUSTOM_META_DATA",
          "module": "FILE",
          "action_id_str": "7321386000000003082",
          "details": {
            "custom_meta_details": {
              "data_template_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003011",
              "custom_data": [
                {
                  "custom_field_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-NzMyMTM4NjAwMDAwMDAwMzAxMS03MzIxMzg2MDAwMDAwMDAzMDE2",
                  "display_name": "Note from the Author",
                  "type": "multiline_text",
                  "field_properties": {
                    "description": "",
                    "is_mandatory": true,
                    "is_searchable": true
                  }
                }
              ],
              "name": "Automation_Review"
            }
          },
          "category": 5
        },
        "links": {
          "self": "https://www.zohoapis.com/workdrive/api/v1/workflowactions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003082"
        }
      }
    ]
  }

▼ Show full