Skip to content

Validate input for an admin-launched Global action function.

POST
/api/workspace/admin/function-catalog/{functionId}/global-action/validate
curl --request POST \
--url https://example.com/api/workspace/admin/function-catalog/example/global-action/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "FunctionId": "example", "Input": "example", "CorrelationId": "example" }'
functionId
required
string
access_token
string

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

Request payload to validate an admin-launched Global action function.

object
FunctionId

Business function identifier.

string
nullable
Input

Action input object keyed by CLR property name.

nullable
CorrelationId

Optional correlation identifier.

string
nullable
Examplegenerated
{
"FunctionId": "example",
"Input": "example",
"CorrelationId": "example"
}

OK

Media typeapplication/json
object
Data

Backend-only action invocation validation result.

object
ActionId

Designer-owned action identifier, or null for admin-launched Global actions.

string
nullable
BusinessFunctionId

Business function identifier resolved from the binding.

string
nullable
BusinessFunctionVersionId

Published function version pinned for enqueue/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 ids.

Array<string>
nullable
InputSnapshot

Normalized action input JSON snapshot.

string
nullable
ValidationErrors

Validation errors returned by platform or package validation.

Array<object>
nullable

Structured validation error emitted during business-function execution or persistence.

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

Bad Request

Media typeapplication/json
object
Data

Backend-only action invocation validation result.

object
ActionId

Designer-owned action identifier, or null for admin-launched Global actions.

string
nullable
BusinessFunctionId

Business function identifier resolved from the binding.

string
nullable
BusinessFunctionVersionId

Published function version pinned for enqueue/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 ids.

Array<string>
nullable
InputSnapshot

Normalized action input JSON snapshot.

string
nullable
ValidationErrors

Validation errors returned by platform or package validation.

Array<object>
nullable

Structured validation error emitted during business-function execution or persistence.

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

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

Backend-only action invocation validation result.

object
ActionId

Designer-owned action identifier, or null for admin-launched Global actions.

string
nullable
BusinessFunctionId

Business function identifier resolved from the binding.

string
nullable
BusinessFunctionVersionId

Published function version pinned for enqueue/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 ids.

Array<string>
nullable
InputSnapshot

Normalized action input JSON snapshot.

string
nullable
ValidationErrors

Validation errors returned by platform or package validation.

Array<object>
nullable

Structured validation error emitted during business-function execution or persistence.

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