Atomically replaces the full capacity and dispatcher exceptions block.

PUT

/api/workspace/tasks/configuration/worker-profiles/{profileId}/capacity

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/tasks/configuration/worker-profiles/example/capacity"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Capacity\": { \"MaxAssignedTasks\": 1, \"CountAllUnfinishedAssignedTasks\": true, \"MaxInProgressTasks\": 1, \"MaxPausedTasks\": 1, \"MaxPostponedTasks\": 1, \"BlockedWarningThreshold\": 1, \"DispatcherExceptions\": { \"AllowAssignedOverride\": true, \"AllowInProgressOverride\": true, \"AllowPausedOverride\": true, \"AllowPostponedOverride\": true } }, \"ExpectedProfileRowVersion\": \"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/worker-profiles/example/capacity';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Capacity":{"MaxAssignedTasks":1,"CountAllUnfinishedAssignedTasks":true,"MaxInProgressTasks":1,"MaxPausedTasks":1,"MaxPostponedTasks":1,"BlockedWarningThreshold":1,"DispatcherExceptions":{"AllowAssignedOverride":true,"AllowInProgressOverride":true,"AllowPausedOverride":true,"AllowPostponedOverride":true}},"ExpectedProfileRowVersion":"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 PUT \
  --url https://example.com/api/workspace/tasks/configuration/worker-profiles/example/capacity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Capacity": { "MaxAssignedTasks": 1, "CountAllUnfinishedAssignedTasks": true, "MaxInProgressTasks": 1, "MaxPausedTasks": 1, "MaxPostponedTasks": 1, "BlockedWarningThreshold": 1, "DispatcherExceptions": { "AllowAssignedOverride": true, "AllowInProgressOverride": true, "AllowPausedOverride": true, "AllowPostponedOverride": true } }, "ExpectedProfileRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "OperationId": "example" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

profileId

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

Capacity

required

object

MaxAssignedTasks

required

integer format: int32

nullable

CountAllUnfinishedAssignedTasks

required

boolean

MaxInProgressTasks

required

integer format: int32

nullable

MaxPausedTasks

required

integer format: int32

nullable

MaxPostponedTasks

required

integer format: int32

nullable

BlockedWarningThreshold

required

integer format: int32

DispatcherExceptions

required

object

AllowAssignedOverride

required

boolean

AllowInProgressOverride

required

boolean

AllowPausedOverride

required

boolean

AllowPostponedOverride

required

boolean

ExpectedProfileRowVersion

required

string format: uuid

OperationId

string

nullable

Example^generated

{
  "Capacity": {
    "MaxAssignedTasks": 1,
    "CountAllUnfinishedAssignedTasks": true,
    "MaxInProgressTasks": 1,
    "MaxPausedTasks": 1,
    "MaxPostponedTasks": 1,
    "BlockedWarningThreshold": 1,
    "DispatcherExceptions": {
      "AllowAssignedOverride": true,
      "AllowInProgressOverride": true,
      "AllowPausedOverride": true,
      "AllowPostponedOverride": true
    }
  },
  "ExpectedProfileRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "OperationId": "example"
}

object

Capacity

required

object

MaxAssignedTasks

required

integer format: int32

nullable

CountAllUnfinishedAssignedTasks

required

boolean

MaxInProgressTasks

required

integer format: int32

nullable

MaxPausedTasks

required

integer format: int32

nullable

MaxPostponedTasks

required

integer format: int32

nullable

BlockedWarningThreshold

required

integer format: int32

DispatcherExceptions

required

object

AllowAssignedOverride

required

boolean

AllowInProgressOverride

required

boolean

AllowPausedOverride

required

boolean

AllowPostponedOverride

required

boolean

ExpectedProfileRowVersion

required

string format: uuid

OperationId

string

nullable

Example^generated

{
  "Capacity": {
    "MaxAssignedTasks": 1,
    "CountAllUnfinishedAssignedTasks": true,
    "MaxInProgressTasks": 1,
    "MaxPausedTasks": 1,
    "MaxPostponedTasks": 1,
    "BlockedWarningThreshold": 1,
    "DispatcherExceptions": {
      "AllowAssignedOverride": true,
      "AllowInProgressOverride": true,
      "AllowPausedOverride": true,
      "AllowPostponedOverride": true
    }
  },
  "ExpectedProfileRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "OperationId": "example"
}

object

Capacity

required

object

MaxAssignedTasks

required

integer format: int32

nullable

CountAllUnfinishedAssignedTasks

required

boolean

MaxInProgressTasks

required

integer format: int32

nullable

MaxPausedTasks

required

integer format: int32

nullable

MaxPostponedTasks

required

integer format: int32

nullable

BlockedWarningThreshold

required

integer format: int32

DispatcherExceptions

required

object

AllowAssignedOverride

required

boolean

AllowInProgressOverride

required

boolean

AllowPausedOverride

required

boolean

AllowPostponedOverride

required

boolean

ExpectedProfileRowVersion

required

string format: uuid

OperationId

string

nullable

Example^generated

{
  "Capacity": {
    "MaxAssignedTasks": 1,
    "CountAllUnfinishedAssignedTasks": true,
    "MaxInProgressTasks": 1,
    "MaxPausedTasks": 1,
    "MaxPostponedTasks": 1,
    "BlockedWarningThreshold": 1,
    "DispatcherExceptions": {
      "AllowAssignedOverride": true,
      "AllowInProgressOverride": true,
      "AllowPausedOverride": true,
      "AllowPostponedOverride": true
    }
  },
  "ExpectedProfileRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "OperationId": "example"
}

Responses

200

application/json

object

Data

object

Profile

object

TaskWorkerProfileId

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsDefault

boolean

Capacity

object

MaxAssignedTasks

required

integer format: int32

nullable

CountAllUnfinishedAssignedTasks

required

boolean

MaxInProgressTasks

required

integer format: int32

nullable

MaxPausedTasks

required

integer format: int32

nullable

MaxPostponedTasks

required

integer format: int32

nullable

BlockedWarningThreshold

required

integer format: int32

DispatcherExceptions

required

object

AllowAssignedOverride

required

boolean

AllowInProgressOverride

required

boolean

AllowPausedOverride

required

boolean

AllowPostponedOverride

required

boolean

CreatedAt

string format: date-time

ModifiedAt

string format: date-time

nullable

RowVersion

string format: uuid

CanManage

boolean

AffectedProfiles

Array<object>

nullable

object

TaskWorkerProfileId

string

nullable

RowVersion

string format: uuid

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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Atomically replaces the full capacity and dispatcher exceptions block.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

Example^generated

Example^generated

Example^generated