Validate action input before enqueue.

POST

/api/workspace/entity/{entityIdOrKey}/ui/actions/{actionId}/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/entity/example/ui/actions/example/validate"),
    Content = new StringContent("{ \"ActionTargetScope\": 0, \"EntityInstanceId\": \"example\", \"SelectedEntityInstanceIds\": [ \"example\" ], \"Input\": {}, \"CorrelationId\": \"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/entity/example/ui/actions/example/validate';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"ActionTargetScope":0,"EntityInstanceId":"example","SelectedEntityInstanceIds":["example"],"Input":{},"CorrelationId":"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/entity/example/ui/actions/example/validate \
  --header 'Content-Type: application/json' \
  --data '{ "ActionTargetScope": 0, "EntityInstanceId": "example", "SelectedEntityInstanceIds": [ "example" ], "Input": {}, "CorrelationId": "example" }'

Authorizations

None

Parameters

Path Parameters

entityIdOrKey

required

string

actionId

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

Public runtime request to validate or enqueue an action from a UI surface.

object

ActionTargetScope

integer format: int32

Allowed values: 0 1 2 3

EntityInstanceId

string

nullable

SelectedEntityInstanceIds

Array<string>

nullable

Input

object

CorrelationId

string

nullable

Responses

200

application/json

object

Data

Public validation result for a business-function action invocation.

object

ActionId

Designer-owned action identifier.

string

nullable

BusinessFunctionId

Business function identifier resolved from the action.

string

nullable

BusinessFunctionVersionId

Published function version selected for execution.

string

nullable

ActionTargetScope

integer format: int32

Allowed values: 0 1 2 3

EntityDefinitionId

Resolved entity definition identifier, when applicable.

string

nullable

EntityInstanceId

Resolved entity instance identifier, when applicable.

string

nullable

SelectedEntityInstanceIds

Normalized selected entity instance identifiers.

Array<string>

nullable

ValidationErrors

Validation errors returned by the platform or function.

Array<object>

nullable

Structured validation error emitted by a Validation business function.

object

FieldKey

Optional entity field key targeted by the error.

string

nullable

Message

User-facing validation message.

string

nullable

Code

Optional stable validation code.

string

nullable

IsValid

Whether the invocation passed validation.

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

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

400

Bad Request

application/json

object

Data

Public validation result for a business-function action invocation.

object

ActionId

Designer-owned action identifier.

string

nullable

BusinessFunctionId

Business function identifier resolved from the action.

string

nullable

BusinessFunctionVersionId

Published function version selected for execution.

string

nullable

ActionTargetScope

integer format: int32

Allowed values: 0 1 2 3

EntityDefinitionId

Resolved entity definition identifier, when applicable.

string

nullable

EntityInstanceId

Resolved entity instance identifier, when applicable.

string

nullable

SelectedEntityInstanceIds

Normalized selected entity instance identifiers.

Array<string>

nullable

ValidationErrors

Validation errors returned by the platform or function.

Array<object>

nullable

Structured validation error emitted by a Validation business function.

object

FieldKey

Optional entity field key targeted by the error.

string

nullable

Message

User-facing validation message.

string

nullable

Code

Optional stable validation code.

string

nullable

IsValid

Whether the invocation passed validation.

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

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

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Public validation result for a business-function action invocation.

object

ActionId

Designer-owned action identifier.

string

nullable

BusinessFunctionId

Business function identifier resolved from the action.

string

nullable

BusinessFunctionVersionId

Published function version selected for execution.

string

nullable

ActionTargetScope

integer format: int32

Allowed values: 0 1 2 3

EntityDefinitionId

Resolved entity definition identifier, when applicable.

string

nullable

EntityInstanceId

Resolved entity instance identifier, when applicable.

string

nullable

SelectedEntityInstanceIds

Normalized selected entity instance identifiers.

Array<string>

nullable

ValidationErrors

Validation errors returned by the platform or function.

Array<object>

nullable

Structured validation error emitted by a Validation business function.

object

FieldKey

Optional entity field key targeted by the error.

string

nullable

Message

User-facing validation message.

string

nullable

Code

Optional stable validation code.

string

nullable

IsValid

Whether the invocation passed validation.

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

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

Validate action input before enqueue.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

Example^generated