ZUzuper

Get Workflow Actions

Changed on

Returns the available actions for a given action_type and action_module (both required; 400 if missing or action_module is unrecognized). The EXECUTE_CUSTOM_FUNCTION action is only included if the company's custom_functions_enabled policy is on.

get/workflow/actions

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/workflow/actions
  • Auth
    API key in header x-api-key

Query parameters

action_typestring
action_modulestring

Response

200

typestring

Example response

{
  "type": "success",
  "data": [
    {
      "type_of_operation": {
        "label": "Update Fields",
        "value": "UPDATE_FIELDS"
      },
      "fields": [
        {
          "field_name": "Job Title",
          "field_key": "job_title",
          "field_type": "TEXT"
        }
      ],
      "custom_fields": [
        {
          "field_name": "test_JS",
          "field_type": "SINGLE_LINE",
          "field_placeholder": "JSSS",
          "lookup_module": "PRODUCT",
          "field_validation": "/.*/",
          "is_required": true,
          "group": {
            "module_name": "JOB",
            "group_name": "js",
            "group_uid": "6f6e5598-dc1c-40bd-b2bb-7435f6af4030",
            "category": {
              "category_uid": "d1da5619-2917-4508-8adc-d37b0c699a93",
              "category_name": "test",
              "category_color": "#3498db"
            },
            "associated_to": [
              {
                "category_uid": "d1da5619-2917-4508-8adc-d37b0c699a93",
                "category_name": "test",
                "category_color": "#3498db"
              }
            ],
            "order_no": 1
          },
          "field_key": "test_JS"
        }
      ]
    }
  ]
}

Changes