Get all request lines associated to the project resource request
get
/fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestLines
Request
Path Parameters
-
ResourceRequestId(required): integer(int64)
Identifier of the project resource request.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 all request lines under a request with the matching primary key criteria specified.
Finder Variables:- RequestLineId; integer; Unique identifier of the request line under the project resource request.
- PrimaryKey: Finds all request lines under a request with the matching 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:- AssignedHours; number; Assigned hours per day when the specify hours per day is selected for use project calendar flag.
- AssignmentFinishDate; string; Assignment finish date for the resource.
- AssignmentId; integer; Identifier of the assignment created for the resource, if an assignment is created for the resource on the request line.
- AssignmentStartDate; string; Assignment start date for the resource.
- AssignmentStatus; string; Status of the assignment created for the resource to fulfill the request.
- AssignmentStatusCode; string; Code of the assignment created for the resource to fulfill the request.
- CurrentFlag; boolean; Indicates whether the project resource request is the most recent request for the assignment.
- ProjectRole; string; Resource role for the project assignment.
- RejectionReason; string; Reason the nominated resource is rejected for the project resource assignment.
- RejectionReasonCode; string; Code to indicate the reason the nominated resource is rejected for the project resource assigment.
- RequestLineId; integer; Unique identifier of the request line under the project resource request.
- ReservationExpirationDate; string; Select reservation expiration date for the resource if the assignment status is reserved.
- ReservationReason; string; Select reservation reason for the resource if the assignment status is reserved.
- ResourceEmail; string; Email of the project enterprise resource associated to the project resource request.
- ResourceFulfilledDate; string; The date the resource on the request line is approved to fulfill the project resource request.
- ResourceId; integer; Identifier of the project enterprise resource associated to the project resource request.
- ResourceName; string; Name of the project enterprise resource associated to the project resource request.
- ResourcePersonId; integer; HCM person identifier of the project enterprise resource associated to the project resource request.
- ResourceProposedDate; string; The date when the resource is proposed or nominated to fulfill the project resource request.
- ResourceStatus; string; Status of the resource associated to the project resource request.
- ResourceStatusCode; string; Status code for the resource associated to the project resource request.
- ResourceSystemStatus; string; Resource system status based on the seeded values.
- UseProjectCalendarFlag; boolean; Select whether to use project calendar hours or specific hours per day.
-
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 : projectResourceRequests-ProjectResourceRequestLines
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 : projectResourceRequests-ProjectResourceRequestLines-item-response
Type:
Show Source
object
-
AssignedHours: number
Title:
Assigned Hours
Assigned hours per day when the specify hours per day is selected for use project calendar flag. -
AssignmentFinishDate: string
(date)
Title:
Assignment Finish Date
Assignment finish date for the resource. -
AssignmentId: integer
Title:
Assignment ID
Identifier of the assignment created for the resource, if an assignment is created for the resource on the request line. -
AssignmentStartDate: string
(date)
Title:
Assignment Start Date
Assignment start date for the resource. -
AssignmentStatus: string
Title:
Resource Staffing Status
Maximum Length:80
Status of the assignment created for the resource to fulfill the request. -
AssignmentStatusCode: string
Title:
Assignment Status Code
Maximum Length:30
Code of the assignment created for the resource to fulfill the request. -
CurrentFlag: boolean
Title:
Current Indicator
Read Only:true
Maximum Length:1
Indicates whether the project resource request is the most recent request for the assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectRole: string
Title:
Project Role
Resource role for the project assignment. -
RejectionReason: string
Maximum Length:
80
Reason the nominated resource is rejected for the project resource assignment. -
RejectionReasonCode: string
Title:
Rejection Reason Code
Maximum Length:30
Code to indicate the reason the nominated resource is rejected for the project resource assigment. -
RequestLineId: integer
(int64)
Title:
Request Line ID
Unique identifier of the request line under the project resource request. -
ReservationExpirationDate: string
(date)
Title:
Reservation Expiration Date
Select reservation expiration date for the resource if the assignment status is reserved. -
ReservationReason: string
Title:
Reservation Reason
Select reservation reason for the resource if the assignment status is reserved. -
ResourceEmail: string
Title:
Resource Email
Maximum Length:240
Email of the project enterprise resource associated to the project resource request. -
ResourceFulfilledDate: string
(date)
Title:
Request Fulfilled Date
The date the resource on the request line is approved to fulfill the project resource request. -
ResourceId: integer
(int64)
Title:
Resource ID
Identifier of the project enterprise resource associated to the project resource request. -
ResourceName: string
Title:
Resource Name
Read Only:true
Maximum Length:240
Name of the project enterprise resource associated to the project resource request. -
ResourcePersonId: integer
(int64)
Title:
Resource HCM Person ID
Read Only:true
HCM person identifier of the project enterprise resource associated to the project resource request. -
ResourceProposedDate: string
(date)
Title:
Resource Proposed Date
The date when the resource is proposed or nominated to fulfill the project resource request. -
ResourceStatus: string
Title:
Resource Staffing Status
Maximum Length:80
Status of the resource associated to the project resource request. -
ResourceStatusCode: string
Title:
Resource Status Code
Maximum Length:20
Default Value:NEW_LINE
Status code for the resource associated to the project resource request. -
ResourceSystemStatus: string
Title:
Resource System Status
Read Only:true
Resource system status based on the seeded values. -
UseProjectCalendarFlag: boolean
Title:
Use Project Calendar Indicator
Maximum Length:255
Select whether to use project calendar hours or specific hours per day.
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 request lines associated to the project resource request 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/projectResourceRequests/300100082399056/child/ProjectResourceRequestLines
Response Body Example
The following shows an example of the response body in JSON format.
{ "RequestLineId": 300100169517432, "ResourceId": 300100023180874, "ResourceName": "Ruby Williams", "ResourceEmail": "Ruby.Williams@Oracle.com", "ResourcePersonId": 300100007736610, "ResourceStatusCode": "REQUESTED", "ResourceStatus": "Requested", "AssignmentId": null, "AssignmentStatusCode": null, "AssignmentStatus": null, "ResourceProposedDate": null, "ResourceFulfilledDate": null }