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

200

List of workflow actions

application/json

Schema

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

MOD2

Array [

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.

• ]

Example (from schema)

[
  {
    "id": "sp:create-campaign",
    "name": "Create Certification Campaign",
    "type": "ACTION",
    "description": "Generates a certification campaign.",
    "formFields": [
      {
        "description": "First value to compare",
        "helpText": "The name to give to this certification campaign.",
        "label": "Campaign Name",
        "name": "name",
        "required": false,
        "type": "text"
      }
    ],
    "exampleOutput": {},
    "deprecated": true,
    "deprecatedBy": "2024-07-24T16:12:20.148Z",
    "versionNumber": 0,
    "isSimulationEnabled": true,
    "isDynamicSchema": false,
    "outputSchema": {
      "definitions": {},
      "properties": {
        "autoRevokeAllowed": {
          "$id": "#sp:create-campaign/autoRevokeAllowed",
          "default": true,
          "examples": [
            false
          ],
          "title": "autoRevokeAllowed",
          "type": "boolean"
        },
        "deadline": {
          "$id": "#sp:create-campaign/deadline",
          "default": "",
          "examples": [
            "2020-12-25T06:00:00.468Z"
          ],
          "format": "date-time",
          "pattern": "^.*$",
          "title": "deadline",
          "type": "string"
        },
        "description": {
          "$id": "#sp:create-campaign/description",
          "default": "",
          "examples": [
            "A review of everyone's access by their manager."
          ],
          "pattern": "^.*$",
          "title": "description",
          "type": "string"
        },
        "emailNotificationEnabled": {
          "$id": "#sp:create-campaign/emailNotificationEnabled",
          "default": true,
          "examples": [
            false
          ],
          "title": "emailNotificationEnabled",
          "type": "boolean"
        },
        "filter": {
          "$id": "#sp:create-campaign/filter",
          "properties": {
            "id": {
              "$id": "#sp:create-campaign/filter/id",
              "default": "",
              "examples": [
                "e0adaae69852e8fe8b8a3d48e5ce757c"
              ],
              "pattern": "^.*$",
              "title": "id",
              "type": "string"
            },
            "type": {
              "$id": "#sp:create-campaign/filter/type",
              "default": "",
              "examples": [
                "CAMPAIGN_FILTER"
              ],
              "pattern": "^.*$",
              "title": "type",
              "type": "string"
            }
          },
          "title": "filter",
          "type": "object"
        },
        "id": {
          "$id": "#sp:create-campaign/id",
          "default": "",
          "examples": [
            "2c918086719eec070171a7e3355a360a"
          ],
          "pattern": "^.*$",
          "title": "id",
          "type": "string"
        },
        "name": {
          "$id": "#sp:create-campaign/name",
          "default": "",
          "examples": [
            "Manager Review"
          ],
          "pattern": "^.*$",
          "title": "name",
          "type": "string"
        },
        "recommendationsEnabled": {
          "$id": "#sp:create-campaign/recommendationsEnabled",
          "default": true,
          "examples": [
            false
          ],
          "title": "recommendationEnabled",
          "type": "boolean"
        },
        "type": {
          "$id": "#sp:create-campaign/type",
          "default": "",
          "examples": [
            "MANAGER"
          ],
          "pattern": "^.*$",
          "title": "type",
          "type": "string"
        }
      },
      "title": "sp:create-campaign",
      "type": "object"
    }
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...