Appends terminal cancellation evidence.

POST

/api/workspace/work-schedule/exceptions/{exceptionId}/cancel

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/work-schedule/exceptions/example/cancel"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"ExpectedChainVersion\": \"example\", \"ReasonText\": \"example\", \"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/work-schedule/exceptions/example/cancel';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"ExpectedChainVersion":"example","ReasonText":"example","OperationId":"example"}'
};

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/work-schedule/exceptions/example/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ExpectedChainVersion": "example", "ReasonText": "example", "OperationId": "example" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

exceptionId

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

Appends terminal cancellation evidence.

object

ExpectedChainVersion

string

nullable

ReasonText

string

nullable

OperationId

string

nullable

Example^generated

{
  "ExpectedChainVersion": "example",
  "ReasonText": "example",
  "OperationId": "example"
}

Appends terminal cancellation evidence.

object

ExpectedChainVersion

string

nullable

ReasonText

string

nullable

OperationId

string

nullable

Example^generated

{
  "ExpectedChainVersion": "example",
  "ReasonText": "example",
  "OperationId": "example"
}

Appends terminal cancellation evidence.

object

ExpectedChainVersion

string

nullable

ReasonText

string

nullable

OperationId

string

nullable

Example^generated

{
  "ExpectedChainVersion": "example",
  "ReasonText": "example",
  "OperationId": "example"
}

Responses

200

application/json

object

Data

Mutation result with the refreshed append-only chain.

object

Chain

Complete append-only history and current effective evidence.

object

ChainRootId

string

nullable

ActiveEntry

One immutable schedule-exception evidence entry.

object

ExceptionId

string

nullable

ChainRootId

string

nullable

Sequence

integer format: int64

OperationKind

string

nullable

Kind

string

nullable

ScopeType

string

nullable

ScopeId

string

nullable

WorkerId

string

nullable

SiteId

string

nullable

DestinationSiteId

string

nullable

WorkingCalendarId

string

nullable

IsWholeDay

boolean

StartLocalDate

string format: date

EndLocalDateExclusive

string format: date

Intervals

Array<object>

nullable

One exact local interval with frozen boundary provenance where applicable.

object

StartLocalDate

string format: date

StartLocalTime

string format: time

EndLocalDate

string format: date

EndLocalTime

string format: time

BoundaryIanaTimeZoneId

string

nullable

ResolvedStartUtc

string format: date-time

nullable

ResolvedEndUtc

string format: date-time

nullable

ReasonCode

string

nullable

ReasonText

string

nullable

AuthorityTier

string

nullable

BoundaryIanaTimeZoneId

string

nullable

ResolvedStartUtc

string format: date-time

nullable

ResolvedEndUtcExclusive

string format: date-time

nullable

RecordedAtUtc

string format: date-time

RecordedByUserId

string

nullable

RecordedByActor

Compact read model for user references inside runtime instance payloads.

object

User identifier.

string

nullable

Name

Resolved user display name.

string

nullable

SupersedesOverrideId

string

nullable

Diagnostics

Array<object>

nullable

One structured daylight-saving boundary diagnostic.

object

Code

string

nullable

Field

string

nullable

IntervalOrdinal

integer format: int32

nullable

History

Array<object>

nullable

One immutable schedule-exception evidence entry.

object

ExceptionId

string

nullable

ChainRootId

string

nullable

Sequence

integer format: int64

OperationKind

string

nullable

Kind

string

nullable

ScopeType

string

nullable

ScopeId

string

nullable

WorkerId

string

nullable

SiteId

string

nullable

DestinationSiteId

string

nullable

WorkingCalendarId

string

nullable

IsWholeDay

boolean

StartLocalDate

string format: date

EndLocalDateExclusive

string format: date

Intervals

Array<object>

nullable

One exact local interval with frozen boundary provenance where applicable.

object

StartLocalDate

string format: date

StartLocalTime

string format: time

EndLocalDate

string format: date

EndLocalTime

string format: time

BoundaryIanaTimeZoneId

string

nullable

ResolvedStartUtc

string format: date-time

nullable

ResolvedEndUtc

string format: date-time

nullable

ReasonCode

string

nullable

ReasonText

string

nullable

AuthorityTier

string

nullable

BoundaryIanaTimeZoneId

string

nullable

ResolvedStartUtc

string format: date-time

nullable

ResolvedEndUtcExclusive

string format: date-time

nullable

RecordedAtUtc

string format: date-time

RecordedByUserId

string

nullable

RecordedByActor

Compact read model for user references inside runtime instance payloads.

object

User identifier.

string

nullable

Name

Resolved user display name.

string

nullable

SupersedesOverrideId

string

nullable

Diagnostics

Array<object>

nullable

One structured daylight-saving boundary diagnostic.

object

Code

string

nullable

Field

string

nullable

IntervalOrdinal

integer format: int32

nullable

ChainVersion

string

nullable

Cancelled

boolean

Actions

Server-computed actions for an exception chain.

object

CanCorrect

boolean

CanCancel

boolean

ExceptionId

string

nullable

ChainVersion

string

nullable

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

Appends terminal cancellation evidence.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

Example^generated

Example^generated

Example^generated