Create an organizational calendar
post
/hcmRestApi/resources/11.13.18.05/absenceCalendars
Request
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AbsenceCalendarEvent: array
Organizational Calendar Events
Title:
Organizational Calendar Events
The AbsenceCalendarEvent resource provides information about organizational calendar events and lets administrators view and manage the events added to a calendar. -
AbsenceCalendarSubscriber: array
Organizational Calendar Subscriber
Title:
Organizational Calendar Subscriber
The AbsenceCalendarSubscriber resource provides information about the rules added to organizational calendars and lets administrators view and manage the subscribers for a given calendar. -
CalendarId: integer
(int64)
Unique identifier for the organizational calendar.
-
Description: string
Maximum Length:
2000
Description for the organizational calendar. -
EndDate: string
(date)
End date for the organizational calendar.
-
Name(required): string
Maximum Length:
240
Name of the organizational calendar. -
StartDate(required): string
(date)
Start date for the organizational calendar.
Nested Schema : Organizational Calendar Events
Type:
array
Title:
Organizational Calendar Events
The AbsenceCalendarEvent resource provides information about organizational calendar events and lets administrators view and manage the events added to a calendar.
Show Source
Nested Schema : Organizational Calendar Subscriber
Type:
array
Title:
Organizational Calendar Subscriber
The AbsenceCalendarSubscriber resource provides information about the rules added to organizational calendars and lets administrators view and manage the subscribers for a given calendar.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CalendarCalEventId: integer
(int64)
Unique identifier for an organizational calendar's event.
-
CalendarEventId: integer
(int64)
Unique identifier for the organizational calendar event.
-
CalendarId: integer
(int64)
Unique identifier for the organizational calendar event.
-
EventCategoryCode: string
Maximum Length:
64
Event category code for the organizational calendar event. -
EventType: string
Maximum Length:
64
Event type for the organizational calendar event.
Nested Schema : schema
Type:
Show Source
object
-
CalendarId: integer
(int64)
Unique identifier for the organizational calendar.
-
CalendarSubscriberId: integer
(int64)
Unique identifier for the organizational calendar rule.
-
ListId: integer
List of the rules assigned to an organizational calendar.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : absenceCalendars-item-response
Type:
Show Source
object
-
AbsenceCalendarEvent: array
Organizational Calendar Events
Title:
Organizational Calendar Events
The AbsenceCalendarEvent resource provides information about organizational calendar events and lets administrators view and manage the events added to a calendar. -
AbsenceCalendarSubscriber: array
Organizational Calendar Subscriber
Title:
Organizational Calendar Subscriber
The AbsenceCalendarSubscriber resource provides information about the rules added to organizational calendars and lets administrators view and manage the subscribers for a given calendar. -
CalendarId: integer
(int64)
Unique identifier for the organizational calendar.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who created the organizational calendar event. -
CreationDate: string
(date-time)
Read Only:
true
Date when the organizational calendar event was created. -
Description: string
Maximum Length:
2000
Description for the organizational calendar. -
EndDate: string
(date)
End date for the organizational calendar.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the organizational calendar was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who updated the organizational calendar. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
240
Name of the organizational calendar. -
StartDate: string
(date)
Start date for the organizational calendar.
Nested Schema : Organizational Calendar Events
Type:
array
Title:
Organizational Calendar Events
The AbsenceCalendarEvent resource provides information about organizational calendar events and lets administrators view and manage the events added to a calendar.
Show Source
Nested Schema : Organizational Calendar Subscriber
Type:
array
Title:
Organizational Calendar Subscriber
The AbsenceCalendarSubscriber resource provides information about the rules added to organizational calendars and lets administrators view and manage the subscribers for a given calendar.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : absenceCalendars-AbsenceCalendarEvent-item-response
Type:
Show Source
object
-
AllDayFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Indicates whether an organizational calendar event is for a full day. -
CalendarCalEventId: integer
(int64)
Unique identifier for an organizational calendar's event.
-
CalendarEventId: integer
(int64)
Unique identifier for the organizational calendar event.
-
CalendarId: integer
(int64)
Unique identifier for the organizational calendar event.
-
Category: string
Read Only:
true
Maximum Length:255
Organizational calendar event category. -
CategoryCode: string
Title:
Category
Read Only:true
Maximum Length:30
Code for the organizational calendar event category. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who created the organizational calendar event. -
CreationDate: string
(date-time)
Read Only:
true
Date when the organizational calendar event was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description for the organizational calendar event. -
EndDateTime: string
(date-time)
Title:
End Date
Read Only:true
End date and time for the organizational calendar event. -
EventCategoryCode: string
Maximum Length:
64
Event category code for the organizational calendar event. -
EventType: string
Maximum Length:
64
Event type for the organizational calendar event. -
HalfDayForElapsed: string
Title:
Half day for elapsed work schedules
Read Only:true
Maximum Length:1
Default Value:N
Organizational calendar event option to enable half day for elapsed schedules. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the organizational calendar event was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who updated the organizational calendar event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the organizational calendar event. -
ShortCode: string
Title:
Short Code
Read Only:true
Maximum Length:48
Short code for the organizational calendar event. -
StartDateTime: string
(date-time)
Title:
Start Date
Read Only:true
Start date and time for the organizational calendar event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : absenceCalendars-AbsenceCalendarSubscriber-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether a rule assigned to an organizational calendar is active. -
CalendarId: integer
(int64)
Unique identifier for the organizational calendar.
-
CalendarSubscriberId: integer
(int64)
Unique identifier for the organizational calendar rule.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who created the organizational calendar rule. -
CreationDate: string
(date-time)
Read Only:
true
Date when the organizational calendar rule was created. -
Description: string
Read Only:
true
Maximum Length:255
Description for the organization calendar rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the organizational calendar rule was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who updated the organizational calendar rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListId: integer
List of the rules assigned to an organizational calendar.
-
Name: string
Read Only:
true
Maximum Length:255
Name of the organizational calendar rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AbsenceCalendarEvent
-
Operation: /hcmRestApi/resources/11.13.18.05/absenceCalendars/{CalendarId}/child/AbsenceCalendarEventParameters:
- CalendarId:
$request.path.CalendarId
The AbsenceCalendarEvent resource provides information about organizational calendar events and lets administrators view and manage the events added to a calendar. - CalendarId:
- AbsenceCalendarSubscriber
-
Operation: /hcmRestApi/resources/11.13.18.05/absenceCalendars/{CalendarId}/child/AbsenceCalendarSubscriberParameters:
- CalendarId:
$request.path.CalendarId
The AbsenceCalendarSubscriber resource provides information about the rules added to organizational calendars and lets administrators view and manage the subscribers for a given calendar. - CalendarId: