Skip to content
MoltaroMoltaroMoltaro Docs

Cancels a future published revision before its effective date.

POST
/api/workspace/work-schedule/calendars/{calendarId}/revisions/{revisionId}/cancel
curl --request POST \
  --url https://example.com/api/workspace/work-schedule/calendars/example/revisions/example/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "OperationId": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
calendarId
required
string
revisionId
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”

Cancels a future published revision before its effective date.

object
ExpectedRowVersion
string format: uuid
OperationId
string
nullable
Examplegenerated
{
  "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "OperationId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Calendar mutation result with refreshed server detail.

object
Calendar

Calendar detail, editable draft, revision timeline, and current actor actions.

object
CalendarId
string
nullable
Key
string
nullable
Name
string
nullable
Description
string
nullable
Enabled
boolean
CreatedAtUtc
string format: date-time
CreatedByUserId
string
nullable
AsOfLocalDate
string format: date
RowVersion
string format: uuid
Draft

Editable draft revision.

object
RevisionId
string
nullable
RevisionNumber
integer format: int32
Pattern

Complete weekly pattern.

object
PatternType
string
nullable
EffectiveFromLocalDate
string format: date
Intervals
Array<object>
nullable

One weekly wall-clock interval. Overnight work remains one interval.

object
StartDayOfWeek
integer format: int32
Allowed values: 0 1 2 3 4 5 6
StartMicroseconds
integer format: int64
DurationMicroseconds
integer format: int64
Breaks
Array<object>
nullable

One break relative to the beginning of an interval.

object
OffsetMicroseconds
integer format: int64
DurationMicroseconds
integer format: int64
Name
string
nullable
Label
string
nullable
Notes
string
nullable
Actions

Actions that belong only to the visible Draft revision.

object
CanContinueEditing
boolean
CanDiscard
boolean
CanPublish
boolean
PublishedRevisions
Array<object>
nullable

Published revision metadata and compact seven-day aggregates.

object
RevisionId
string
nullable
RevisionNumber
integer format: int32
EffectiveFromLocalDate
string format: date
PublishedAtUtc
string format: date-time
PublishedByUserId
string
nullable
PresentationState
string
nullable
CancelledAtUtc
string format: date-time
nullable
CancelledByActor

Compact read model for user references inside runtime instance payloads.

object
Id

User identifier.

string
nullable
Name

Resolved user display name.

string
nullable
DaySummaries
Array<object>
nullable

Compact aggregate for one start day of a published revision.

object
DayOfWeek
integer format: int32
NetDurationMicroseconds
integer format: int64
IntervalCount
integer format: int32
Actions

Actions that belong only to the visible immutable revision.

object
CanCreateDraft
boolean
CreateDraftBlockerCode
string
nullable
CanCancel
boolean
Actions

Actions that the current actor may perform on a working calendar.

object
CanRead
boolean
CanUpdate
boolean
CanSetEnabled
boolean
CanDelete
boolean
CanStartDraft
boolean
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
{
  "Data": {
    "Calendar": {
      "Draft": {
        "Pattern": {
          "Intervals": [
            {
              "StartDayOfWeek": 0
            }
          ]
        }
      }
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}