Returns selection configuration and live selector diagnostics, without executing user code.

GET

/api/workspace/tasks/configuration/task-queues/{queueId}/selection

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-queues/example/selection"),
    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-queues/example/selection';
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-queues/example/selection \
  --header 'Authorization: Bearer <token>'

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.

Responses

200

application/json

object

Data

object

TaskQueueId

string

nullable

Selection

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

RowVersion

string format: uuid

CanManage

boolean

Selector

object

FunctionId

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SourceKind

string

nullable

SourceName

string

nullable

PublishedVersionId

string

nullable

PublishedVersionNumber

integer format: int32

nullable

Availability

integer format: int32

Allowed values: 0 1 2 3 4

EffectiveTimeZoneId

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

{
  "Data": {
    "Selection": {
      "Mode": 0,
      "AlgorithmType": 0,
      "EmbeddedAlgorithm": 0
    },
    "Selector": {
      "Availability": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}