Skip to content
MoltaroMoltaroMoltaro Docs

Atomically saves selection and invocation settings; no executable schedules are created.

PUT
/api/workspace/tasks/configuration/task-queues/{queueId}/selection
curl --request PUT \
  --url https://example.com/api/workspace/tasks/configuration/task-queues/example/selection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Selection": { "Mode": 0, "AlgorithmType": 0, "EmbeddedAlgorithm": 0, "SelectorFunctionId": "example", "Invocation": { "OnTaskEntered": true, "OnTaskStateChanged": true, "CronEnabled": true, "CronExpression": "example", "TimeZoneId": "example", "ManualEnabled": true }, "RestrictExecutorQueueVisibility": true, "HideTasksAssignedToOtherExecutors": true, "ConsiderWorkSchedule": true }, "ExpectedQueueRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "OperationId": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
queueId
required
string

Query Parameters

Section titled “Query Parameters”
access_token
string

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

Request Body

Section titled “Request Body”
object
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
ExpectedQueueRowVersion
required
string format: uuid
OperationId
string
nullable

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/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
Id
string
nullable
Kind
integer format: int32
Allowed values: 0 1 2
SourceId
string
nullable
DispatcherMappings
required
Array<object>
nullable
object
Id
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
    }
  ]
}