Get all project resource actual hour records.
get
/fscmRestApi/resources/11.13.18.05/projectResourceActualHours
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 project resource actual hour record with the matching primary key criteria specified.
Finder Variables- TransactionId; integer; Unique identifier of the project resource actual hour record.
- PrimaryKey Finds the project resource actual hour record 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:- ActualHoursWorkedCategory; string; Type of activity that's represented by the actual hours. Examples are Project Work, Paid Time Off, Training, and Other.
- ActualHoursWorkedCategoryCode; string; Code for the type of activity that's represented by the actual hours. Examples are PROJECT_WORK, PTO, TRAINING, and OTHER.
- AdjustedTransactionReference; string; Reference to the original transaction that this transaction adjusts, if this transaction is for an adjustment. This is an optional value even for an adjustment transaction.
- AdjustmentEntryFlag; boolean; Indicates if the actual hours reported represent an adjustment to existing actual hours for a resource. This attribute is set to N during POST operation if no value is specified.
- BillableUtilizationFlag; boolean; Indicates whether the actual hours reported will be included in billable resource utilization calculation. Valid values are Y or N. If no value is provided, it will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.
- Comments; string; Information about the actual hours reported.
- HCMPersonId; integer; HCM Person identifier of the project enterprise resource for which actual hours are reported.
- OriginalTransactionReference; string; Reference to the transaction details in the originating source system.
- ProjectId; integer; Identifier of the project for which the project enterprise resource reported the actual hours worked.
- ProjectName; string; Name of the project for which the project enterprise resource reported the actual hours worked.
- ProjectNumber; string; Number of the project for which the project enterprise resource reported the actual hours worked.
- Quantity; number; Total actual hours worked that the resource reports for a day. The actual hours worked can be positive or negative with a maximum of two decimal places.
- ResourceEmail; string; Email of the project enterprise resource who reported actual hours worked.
- ResourceId; integer; Identifier of the project enterprise resource who reported actual hours worked.
- TaskId; integer; Identifier of the task for which the project enterprise resource reported actual hours worked.
- TaskName; string; Name of the task for which the project enterprise resource reported actual hours worked.
- TransactionId; integer; Unique identifier of the actual hours record.
- UtilizationDate; string; Date that's associated with the actual hours worked for utilization reporting purposes. If no value is specified, then the utilization date is based on the work date.
- UtilizationFlag; boolean; Indicates whether the actual hours reported are eligible to be included in utilization calculations for the resource. Valid values are Y or N. It will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.
- WorkDate; string; Date on which the project enterprise resource worked.
- 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: string 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: string 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 : projectResourceActualHours
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 : projectResourceActualHours-item-response
Type:
Show Source object
- ActualHoursWorkedCategory: string Title:
Actual Hours Worked Category
Maximum Length:80
Type of activity that's represented by the actual hours. Examples are Project Work, Paid Time Off, Training, and Other. - ActualHoursWorkedCategoryCode: string Title:
Actual Hours Worked Category Code
Maximum Length:80
Code for the type of activity that's represented by the actual hours. Examples are PROJECT_WORK, PTO, TRAINING, and OTHER. - AdjustedTransactionReference: string Title:
Adjusted Transaction Reference
Maximum Length:120
Reference to the original transaction that this transaction adjusts, if this transaction is for an adjustment. This is an optional value even for an adjustment transaction. - AdjustmentEntryFlag: boolean Title:
Adjustment Entry Indicator
Maximum Length:1
Default Value:false
Indicates if the actual hours reported represent an adjustment to existing actual hours for a resource. This attribute is set to N during POST operation if no value is specified. - BillableUtilizationFlag: boolean Title:
Billable Utilization Indicator
Maximum Length:1
Default Value:true
Indicates whether the actual hours reported will be included in billable resource utilization calculation. Valid values are Y or N. If no value is provided, it will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER. - Comments: string Title:
Comments
Maximum Length:240
Information about the actual hours reported. - HCMPersonId: integer (int64) Title:
Resource Person ID
Read Only:true
HCM Person identifier of the project enterprise resource for which actual hours are reported. - links: array Links Title:
Links
The link relations associated with the resource instance. - OriginalTransactionReference: string Title:
Original Transaction Reference
Maximum Length:120
Reference to the transaction details in the originating source system. - ProjectId: integer (int64) Title:
Project ID
Identifier of the project for which the project enterprise resource reported the actual hours worked. - ProjectName: string Title:
Project Name
Maximum Length:240
Name of the project for which the project enterprise resource reported the actual hours worked. - ProjectNumber: string Title:
Project Number
Maximum Length:25
Number of the project for which the project enterprise resource reported the actual hours worked. - Quantity: number Title:
Quantity
Total actual hours worked that the resource reports for a day. The actual hours worked can be positive or negative with a maximum of two decimal places. - ResourceEmail: string Title:
Resource Email
Maximum Length:240
Email of the project enterprise resource who reported actual hours worked. - ResourceId: integer (int64) Title:
Resource ID
Identifier of the project enterprise resource who reported actual hours worked. - ResourceName: string Title:
Resource Name
Read Only:true
Maximum Length:240
Name of the project enterprise resource who reported actual hours worked. - TaskId: integer (int64) Title:
Task ID
Identifier of the task for which the project enterprise resource reported actual hours worked. - TaskName: string Title:
Task Name
Maximum Length:255
Name of the task for which the project enterprise resource reported actual hours worked. - TransactionId: integer (int64) Title:
Transaction ID
Unique identifier of the actual hours record. - UtilizationDate: string (date) Title:
Utilization Date
Date that's associated with the actual hours worked for utilization reporting purposes. If no value is specified, then the utilization date is based on the work date. - UtilizationFlag: boolean Title:
Resource Utilization Indicator
Maximum Length:1
Default Value:true
Indicates whether the actual hours reported are eligible to be included in utilization calculations for the resource. Valid values are Y or N. It will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER. - WorkDate: string (date) Title:
Work Date
Date on which the project enterprise resource worked.
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 resource actual hour records 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/projectResourceActualHours
Response Body Example
The following shows an example of the response body in JSON format of the award funding sources.
{ "items": [ { "TransactionId": 300100033622601, "ResourceId": 300100024326422, "ResourceEmail": "Wolfgang.Beura@oracle.com", "HCMPersonId": 300100012548630, "ResourceName": "Wolfgang Beura", "WorkDate": "2013-12-01", "UtilizationDate": "2013-12-01", "ProjectId": 300100025404031, "ProjectNumber": "300100025404031", "ProjectName": "zBIQA_Rel8_RM7", "TaskId": null, "TaskName": null, "ActualHoursWorkedCategory": "Project work", "ActualHoursWorkedCategoryCode": "PROJECT_WORK", "Quantity": 8, "Comments": null, "UtilizationFlag": true, "BillableUtilizationFlag": true, "OriginalTransactionReference": null, "AdjustmentEntryFlag": false, "AdjustedTransactionReference": null, "links": [ { "rel": "self", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectResourceActualHours/300100033622601", "name": "projectResourceActualHours", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectResourceActualHours/300100033622601", "name": "projectResourceActualHours", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectResourceActualHours", "name": "projectResourceActualHours", "kind": "collection" } ] }