Create a Scope

Response body

object

id

uuid | null

The scope identifier.

name

string

required

The scope name.

input

object

required

The input schema for the scope.

fields

array of objects

The input fields for this scope.

fields

object

path

string

The path to a field to be provided whenever an associated Workflow is executed.

A path may contain dot (.) separators to indicate hierarchy. So for example card.number would map to the JSON-equivalent { "card": { "number": <value> } } when executing a workflow targeting this scope.

type

string

The scope field type. Available operators differ based on the scope field type. For example, the gt operator may only be used when the field type is Numeric.

Numeric String

required

boolean

Whether this scope field is required or not. For input fields, this will cause an error upon triggering a Workflow Execution whenever this field is not present in the request body. For output fields, an error will occur when configuring a workflow that contains at least one path that does not return this field.

queryable

boolean

Defaults to true

Whether this field can be used by rules to constrain the workflow execution path. Default is true.

output

object

required

The output schema for the scope.

fields

array of objects

The output fields for this scope.

fields

object

path

string

The path to a field to be provided whenever an associated Workflow is executed.

A path may contain dot (.) separators to indicate hierarchy. So for example card.number would map to the JSON-equivalent { "card": { "number": <value> } } when executing a workflow targeting this scope.

type

string

The scope field type. Available operators differ based on the scope field type. For example, the gt operator may only be used when the field type is Numeric.

Numeric String

required

boolean

Whether this scope field is required or not. For input fields, this will cause an error upon triggering a Workflow Execution whenever this field is not present in the request body. For output fields, an error will occur when configuring a workflow that contains at least one path that does not return this field.

createdAt

date-time

The creation date.

updatedAt

date-time

The last update date.

Headers

object

Location

uri

The location that can be accessed to retrieve the created scope.

201The scope was created successfully.

400The request is invalid. The specific reason is returned in the response body.

401The requester is not authorized to access the resource.

500The request is valid but the server could not process it. The specific reason is returned in the response body.