Get all project labor resources
get
/fscmRestApi/resources/11.13.18.05/projectLaborResources
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 that matches the specified primary key.
Finder Variables:- ProjResourceId; integer; Unique identifier of the project resource.
- findByProjResourceId: Finds the resource with the specified project resource ID.
Finder Variables:- ProjResourceId; integer; Unique identifier of the project resource.
- PrimaryKey: Finds the resource that matches the specified primary key.
-
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:- Allocation; number; The percentage of hours a resource is allocated to the project for a specified duration.
- AssignmentStatusCode; string; Code for the status of the assignment.
- AssignmentType; string; Indicates whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank.
- AssignmentTypeCode; string; Code to indicate whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank.
- BillablePercent; integer; Indicates the percentage of assignment time that is billable for an assignment that is defined as Billable assignment. For a nonbillable assignment, the value is ignored. Valid values are positive integers between 0 and 100.
- BillablePercentReason; string; Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
- BillablePercentReasonCode; string; Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
- CalendarId; integer; Identifier of the calendar that establishes the normal working days, hours per day, and exceptions for a project enterprise resource.
- CreatedBy; string; Indicates the resource who created the row of data.
- CreationDate; string; Date when the row of data was created.
- DailyHours; number; Working hours of a resource for each working day during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is N.
- DefaultStaffingOwnerFlag; boolean; Indicates whether all project resource requests will be assigned to the staffing owner by default.
- Email; string; Email address of the resource.
- FridayHours; number; Working hours of a resource for every Friday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
- FromDate; string; The date when the resource assignment is to start on the project.
- LaborBillRate; number; The amount paid to a business by its customer for a unit of work completed by the project enterprise resource.
- LaborCostRate; number; The cost of a unit of work by the project enterprise resource.
- LaborEffort; number; The number of hours that a resource is assigned or allocated to work on a project.
- LastUpdateDate; string; Date when the record was last edited.
- LastUpdatedBy; string; Indicates who last edited the record.
- MondayHours; number; Working hours of a resource for every Monday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
- Name; string; Display name of the resource.
- ProjResourceId; integer; Unique identifier of the project resource.
- ProjectCurrencyCode; string; The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency.
- ProjectId; integer; Unique identifier of the project associated to the resource assignment. To identify the project, provide a value for this attribute, or any one of the Project Number attribute or the Project Name attribute. Project is mandatory when creating an assignment.
- ProjectName; string; Name of the project.
- ProjectNumber; string; Alphanumeric identifier of the project.
- ProjectResourceAssignmentId; integer; Unique identifier of the project resource assignment.
- ProjectRoleId; integer; Identifier of the role that the selected resource is assigned to on a project assignment. To identify the project role, provide a value either for this attribute or the Project Role Name attribute but not both. Project Role value is mandatory when creating an assignment.
- ProjectRoleName; string; Name of the role that the selected resource is assigned to on a project resource assignment. To identify the project role, provide a value either for this attribute or for the Project Role ID attribute but not both.
- Reason; string; Reason for requesting modification of the resource assignment.
- ResourceId; integer; Unique identifier of the project enterprise resource.
- SaturdayHours; number; Working hours of a resource for every Saturday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
- ScheduleHoursType; string; Indicates whether working hours are assigned to resources based on the project calendar, per week, per day, or the day of the week. Valid values are Y, N, X, and W. If the value is Y, hours are assigned based on the project calendar. If the value is N, hours are assigned per day. If the value is X, hours are assigned based on the day of the week and can vary across days. If the value is set to W, hours are assigned per week. The default value is Y.
- SundayHours; number; Working hours of a resource for every Sunday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
- ThursdayHours; number; Working hours of a resource for every Thursday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
- ToDate; string; The date when the resource assignment is to end on the project.
- TuesdayHours; number; Working hours of a resource for every Tuesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
- WednesdayHours; number; Working hours of a resource for every Wednesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
- WeeklyHours; number; Working hours of a resource for each week during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is W.
-
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 : projectLaborResources
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 : projectLaborResources-item-response
Type:
Show Source
object
-
Allocation: number
Title:
Allocation Percentage
Default Value:100
The percentage of hours a resource is allocated to the project for a specified duration. -
AssignmentStatus: string
Status of the resource assignment on the project, such as Assigned, Planning, and Canceled.
-
AssignmentStatusCode: string
Maximum Length:
30
Default Value:PLANNING_ONLY
Code for the status of the assignment. -
AssignmentType: string
Title:
Assignment Type
Indicates whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank. -
AssignmentTypeCode: string
Title:
Assignment Type Code
Maximum Length:30
Code to indicate whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank. -
BillablePercent: integer
Title:
Billable Percent
Indicates the percentage of assignment time that is billable for an assignment that is defined as Billable assignment. For a nonbillable assignment, the value is ignored. Valid values are positive integers between 0 and 100. -
BillablePercentReason: string
Title:
Billable Percent Reason
Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored. -
BillablePercentReasonCode: string
Title:
Billable Percent Reason Code
Maximum Length:30
Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored. -
CalendarId: integer
(int64)
Title:
Calendar ID
Read Only:true
Identifier of the calendar that establishes the normal working days, hours per day, and exceptions for a project enterprise resource. -
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. -
DailyHours: number
Title:
Resource Assignment Hours per Day
Working hours of a resource for each working day during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is N. -
DefaultStaffingOwnerFlag: boolean
Indicates whether all project resource requests will be assigned to the staffing owner by default.
-
Email: string
Title:
Email
Maximum Length:240
Email address of the resource. -
FridayHours: number
Title:
Resource Assignment Hours on Fridays
Working hours of a resource for every Friday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X. -
FromDate: string
(date)
Title:
From Date
The date when the resource assignment is to start on the project. -
LaborBillRate: number
Title:
Bill Rate
The amount paid to a business by its customer for a unit of work completed by the project enterprise resource. -
LaborCostRate: number
Title:
Cost Rate
The cost of a unit of work by the project enterprise resource. -
LaborEffort: number
Title:
Effort in Hours
The number of hours that a resource is assigned or allocated to work on a project. -
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. -
MondayHours: number
Title:
Resource Assignment Hours on Mondays
Working hours of a resource for every Monday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X. -
Name: string
Title:
Name
Maximum Length:240
Display name of the resource. -
ProjectCurrencyCode: string
Maximum Length:
15
Default Value:USD
The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency. -
ProjectId: integer
(int64)
Title:
Project ID
Unique identifier of the project associated to the resource assignment. To identify the project, provide a value for this attribute, or any one of the Project Number attribute or the Project Name attribute. Project is mandatory when creating an assignment. -
ProjectName: string
Title:
Project Name
Maximum Length:240
Name of the project. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Alphanumeric identifier of the project. -
ProjectResourceAssignmentId: integer
(int64)
Title:
Assignment ID
Unique identifier of the project resource assignment. -
ProjectRoleId: integer
(int64)
Title:
Project Role ID
Default Value:13
Identifier of the role that the selected resource is assigned to on a project assignment. To identify the project role, provide a value either for this attribute or the Project Role Name attribute but not both. Project Role value is mandatory when creating an assignment. -
ProjectRoleName: string
Title:
Project Role Name
Name of the role that the selected resource is assigned to on a project resource assignment. To identify the project role, provide a value either for this attribute or for the Project Role ID attribute but not both. -
ProjResourceId: integer
(int64)
Read Only:
true
Unique identifier of the project resource. -
Reason: string
Title:
Reason
Reason for requesting modification of the resource assignment. -
ResourceId: integer
(int64)
Title:
Resource ID
Unique identifier of the project enterprise resource. -
SaturdayHours: number
Title:
Resource Assignment Hours on Saturdays
Working hours of a resource for every Saturday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X. -
ScheduleHoursType: string
Title:
Resource Assignment Schedule Hours Indicator
Maximum Length:1
Indicates whether working hours are assigned to resources based on the project calendar, per week, per day, or the day of the week. Valid values are Y, N, X, and W. If the value is Y, hours are assigned based on the project calendar. If the value is N, hours are assigned per day. If the value is X, hours are assigned based on the day of the week and can vary across days. If the value is set to W, hours are assigned per week. The default value is Y. -
SundayHours: number
Title:
Resource Assignment Hours on Sundays
Working hours of a resource for every Sunday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X. -
ThursdayHours: number
Title:
Resource Assignment Hours on Thursdays
Working hours of a resource for every Thursday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X. -
ToDate: string
(date)
Title:
To Date
The date when the resource assignment is to end on the project. -
TuesdayHours: number
Title:
Resource Assignment Hours on Tuesdays
Working hours of a resource for every Tuesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X. -
WednesdayHours: number
Title:
Resource Assignment Hours on Wednesdays
Working hours of a resource for every Wednesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X. -
WeeklyHours: number
Working hours of a resource for each week during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is W.
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 project labor resources 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/projectLaborResources
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "ProjectId": 300100169584611, "ProjectRoleId": 13, "DefaultStaffingOwnerFlag": null, "ResourceId": 300100023180799, "Name": "George White", "Email": "prj_george_white_in_grp@oracle.com", "ProjectRoleName": "Team Member", "ProjectResourceAssignmentId": null, "CreatedBy": "ABRAHAM.MASON", "CreationDate": "2018-11-29T08:19:44.369+00:00", "LastUpdatedBy": "ABRAHAM.MASON", "LastUpdateDate": "2018-11-29T08:19:44.413+00:00", "Allocation": 100, "LaborEffort": null, "AssignmentStatusCode": "PLANNING_ONLY", "AssignmentStatus": "Planned", "LaborBillRate": null, "LaborCostRate": null, "FromDate": null, "ToDate": null, "ProjResourceId": 300100169584643, "ProjectCurrencyCode": "USD" }