Skip to content

Checks protected Executor admission and current capacity; dispatch repeats these checks atomically.

GET
/api/workspace/tasks/runtime/tasks/{taskId}/assignment-options/executor-capability
curl --request GET \
--url https://example.com/api/workspace/tasks/runtime/tasks/example/assignment-options/executor-capability \
--header 'Authorization: Bearer <token>'
taskId
required
string
workerId
string
access_token
string

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

OK

Media typeapplication/json
object
Data

Current dispatch capability for a selected Worker. A null WorkerId previews clearing assignment. CanAssign means no exception is needed; CapacityOverrideAvailable permits a reason-bearing exception. Both are advisory: dispatch repeats admission and capacity checks in its transaction.

object
RowVersion
string format: uuid
WorkerId
string
nullable
CanAssign
boolean
CapacityOverrideAvailable
boolean
ReasonCode
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
}
]
}

Bad Request

Media typeapplication/json
object
Data

Current dispatch capability for a selected Worker. A null WorkerId previews clearing assignment. CanAssign means no exception is needed; CapacityOverrideAvailable permits a reason-bearing exception. Both are advisory: dispatch repeats admission and capacity checks in its transaction.

object
RowVersion
string format: uuid
WorkerId
string
nullable
CanAssign
boolean
CapacityOverrideAvailable
boolean
ReasonCode
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
}
]
}

Forbidden

Media typeapplication/json
object
Data

Current dispatch capability for a selected Worker. A null WorkerId previews clearing assignment. CanAssign means no exception is needed; CapacityOverrideAvailable permits a reason-bearing exception. Both are advisory: dispatch repeats admission and capacity checks in its transaction.

object
RowVersion
string format: uuid
WorkerId
string
nullable
CanAssign
boolean
CapacityOverrideAvailable
boolean
ReasonCode
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
}
]
}

Not Found

Media typeapplication/json
object
Data

Current dispatch capability for a selected Worker. A null WorkerId previews clearing assignment. CanAssign means no exception is needed; CapacityOverrideAvailable permits a reason-bearing exception. Both are advisory: dispatch repeats admission and capacity checks in its transaction.

object
RowVersion
string format: uuid
WorkerId
string
nullable
CanAssign
boolean
CapacityOverrideAvailable
boolean
ReasonCode
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
}
]
}

Conflict

Media typeapplication/json
object
Data

Current dispatch capability for a selected Worker. A null WorkerId previews clearing assignment. CanAssign means no exception is needed; CapacityOverrideAvailable permits a reason-bearing exception. Both are advisory: dispatch repeats admission and capacity checks in its transaction.

object
RowVersion
string format: uuid
WorkerId
string
nullable
CanAssign
boolean
CapacityOverrideAvailable
boolean
ReasonCode
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
}
]
}