Reads one Queue dashboard through the same SQL runtime scope as navigation and lists.

GET

/api/workspace/tasks/runtime/queues/{queueId}

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/queues/example"),
    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/queues/example';
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/queues/example \
  --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

string

nullable

Name

string

nullable

Description

string

nullable

State

integer format: int32

Allowed values: 0 1 2

SelectionMode

integer format: int32

Allowed values: 0 1 2 3 4

RestrictExecutorQueueVisibility

boolean

HideTasksAssignedToOtherExecutors

boolean

SelectorAvailable

boolean

CanRequestWork

boolean

VisibleCount

integer format: int32

CountScope

string

nullable

Wip

integer format: int32

nullable

WipWarning

integer format: int32

nullable

Executing

integer format: int32

nullable

ExecutionMaximum

integer format: int32

nullable

Paused

integer format: int32

nullable

Blocked

integer format: int32

nullable

Postponed

integer format: int32

nullable

PostponedMaximum

integer format: int32

nullable

Conditions

Array<object>

nullable

object

Code

string

nullable

Severity

string

nullable

Count

integer format: int32

nullable

Threshold

integer format: int32

nullable

CanAcquire

boolean

CanDispatch

boolean

CanRunAuto

boolean

Definitions

Array<string>

nullable

Workers

Array<object>

nullable

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

object

string

nullable

Name

string

nullable

CanViewWorkload

The actor may read the pool Workers’ load: a Dispatcher of this Queue or a Task administrator of a Definition it admits.

boolean

Signals

Current Core aggregate signals, visible only with the Queue signal source grant.

Array<object>

nullable

object

string

nullable

TypeKey

string

nullable

Severity

integer format: int32

Allowed values: 0 1 2 3

Title

string

nullable

Body

string

nullable

DueAtUtc

string format: date-time

nullable

ActivatedAtUtc

string format: date-time

RequiresAcknowledgement

boolean

CanAcknowledge

boolean

Acknowledgement

Immutable acknowledgement facts of one exact signal occurrence.

object

AttentionSignalId

string

nullable

AcknowledgedByUserId

string

nullable

AcknowledgedByDisplayName

string

nullable

AcknowledgedAtUtc

string format: date-time

Note

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