Reads permitted commands and their current reason/Outcome options.

GET

/api/workspace/tasks/runtime/tasks/{taskId}/command-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/command-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/command-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/command-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

Actions

Array<object>

nullable

object

Key

string

nullable

Enabled

boolean

ReasonCode

string

nullable

ReasonRequired

The caller must send a written reason: with any block or resolution, when ending another performer’s postponement early, when changing or removing an assigned Executor (assign) and with a return to the Queue (return).

boolean

Reasons

Array<object>

nullable

object

string

nullable

Name

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2

Outcomes

Array<object>

nullable

object

string

nullable

Name

string

nullable

MetaType

integer format: int32

Allowed values: 0 1 2

Postponement

Postponements the Task has used and the current Definition policy. Used may exceed Maximum after the maximum was lowered; a new Postpone is then refused.

object

Used

integer format: int32

Maximum

integer format: int32

DelayMinutes

integer format: int32

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": {
    "Reasons": [
      {
        "Kind": 0
      }
    ],
    "Outcomes": [
      {
        "MetaType": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}