Returns one complete immutable published or cancelled revision.

GET

/api/workspace/work-schedule/calendars/{calendarId}/revisions/{revisionId}

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

Authorizations

WorkspaceBearer

Parameters

Path Parameters

calendarId

required

string

revisionId

required

string

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

Complete immutable published revision.

object

CalendarId

string

nullable

RevisionId

string

nullable

RevisionNumber

integer format: int32

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

User identifier.

string

nullable

Name

Resolved user display name.

string

nullable

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

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