Validates a complete Activation configuration without starting a process.

POST

/api/workspace/workflow/configuration/workflow-definitions/{workflowDefinitionId}/activation/validate

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/workflow/configuration/workflow-definitions/example/activation/validate"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Mode\": 0, \"Precondition\": \"example\", \"ExplicitPermission\": { \"Mode\": 0, \"ResourcePath\": \"example\", \"ResponsibilityKey\": \"example\", \"AnyOf\": [ { \"ResourcePath\": \"example\", \"ResponsibilityKey\": \"example\" } ], \"Match\": 0, \"Permissions\": [ { \"Key\": \"example\", \"Transition\": \"example\" } ], \"Expression\": \"example\" } }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/workflow/configuration/workflow-definitions/example/activation/validate';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Mode":0,"Precondition":"example","ExplicitPermission":{"Mode":0,"ResourcePath":"example","ResponsibilityKey":"example","AnyOf":[{"ResourcePath":"example","ResponsibilityKey":"example"}],"Match":0,"Permissions":[{"Key":"example","Transition":"example"}],"Expression":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/workflow/configuration/workflow-definitions/example/activation/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Mode": 0, "Precondition": "example", "ExplicitPermission": { "Mode": 0, "ResourcePath": "example", "ResponsibilityKey": "example", "AnyOf": [ { "ResourcePath": "example", "ResponsibilityKey": "example" } ], "Match": 0, "Permissions": [ { "Key": "example", "Transition": "example" } ], "Expression": "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

Mode

integer format: int32

Allowed values: 0 1

Precondition

string

nullable

ExplicitPermission

Portable authoring value for admission to an operation on its context.

object

Mode

The source of a context permission rule.

integer format: int32

Allowed values: 0 1 2

ResourcePath

Resource scope used by Responsible.

string

nullable

ResponsibilityKey

Responsibility definition key used by Responsible.

string

nullable

AnyOf

Any selected responsibility may grant admission. When present, scalar ResourcePath/ResponsibilityKey must be absent.

Array<object>

nullable

A responsibility definition in an exact context resource scope.

object

ResourcePath

string

nullable

ResponsibilityKey

string

nullable

Match

How selected context permissions are combined.

integer format: int32

Allowed values: 0 1

Permissions

Selections used by InheritPermission.

Array<object>

nullable

An existing permission and its optional transition selector.

object

Key

string

nullable

Transition

string

nullable

Expression

Security DSL source used by Dsl.

string

nullable

Responses

200

application/json

object

Data

object

IsValid

boolean

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