ZUzuper

Get All Workflow Conditions

Changed on

Returns the available condition fields (default + custom) for a given module and trigger event — required query params module_name and event_name (400 "Missing Module / Event Name" if either is omitted, 400 "Invalid Module Name" if module_name is unrecognized). Use the values from Get Workflow Modules.

get/workflow/conditions

Request

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

Query parameters

module_namestring required
event_namestring required

Response

200

typestring

Example response

{
  "type": "success",
  "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