Reads assignment roles available to the current Task actor.

GET

/api/workspace/tasks/runtime/tasks/{taskId}/assignment-options

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/tasks/runtime/tasks/example/assignment-options"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
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/tasks/runtime/tasks/example/assignment-options';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://example.com/api/workspace/tasks/runtime/tasks/example/assignment-options \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

taskId

required

string

Query Parameters

access_token

string

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

Responses

200

application/json

object

Data

object

RowVersion

string format: uuid

Roles

Array<object>

nullable

object

Participant

integer format: int32

Allowed values: 0 1 2

Action

string

nullable

Current

A permitted participant identity. A null label never implies an unassigned participant.

object

string

nullable

Name

string

nullable

Position

Owner, responsible, or executor. Executor remains distinct from the Responsible evidence kind.

string

nullable

SelfId

Current actor’s Worker when that Worker may take Queue work.

string

nullable

CapacityOverrideAvailable

Retained wire member; selected-recipient capability comes from executor-capability.

boolean

CanViewWorkerLoad

The actor may read a performer candidate’s load: a Dispatcher or Task administrator of this work.

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": {
    "Roles": [
      {
        "Participant": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}