Links, changes, or unlinks the current Worker for a user.

PUT

/api/workspace/users/{userId}/worker

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/users/example/worker"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"WorkerId\": \"example\", \"ExpectedAssociationVersion\": \"example\", \"OperationId\": \"example\", \"ChangeReason\": \"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/users/example/worker';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"WorkerId":"example","ExpectedAssociationVersion":"example","OperationId":"example","ChangeReason":"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/users/example/worker \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "WorkerId": "example", "ExpectedAssociationVersion": "example", "OperationId": "example", "ChangeReason": "example" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

userId

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

Links, changes, or unlinks the current Worker for a workspace user.

object

WorkerId

Target Worker id, or null to unlink.

string

nullable

ExpectedAssociationVersion

Expected current association version.

string

nullable

OperationId

Caller-provided idempotency key.

string

nullable

ChangeReason

Optional audit reason.

string

nullable

Example^generated

{
  "WorkerId": "example",
  "ExpectedAssociationVersion": "example",
  "OperationId": "example",
  "ChangeReason": "example"
}

Links, changes, or unlinks the current Worker for a workspace user.

object

WorkerId

Target Worker id, or null to unlink.

string

nullable

ExpectedAssociationVersion

Expected current association version.

string

nullable

OperationId

Caller-provided idempotency key.

string

nullable

ChangeReason

Optional audit reason.

string

nullable

Example^generated

{
  "WorkerId": "example",
  "ExpectedAssociationVersion": "example",
  "OperationId": "example",
  "ChangeReason": "example"
}

Links, changes, or unlinks the current Worker for a workspace user.

object

WorkerId

Target Worker id, or null to unlink.

string

nullable

ExpectedAssociationVersion

Expected current association version.

string

nullable

OperationId

Caller-provided idempotency key.

string

nullable

ChangeReason

Optional audit reason.

string

nullable

Example^generated

{
  "WorkerId": "example",
  "ExpectedAssociationVersion": "example",
  "OperationId": "example",
  "ChangeReason": "example"
}

Responses

200

application/json

object

Data

Current Work Schedule association projected into a user read model.

object

Worker

Field-safe reference to the Worker associated with a workspace user.

object

EntityDefinitionId

string

nullable

string

nullable

Number

string

nullable

DisplayName

string

nullable

Availability

string

nullable

AssociationVersion

string

nullable

NamesManagedByWorker

boolean

CanRead

boolean

CanManage

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
    }
  ]
}

400

Bad Request

application/json

object

Data

Current Work Schedule association projected into a user read model.

object

Worker

Field-safe reference to the Worker associated with a workspace user.

object

EntityDefinitionId

string

nullable

string

nullable

Number

string

nullable

DisplayName

string

nullable

Availability

string

nullable

AssociationVersion

string

nullable

NamesManagedByWorker

boolean

CanRead

boolean

CanManage

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
    }
  ]
}

403

Forbidden

application/json

object

Data

Current Work Schedule association projected into a user read model.

object

Worker

Field-safe reference to the Worker associated with a workspace user.

object

EntityDefinitionId

string

nullable

string

nullable

Number

string

nullable

DisplayName

string

nullable

Availability

string

nullable

AssociationVersion

string

nullable

NamesManagedByWorker

boolean

CanRead

boolean

CanManage

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
    }
  ]
}

404

Not Found

application/json

object

Data

Current Work Schedule association projected into a user read model.

object

Worker

Field-safe reference to the Worker associated with a workspace user.

object

EntityDefinitionId

string

nullable

string

nullable

Number

string

nullable

DisplayName

string

nullable

Availability

string

nullable

AssociationVersion

string

nullable

NamesManagedByWorker

boolean

CanRead

boolean

CanManage

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
    }
  ]
}

409

Conflict

application/json

object

Data

Current Work Schedule association projected into a user read model.

object

Worker

Field-safe reference to the Worker associated with a workspace user.

object

EntityDefinitionId

string

nullable

string

nullable

Number

string

nullable

DisplayName

string

nullable

Availability

string

nullable

AssociationVersion

string

nullable

NamesManagedByWorker

boolean

CanRead

boolean

CanManage

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
    }
  ]
}

Links, changes, or unlinks the current Worker for a user.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Example

404

Example

409

Example

Example^generated

Example^generated

Example^generated