Reads valid example filters for the records a Wait Event related path reaches.

POST

/api/workspace/workflow/configuration/workflow-definitions/{workflowDefinitionId}/wait-event-authoring/filter

curl --request POST \
  --url https://example.com/api/workspace/workflow/configuration/workflow-definitions/example/wait-event-authoring/filter \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Path": [ "example" ] }'

Authorizations

• WorkspaceBearer

Parameters

Path Parameters

workflowDefinitionId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

object

Path

Array<string>

nullable

Example^generated

{
  "Path": [
    "example"
  ]
}

object

Path

Array<string>

nullable

Example^generated

{
  "Path": [
    "example"
  ]
}

object

Path

Array<string>

nullable

Example^generated

{
  "Path": [
    "example"
  ]
}

Responses

200

OK

Media typeapplication/json

object

Data

object

Examples

Array<string>

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}