Get Workflow Meta Data

gethttps://api.flxpoint.com/workflow/meta-data

Use this when you want to pull workflow data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Request

Example request

get/workflow/meta-data

curl -X GET "https://api.flxpoint.com/workflow/meta-data" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json

dataTypesarray[GlobalDataType]

idintegerrequired

namestringrequired

handlestringrequired

allowedstringnumberbooleannumeric_optionscustom_actionarrayinheriteddateattributesstring_optionscustom_fieldscategory_copycustom_aggregate_fieldsimagesvariant_optionstagsbuilder_actioncategory_in_list

comparatorsarray[WorkflowDataTypeComparator]

idintegerrequired

globalDataTypeIdintegerrequired

namestringrequired

handlestringrequired

allowedarray_emptyarray_not_emptyarray_size_equalsarray_size_greater_thanarray_size_less_thanattributes_defaultboolean_equal_tocustom_aggregate_field_defaultcustom_fields_defaultdate_older_thandate_within_lastdate_greater_thandate_greater_than_equalsdate_older_than_equalsdecimal_place_valueequal_toequal_to_fieldgreater_thangreater_than_equal_togreater_than_equal_to_fieldgreater_than_fieldless_thanless_than_equal_toless_than_equal_to_fieldless_than_fieldnumber_does_not_existnumber_existsoption_equal_tooption_not_equal_topercent_greater_than_equal_to_fieldpercent_greater_than_fieldpercent_less_than_equal_to_fieldpercent_less_than_fieldstring_containsstring_contains_case_sensitivestring_does_not_existstring_ends_withstring_ends_with_case_sensitivestring_equals_fieldstring_equals_field_case_sensitivestring_equal_tostring_equal_to_case_sensitivestring_existsstring_lengthstring_not_containsstring_not_contains_case_sensitivestring_not_ends_withstring_not_ends_with_case_sensitivestring_not_equals_fieldstring_not_equals_field_case_sensitivestring_not_equal_tostring_not_equal_to_case_sensitivestring_not_starts_withstring_not_starts_with_case_sensitivestring_occurrence_of_characterstring_option_equal_tostring_option_not_equal_tostring_starts_withstring_starts_with_case_sensitivevariant_options_defaultstring_in_liststring_not_in_liststring_in_list_case_sensitivestring_not_in_list_case_sensitivetag_containstag_does_not_containscategory_in_list

hideInputboolean

usesOtherFieldbooleanrequired

preModifierboolean

preModifierResultGlobalDataTypeIdinteger

usesListboolean

actionsarray[WorkflowDataTypeAction]

idintegerrequired

namestringrequired

handlestringrequired

allowedaddadd_fieldall_po_line_items_custom_fields_to_textappend_as_sentenceapply_custom_actionattribute_addattribute_modifyattribute_removeattributes_to_htmlcapitalize_each_wordcustom_aggregate_field_addcustom_aggregate_field_modifycustom_aggregate_field_removecustom_field_addcustom_field_modifycustom_field_removedecode_htmldivide_bydivide_by_fieldleft_padlowercasemultiplymultiply_by_fieldoption_setpercent_changepo_custom_fields_to_textpostfixpostfix_with_fieldprefixprefix_with_fieldreplacereplace_case_sensitivereplace_character_at_indexreplace_character_occurrenceright_padsentence_casesetset_decimalset_to_emptyset_to_fieldsplit_by_valuesubstringsubtractsubtract_fieldtrimuppercasevariant_option_addvariant_option_modifyvariant_option_removeset_ones_place_value_tomapping_set

hideInputboolean

usesOtherFieldbooleanrequired

formulabooleanrequired

globalDataTypeIdinteger

formulaCanRunAgainstGlobalObjectIdsarray[integer]

If `formula=true` then this will be a list of `GlobalObject.id` that the formula can be applied against.

integer

globalDataTypeFilterIdsarray[integer]

Certain `GlobalObjectField`'s such as ones for quantities may wish to further restrict what types of actions they are allowed to run against. Actions that support this type of additional filtering will have the IDs of the filter types set here. The IDs in this array will correspond to the `GlobalObjectField.globalDataTypeFilterId` field.

integer

ruleTypesarray[WorkflowRuleType]

idintegerrequired

handlestringrequired

allowedconditionaltier

namestringrequired

Example response

{
  "dataTypes": [
    {
      "id": 0,
      "name": "string",
      "handle": "string"
    }
  ],
  "comparators": [
    {
      "id": 0,
      "globalDataTypeId": 0,
      "name": "string",
      "handle": "array_empty",
      "hideInput": true,
      "usesOtherField": true,
      "preModifier": true,
      "preModifierResultGlobalDataTypeId": 0,
      "usesList": true
    }
  ],
  "actions": [
    {
      "id": 0,
      "name": "string",
      "handle": "add",
      "hideInput": true,
      "usesOtherField": true,
      "formula": true,
      "globalDataTypeId": 0,
      "formulaCanRunAgainstGlobalObjectIds": [
        0
      ],
      "globalDataTypeFilterIds": [
        0
      ]
    }
  ],
  "ruleTypes": [
    {
      "id": 0,
      "handle": "conditional",
      "name": "string"
    }
  ]
}

OpenAPI fragment

{
  "get": {
    "summary": "Get Workflow Meta Data",
    "parameters": [],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetWorkflowMetaDataResponse"
            }
          }
        }
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight