Skip to main content

List Workflow Library Actions

GET 

/workflow-library/actions

This lists the workflow actions available to you.

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq

    Example: id eq "sp:create-campaign"

Responses

List of workflow actions

Schema

  • Array [

  • id string

    Action ID. This is a static namespaced ID for the action

    name string

    Action Name

    type string

    Action type

    description string

    Action Description

    formFields

    object[]

    nullable

    One or more inputs that the action accepts

  • Array [

  • description string

    Description of the form field

    helpText string

    Describes the form field in the UI

    label string

    A human readable name for this form field in the UI

    name string

    The name of the input attribute

    required boolean

    Denotes if this field is a required attribute

    type stringnullable

    Possible values: [text, textarea, boolean, email, url, number, json, checkbox, jsonpath, select, multiType, duration, toggle, formPicker, identityPicker, governanceGroupPicker, string, object, array, secret, keyValuePairs, emailPicker, advancedToggle, variableCreator, htmlEditor]

    The type of the form field

  • ]

  • exampleOutput

    object

    oneOf

    Example output

    object

    deprecated boolean
    deprecatedBy date-time
    versionNumber integer

    Version number

    isSimulationEnabled boolean
    isDynamicSchema boolean

    Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.

    outputSchema object

    Defines the output schema, if any, that this action produces.

  • ]

Loading...