Get a holiday calendar
get
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}
Request
Path Parameters
-
publicSectorHolidayCalendarsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and CalendarId ---for the Holiday Calendars resource and used to uniquely identify an instance of Holiday Calendars. The client should not generate the hash key value. Instead, the client should query on the Holiday Calendars collection resource with a filter on the primary key values in order to navigate to a specific instance of Holiday Calendars.
For example: publicSectorHolidayCalendars?q=AgencyId=<value1>;CalendarId=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorHolidayCalendars-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this holiday calendar applies.
-
CalendarId(optional):
string
Title:
Calendar ID
Maximum Length:30
The unique identifier for the holiday calendar. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the holiday calendar. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the holiday calendar was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the holiday calendar. -
HolidayCalendarDetail(optional):
array Holiday Calendar Events
Title:
Holiday Calendar Events
The holiday calendars resource is used to view, create, or modify a holiday calendar. A holiday calendar is used to establish the days that agency offices are closed and no field service operations are offered. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the holiday calendar was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the holiday calendar. -
links(optional):
array Items
Title:
Items
Link Relations -
ValidFromDate(optional):
string(date-time)
Title:
Valid from Date
The start date on which the holiday calendar becomes effective. -
ValidToDate(optional):
string(date-time)
Title:
Valid to Date
The end date after which the holiday calendar is no longer effective.
Nested Schema : Holiday Calendar Events
Type:
array
Title:
Holiday Calendar Events
The holiday calendars resource is used to view, create, or modify a holiday calendar. A holiday calendar is used to establish the days that agency offices are closed and no field service operations are offered.
Show Source
Nested Schema : publicSectorHolidayCalendars-HolidayCalendarDetail-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this holiday calendar applies.
-
CalendarId(optional):
string
Title:
Calendar ID
Maximum Length:30
The unique identifier for the holiday calendar. -
Comments(optional):
string
Title:
Description
Maximum Length:100
The description of the holiday calendar event. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the holiday calendar event. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the holiday calendar event was created. -
EventDate(optional):
string(date)
Title:
Event Date
The date of the holiday calendar event. -
EventId(optional):
string
Title:
Event ID
Maximum Length:30
The unique identifier for the holiday calendar event. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the holiday calendar event was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the holiday calendar event. -
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.