Get all the organizational calendars for the specified range
get
/hcmRestApi/resources/11.13.18.05/absenceCalendars
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the organizational calendar with the specified unique identifier.
Finder Variables- CalendarId; integer; Unique identifier for an organizational calendar.
- PrimaryKey Finds the organizational calendar with the specified unique identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CalendarId; integer; Unique identifier for the organizational calendar.
- CreatedBy; string; Person who created the organizational calendar event.
- CreationDate; string; Date when the organizational calendar event was created.
- Description; string; Description for the organizational calendar.
- EndDate; string; End date for the organizational calendar.
- LastUpdateDate; string; Date when the organizational calendar was most recently updated.
- LastUpdatedBy; string; Person who updated the organizational calendar.
- Name; string; Name of the organizational calendar.
- StartDate; string; Start date for the organizational calendar.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : absenceCalendars-item-response
Type:
Show Source
object-
AbsenceCalendarEvent: array
Organizational Calendar Events
Title:
Organizational Calendar EventsThe 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 SubscriberThe 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:
trueMaximum Length:64Person who created the organizational calendar event. -
CreationDate: string
(date-time)
Read Only:
trueDate when the organizational calendar event was created. -
Description: string
Maximum Length:
2000Description for the organizational calendar. -
EndDate: string
(date)
End date for the organizational calendar.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the organizational calendar was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Person who updated the organizational calendar. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Maximum Length:
240Name of the organizational calendar. -
StartDate: string
(date)
Start date for the organizational calendar.
Nested Schema : Organizational Calendar Events
Type:
arrayTitle:
Organizational Calendar EventsThe 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:
arrayTitle:
Organizational Calendar SubscriberThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : absenceCalendars-AbsenceCalendarEvent-item-response
Type:
Show Source
object-
AllDayFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseIndicates 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:
trueMaximum Length:255Organizational calendar event category. -
CategoryCode: string
Title:
CategoryRead Only:trueMaximum Length:30Code for the organizational calendar event category. -
CreatedBy: string
Read Only:
trueMaximum Length:64Person who created the organizational calendar event. -
CreationDate: string
(date-time)
Read Only:
trueDate when the organizational calendar event was created. -
Description: string
Title:
DescriptionRead Only:trueMaximum Length:240Description for the organizational calendar event. -
EndDateTime: string
(date-time)
Title:
End DateRead Only:trueEnd date and time for the organizational calendar event. -
EventCategoryCode: string
Maximum Length:
64Event category code for the organizational calendar event. -
EventType: string
Maximum Length:
64Event type for the organizational calendar event. -
HalfDayForElapsed: string
Title:
Half day for elapsed work schedulesRead Only:trueMaximum Length:1Default Value:NOrganizational calendar event option to enable half day for elapsed schedules. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the organizational calendar event was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Person who updated the organizational calendar event. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
NameRead Only:trueMaximum Length:80Name of the organizational calendar event. -
ShortCode: string
Title:
Short CodeRead Only:trueMaximum Length:48Short code for the organizational calendar event. -
StartDateTime: string
(date-time)
Title:
Start DateRead Only:trueStart date and time for the organizational calendar event.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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:
trueMaximum Length:255Indicates 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:
trueMaximum Length:64Person who created the organizational calendar rule. -
CreationDate: string
(date-time)
Read Only:
trueDate when the organizational calendar rule was created. -
Description: string
Read Only:
trueMaximum Length:255Description for the organization calendar rule. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the organizational calendar rule was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Person who updated the organizational calendar rule. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ListId: integer
List of the rules assigned to an organizational calendar.
-
Name: string
Read Only:
trueMaximum Length:255Name of the organizational calendar rule.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- findByAdvancedSearch
-
Finds the organizational calendars that matches the specified criteria, such as name or description.