Adds one eligible Worker pool source.

POST

/api/workspace/tasks/configuration/task-queues/{queueId}/composition/worker-sources

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/tasks/configuration/task-queues/example/composition/worker-sources"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Kind\": 0, \"SourceId\": \"example\", \"ExpectedQueueRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"OperationId\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
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-queues/example/composition/worker-sources';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Kind":0,"SourceId":"example","ExpectedQueueRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","OperationId":"example"}'
};

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

curl --request POST \
  --url https://example.com/api/workspace/tasks/configuration/task-queues/example/composition/worker-sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Kind": 0, "SourceId": "example", "ExpectedQueueRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "OperationId": "example" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

queueId

required

string

Query Parameters

access_token

string

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

Request Body

object

Kind

required

integer format: int32

Allowed values: 0 1 2

SourceId

string

nullable

ExpectedQueueRowVersion

required

string format: uuid

OperationId

string

nullable

Responses

200

application/json

object

Data

object

TaskQueue

object

TaskQueueId

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

State

integer format: int32

Allowed values: 0 1 2

CreatedAtUtc

string format: date-time

ModifiedAtUtc

string format: date-time

nullable

CreatedByUserId

string

nullable

ModifiedByUserId

string

nullable

RowVersion

string format: uuid

Actions

object

CanUpdate

boolean

CanActivate

boolean

CanDrain

boolean

CanDeactivate

boolean

CanDelete

boolean

SignalProfileId

string

nullable

Prioritization

required

object

Mode

required

integer format: int32

Allowed values: 0 1 2 3 4

Direction

required

integer format: int32

Allowed values: 0 1

Limits

required

object

MaxInProgressTasks

required

integer format: int32

nullable

MaxPostponedTasks

required

integer format: int32

nullable

WipWarningThreshold

required

integer format: int32

PausedWarningThreshold

required

integer format: int32

BlockedWarningThreshold

required

integer format: int32

DispatcherExceptions

required

object

AllowInProgressOverride

required

boolean

AllowPostponedOverride

required

boolean

UnserviceableBacklogPersistenceMinutes

integer format: int32

nullable

DrainingStalledPersistenceMinutes

integer format: int32

nullable

Selection

required

object

Mode

required

integer format: int32

Allowed values: 0 1 2 3 4

AlgorithmType

required

integer format: int32

Allowed values: 0 1

EmbeddedAlgorithm

required

integer format: int32

Allowed values: 0

SelectorFunctionId

required

string

nullable

Invocation

required

object

OnTaskEntered

required

boolean

OnTaskStateChanged

required

boolean

CronEnabled

required

boolean

CronExpression

required

string

nullable

TimeZoneId

required

string

nullable

ManualEnabled

required

boolean

RestrictExecutorQueueVisibility

required

boolean

HideTasksAssignedToOtherExecutors

required

boolean

ConsiderWorkSchedule

boolean

Composition

required

object

TaskDefinitionIds

required

Array<string>

nullable

WorkerSources

required

Array<object>

nullable

object

string

nullable

Kind

integer format: int32

Allowed values: 0 1 2

SourceId

string

nullable

DispatcherMappings

required

Array<object>

nullable

object

string

nullable

WorkspaceRoleId

string

nullable

ReturnPolicy

integer format: int32

Allowed values: 0 1

Replayed

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": {
    "TaskQueue": {
      "State": 0,
      "Prioritization": {
        "Mode": 0,
        "Direction": 0
      },
      "Selection": {
        "Mode": 0,
        "AlgorithmType": 0,
        "EmbeddedAlgorithm": 0
      },
      "Composition": {
        "WorkerSources": [
          {
            "Kind": 0
          }
        ]
      },
      "ReturnPolicy": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}