Reads direct fields from the authorized activation description.

POST

/api/workspace/workflow/configuration/workflow-definitions/{workflowDefinitionId}/activation/authoring/precondition/paths

curl --request POST \
  --url https://example.com/api/workspace/workflow/configuration/workflow-definitions/example/activation/authoring/precondition/paths \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ExpectedDescriptorFingerprint": "example", "Prefix": "example", "CollectionScope": "example", "Offset": 1, "Limit": 1, "ExpectedResolvedDescriptorFingerprint": "example", "OuterCollectionScopes": [ "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

Direct members of Prefix, without a trailing dot. Empty Prefix selects roots or collection items. CollectionScope is the full collection path, or for a nested predicate the collection path within the item that OuterCollectionScopes reaches, outermost first. Continuations require the resolved identity of page zero.

object

ExpectedDescriptorFingerprint

string

nullable

Prefix

string

nullable

CollectionScope

string

nullable

Offset

integer format: int32

Limit

integer format: int32

ExpectedResolvedDescriptorFingerprint

string

nullable

OuterCollectionScopes

Array<string>

nullable

Example^generated

{
  "ExpectedDescriptorFingerprint": "example",
  "Prefix": "example",
  "CollectionScope": "example",
  "Offset": 1,
  "Limit": 1,
  "ExpectedResolvedDescriptorFingerprint": "example",
  "OuterCollectionScopes": [
    "example"
  ]
}

Direct members of Prefix, without a trailing dot. Empty Prefix selects roots or collection items. CollectionScope is the full collection path, or for a nested predicate the collection path within the item that OuterCollectionScopes reaches, outermost first. Continuations require the resolved identity of page zero.

object

ExpectedDescriptorFingerprint

string

nullable

Prefix

string

nullable

CollectionScope

string

nullable

Offset

integer format: int32

Limit

integer format: int32

ExpectedResolvedDescriptorFingerprint

string

nullable

OuterCollectionScopes

Array<string>

nullable

Example^generated

{
  "ExpectedDescriptorFingerprint": "example",
  "Prefix": "example",
  "CollectionScope": "example",
  "Offset": 1,
  "Limit": 1,
  "ExpectedResolvedDescriptorFingerprint": "example",
  "OuterCollectionScopes": [
    "example"
  ]
}

Direct members of Prefix, without a trailing dot. Empty Prefix selects roots or collection items. CollectionScope is the full collection path, or for a nested predicate the collection path within the item that OuterCollectionScopes reaches, outermost first. Continuations require the resolved identity of page zero.

object

ExpectedDescriptorFingerprint

string

nullable

Prefix

string

nullable

CollectionScope

string

nullable

Offset

integer format: int32

Limit

integer format: int32

ExpectedResolvedDescriptorFingerprint

string

nullable

OuterCollectionScopes

Array<string>

nullable

Example^generated

{
  "ExpectedDescriptorFingerprint": "example",
  "Prefix": "example",
  "CollectionScope": "example",
  "Offset": 1,
  "Limit": 1,
  "ExpectedResolvedDescriptorFingerprint": "example",
  "OuterCollectionScopes": [
    "example"
  ]
}

Responses

200

OK

Media typeapplication/json

object

Data

One ordered page, bound to the checked base and the complete resolved prefix snapshot.

object

BaseDescriptorFingerprint

string

nullable

Prefix

string

nullable

CollectionScope

string

nullable

ResolvedSchemaFingerprint

string

nullable

ResolvedDescriptorFingerprint

string

nullable

Offset

integer format: int32

NextOffset

integer format: int32

nullable

Members

Array<object>

nullable

Path is source text in the requested scope. A synthetic branch has neither Value nor Collection. CanExpand describes admitted descendants; a collection expands through its explicit item scope.

object

Path

string

nullable

Value

Id is opaque and stable within this collection scope until its binding changes.

object

Id

string

nullable

Path

string

nullable

ValueFamily

string

nullable

Nullable

boolean

Description

string

nullable

Operators

Operators admitted for this path in its collection scope, after owner restrictions.

Array<string>

nullable

Collection

Collection identity and description without its separately paged item paths.

object

Id

string

nullable

Path

string

nullable

Description

string

nullable

CanExpand

boolean

OuterCollectionScopes

The enclosing collections of a nested CollectionScope, as requested; omitted at the first level.

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
    }
  ]
}