Returns the complete authorized Task Definition collection without paging.

GET

/api/workspace/tasks/configuration/task-definitions

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/configuration/task-definitions"),
    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/configuration/task-definitions';
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/configuration/task-definitions \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

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

Items

Array<object>

nullable

object

TaskDefinitionId

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

State

integer format: int32

Allowed values: 0 1

ExecutionMode

integer format: int32

Allowed values: 0 1

SubjectMode

integer format: int32

Allowed values: 0 1 2

DefaultPriority

Signed 64-bit integer (-9223372036854775808 through 9223372036854775807). Output is an exact decimal string; do not convert through floating point.

string

/^-?[0-9]{1,19}$/

InputDataEntityDefinitionId

string

nullable

WorkingDataEntityDefinitionId

string

nullable

ActiveOutcomeCount

integer format: int32

TotalOutcomeCount

integer format: int32

CreatedAtUtc

string format: date-time

ModifiedAtUtc

string format: date-time

nullable

RowVersion

string format: uuid

Actions

object

CanRead

boolean

CanUpdate

boolean

CanSetState

boolean

CanManageOutcomes

boolean

CanManageInterruptionReasons

boolean

CanManageExecutionPolicy

boolean

CanManageTransitions

boolean

CanDelete

boolean

NumberPrefix

string

nullable

Actions

object

CanCreate

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": {
    "Items": [
      {
        "State": 0,
        "ExecutionMode": 0,
        "SubjectMode": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}