Creates or additively repairs one Work Schedule operational system Entity Definition.

POST

/api/workspace/admin/work-schedule/catalogs/{catalogKey}/reconcile

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/work-schedule/catalogs/example/reconcile"),
    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/admin/work-schedule/catalogs/example/reconcile';
const options = {method: 'POST', 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 POST \
  --url https://example.com/api/workspace/admin/work-schedule/catalogs/example/reconcile \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

catalogKey

required

string

Allowlisted catalog key: OperationalLocation, Site, or Worker.

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

Work Schedule module administration detail.

object

Summary

Work Schedule lifecycle summary.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

ConfigurationState

integer format: int32

Allowed values: 0 1 2 3 4 5

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

RowVersion

string format: uuid

nullable

AllowedActions

Allowed lifecycle actions for the current module state.

object

CanEnable

boolean

CanReconcileSecurity

boolean

CanDisable

boolean

Readiness

Capability-specific Work Schedule readiness.

object

IsOperationallyHealthy

boolean

IsFullyReady

boolean

Capabilities

Array<object>

nullable

Availability of one Work Schedule capability.

object

Key

string

nullable

IsAvailable

boolean

BlockerKeys

Array<string>

nullable

Prerequisites

Array<object>

nullable

State of one operational catalog or calendar prerequisite.

object

Key

string

nullable

State

string

nullable

EntityDefinitionId

string

nullable

SuggestedAction

string

nullable

Diagnostics

Array<object>

nullable

One machine-readable setup or drift diagnostic.

object

Code

string

nullable

FieldKey

string

nullable

Surface

string

nullable

OpenTarget

Safe named-route navigation target.

object

RouteName

string

nullable

Params

object

key

additional properties

string

Query

object

key

additional properties

string

AccessTarget

Safe named-route navigation target.

object

RouteName

string

nullable

Params

object

key

additional properties

string

Query

object

key

additional properties

string

HealthIssues

Array<object>

nullable

Operational Work Schedule health issue.

object

Code

string

nullable

Message

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

400

Bad Request

application/json

object

Data

Work Schedule module administration detail.

object

Summary

Work Schedule lifecycle summary.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

ConfigurationState

integer format: int32

Allowed values: 0 1 2 3 4 5

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

RowVersion

string format: uuid

nullable

AllowedActions

Allowed lifecycle actions for the current module state.

object

CanEnable

boolean

CanReconcileSecurity

boolean

CanDisable

boolean

Readiness

Capability-specific Work Schedule readiness.

object

IsOperationallyHealthy

boolean

IsFullyReady

boolean

Capabilities

Array<object>

nullable

Availability of one Work Schedule capability.

object

Key

string

nullable

IsAvailable

boolean

BlockerKeys

Array<string>

nullable

Prerequisites

Array<object>

nullable

State of one operational catalog or calendar prerequisite.

object

Key

string

nullable

State

string

nullable

EntityDefinitionId

string

nullable

SuggestedAction

string

nullable

Diagnostics

Array<object>

nullable

One machine-readable setup or drift diagnostic.

object

Code

string

nullable

FieldKey

string

nullable

Surface

string

nullable

OpenTarget

Safe named-route navigation target.

object

RouteName

string

nullable

Params

object

key

additional properties

string

Query

object

key

additional properties

string

AccessTarget

Safe named-route navigation target.

object

RouteName

string

nullable

Params

object

key

additional properties

string

Query

object

key

additional properties

string

HealthIssues

Array<object>

nullable

Operational Work Schedule health issue.

object

Code

string

nullable

Message

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

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

application/json

object

Data

Work Schedule module administration detail.

object

Summary

Work Schedule lifecycle summary.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

ConfigurationState

integer format: int32

Allowed values: 0 1 2 3 4 5

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

RowVersion

string format: uuid

nullable

AllowedActions

Allowed lifecycle actions for the current module state.

object

CanEnable

boolean

CanReconcileSecurity

boolean

CanDisable

boolean

Readiness

Capability-specific Work Schedule readiness.

object

IsOperationallyHealthy

boolean

IsFullyReady

boolean

Capabilities

Array<object>

nullable

Availability of one Work Schedule capability.

object

Key

string

nullable

IsAvailable

boolean

BlockerKeys

Array<string>

nullable

Prerequisites

Array<object>

nullable

State of one operational catalog or calendar prerequisite.

object

Key

string

nullable

State

string

nullable

EntityDefinitionId

string

nullable

SuggestedAction

string

nullable

Diagnostics

Array<object>

nullable

One machine-readable setup or drift diagnostic.

object

Code

string

nullable

FieldKey

string

nullable

Surface

string

nullable

OpenTarget

Safe named-route navigation target.

object

RouteName

string

nullable

Params

object

key

additional properties

string

Query

object

key

additional properties

string

AccessTarget

Safe named-route navigation target.

object

RouteName

string

nullable

Params

object

key

additional properties

string

Query

object

key

additional properties

string

HealthIssues

Array<object>

nullable

Operational Work Schedule health issue.

object

Code

string

nullable

Message

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

Creates or additively repairs one Work Schedule operational system Entity Definition.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example

403

Examplegenerated

409

Example

Example^generated