Get all resource calendar events
get
/fscmRestApi/resources/11.13.18.05/resourceEvents
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 resource event that matches the primary key criteria specified.
Finder Variables:- ResourceEventId; integer; Identifier of the resource event.
- findByProjectId: Finds the resource events for all the resources for a specified project.
Finder Variables:- BindProjectId; integer; Identifier of the project.
- PrimaryKey: Finds the resource event that matches the primary key 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:- AllDayFlag; boolean; Indicates whether the event is an All Day event.
- CreatedBy; string; Indicates the resource who created the row of data.
- CreationDate; string; Date when the row of data was created.
- DurationHours; number; Length of the calendar event in hours.
- EndDate; string; Finish date of the calendar event.
- EventCategory; string; Category of the resource calendar event. Possible values for resources are PTO, training, or others.
- EventCategoryCode; string; Code that indicates the category of the resource calendar event.
- EventDescription; string; Description of the calendar event.
- EventName; string; Name of the calendar event.
- LastUpdateDate; string; Date when the record was last edited.
- LastUpdatedBy; string; Indicates who last edited the record.
- ResourceCalendarName; string; Name of the calendar that defines the work schedule for the resource.
- ResourceEmail; string; Email of the resource for whom the event is created.
- ResourceEventId; integer; Identifier of the resource event.
- ResourceId; integer; Identifier of the resource for which the event is created.
- ResourceName; string; Name of the resource for whom the event is created.
- StartDate; string; Start date of the calendar event.
-
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(required):
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(required):
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 : resourceEvents
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 : resourceEvents-item-response
Type:
Show Source
object
-
AllDayFlag: boolean
Title:
All Day
Maximum Length:1
Indicates whether the event is an All Day event. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Indicates the resource who created the row of data. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the row of data was created. -
DurationHours: number
Title:
Calendar Event Duration
Length of the calendar event in hours. -
EndDate: string
(date)
Title:
End Date
Finish date of the calendar event. -
EventCategory: string
Title:
Event Category
Maximum Length:80
Category of the resource calendar event. Possible values for resources are PTO, training, or others. -
EventCategoryCode: string
Title:
Event Category Code
Maximum Length:30
Code that indicates the category of the resource calendar event. -
EventDescription: string
Title:
Calendar Event Description
Maximum Length:2000
Description of the calendar event. -
EventName: string
Title:
Event Name
Maximum Length:240
Name of the calendar event. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last edited. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates who last edited the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceCalendarName: string
Title:
Calendar
Read Only:true
Maximum Length:240
Name of the calendar that defines the work schedule for the resource. -
ResourceEmail: string
Title:
Email
Maximum Length:240
Email of the resource for whom the event is created. -
ResourceEventId: integer
(int64)
Title:
Resource Event ID
Identifier of the resource event. -
ResourceId: integer
(int64)
Title:
Labor Resource ID
Identifier of the resource for which the event is created. -
ResourceName: string
Title:
Labor Resource Name
Maximum Length:240
Name of the resource for whom the event is created. -
StartDate: string
(date)
Title:
Start Date
Start date of the 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.
Examples
The following example shows how to get all resource calendar events by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/resourceEvents
Response Body Example
The following shows an example of the response body in JSON format.
"items": [ { "EventDescription": "Vacation from 7/1/13-7/4/13", "EventName": "Vacation", "ResourceEventId": 300100036897811, "CreatedBy": "Mark.Otbi", "CreationDate": "2014-07-29T12:12:41.001+00:00", "LastUpdateDate": "2014-07-29T12:13:56.616+00:00", "LastUpdatedBy": "Mark.Otbi", "ResourceId": 300100031832253, "StartDate": "2013-07-01", "EndDate": "2013-07-04", "ResourceName": "Mark Otbi", "ResourceCalendarName": "PJT Standard US Calendar", "EventCategory": "PTO", "DurationHours": null, "ResourceEmail": "prj_mark_otbi_grp@oracle.com", "EventCategoryCode": "PTO", "AllDayFlag": true, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/resourceEvents/300100036897811", "name": "resourceEvents", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/resourceEvents/300100036897811", "name": "resourceEvents", "kind": "item" } ] }, ... }