Get all calendars
get
/fscmRestApi/resources/11.13.18.05/hedCalendars
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- ByKeywordFinder Finds the calendar that matches the keyword criteria specified.
Finder Variables- Keyword; string; The keyword of the calendar.
- PrimaryKey Finds the calendar that matches the primary key criteria specified.
Finder Variables- CalendarId; integer; The unique identifier of the calendar.
- ByKeywordFinder Finds the calendar that matches the keyword criteria specified.
-
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:- ActiveFlag; boolean; Indicates whether the calendar is active. The default value is N.
- CalendarCode; string; The code of a calendar.
- CalendarCodeLockFlag; boolean; Indicates whether calendar code is editable.
- CalendarEndDate; string; The date when a calendar ends.
- CalendarId; integer; The unique identifier of a calendar.
- CalendarName; string; The name of a calendar.
- CalendarStartDate; string; The date when a calendar starts.
- LastUpdateDate; string; The date and time when the calendar was last updated.
- TimezoneCode; string; Time zone code selected by a user when specifying calendar start and end dates.
- TimezoneName; string; Time zone name selected by a user when specifying a date time.
-
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:
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.
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 : hedCalendars
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:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedCalendars-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the calendar is active. The default value is N. -
CalendarCode: string
Title:
Calendar Code
Maximum Length:32
The code of a calendar. -
CalendarCodeLockFlag: boolean
Title:
Calendar Code Lock Indicator
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether calendar code is editable. -
CalendarEndDate: string
(date)
Title:
End Date
The date when a calendar ends. -
CalendarId: integer
(int64)
Title:
Calendar ID
Read Only:true
The unique identifier of a calendar. -
CalendarName: string
Title:
Calendar Name
Maximum Length:240
The name of a calendar. -
CalendarStartDate: string
(date)
Title:
Start Date
The date when a calendar starts. -
Description: string
Title:
Description
Maximum Length:1000
The description of a calendar. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the calendar was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
tagAssignments: array
Calendar Tags
Title:
Calendar Tags
Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar. -
TimezoneCode: string
Title:
Time Zone Code
Read Only:true
Maximum Length:50
Default Value:UTC
Time zone code selected by a user when specifying calendar start and end dates. -
TimezoneName: string
Title:
Time Zone Name
Read Only:true
Maximum Length:80
Time zone name selected by a user when specifying a date time.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Calendar Tags
Type:
array
Title:
Calendar Tags
Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.
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 : hedCalendars-tagAssignments-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TagAssignmentId: integer
(int64)
Title:
Tag Assignment ID
Read Only:true
The identifier of the tag assignment. -
TagCode: string
Title:
Tag Code
Maximum Length:30
The code of the tag. -
TagId: integer
(int64)
Title:
Tag ID
The identifier of the tag. -
TagName: string
Title:
Tag Name
Read Only:true
Maximum Length:64
The name of the tag.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source