Get all resource assignments for a financial project plan version

get

/fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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 assignment of a financial project plan version.
      Finder Variables:
      • PlanningElementId; integer; Identifier of the resource assignment for a financial project plan version.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • BaselineFinishDate; string; The date that is planned on the baseline financial project plan for a resource to finish their assignment on a project task.
    • BaselineStartDate; string; The date that is planned on the baseline financial project plan for a resource to begin their assignment on a project task.
    • PlanningElementId; integer; Identifier of the resource assignment on the financial project plan version.
    • PlanningFinishDate; string; The date that is planned on the financial project plan for a resource to finish their assignment on a project task.
    • PlanningStartDate; string; The date that is planned on the financial project plan for a resource to begin their assignment on a project task.
    • RateBasedFlag; boolean; Indicates if the financial project plan resource assignment is rate based.
    • RbsElementId; integer; Identifier of the resource breakdown structure element used to create the financial project plan resource assignments line.
    • ResourceClass; string; Grouping of predefined resource types to which the resource in the financial project plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources.
    • ResourceName; string; Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial project plan resource assignment.
    • SpreadCurve; string; Name of the set of distribution factors that enables the application to automatically distribute quantity and cost for a resource on a task assignment across a range of accounting or project accounting periods.
    • TaskId; integer; Identifier of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment.
    • TaskName; string; Name of the task for which a financial project plan resource assignment is created. You must enter either Task ID or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment.
    • TaskNumber; string; Number of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task ID but not for all three or a combination of them while creating a financial project plan resource assignment.
    • UnitOfMeasure; string; Unit of work that measures the quantity of effort for which the resource is planned for on the financial project plan resource assignment.
    • UnplannedFlag; boolean; Indicates if the financial project plan resource assignment is unplanned.
    • UseTaskDatesAsTaskAssignmentDatesFlag; boolean; Indicates if the resource assignment dates on the task in the financial project plan resource assignment are the same as the task dates on the project.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : financialProjectPlans-ResourceAssignments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : financialProjectPlans-ResourceAssignments-item-response
Type: object
Show Source
  • Title: Administrative Code
    Action identifier used for administrative purpose only.
  • Title: Baseline Finish Date
    Read Only: true
    The date that is planned on the baseline financial project plan for a resource to finish their assignment on a project task.
  • Title: Baseline Start Date
    Read Only: true
    The date that is planned on the baseline financial project plan for a resource to begin their assignment on a project task.
  • Links
  • Default Value: N
    Indicates whether the periodic planning is retained in the plan version on plan line date modifications.
  • Planning Amounts
    Title: Planning Amounts
    The Planning Amounts resource is used to view, create, update, and delete a financial project plan resource assignment amounts.
  • Identifier of the resource assignment on the financial project plan version.
  • Title: Planning Dates: To Date
    The date that is planned on the financial project plan for a resource to finish their assignment on a project task.
  • Title: Planning Dates: From Date
    The date that is planned on the financial project plan for a resource to begin their assignment on a project task.
  • Title: Rate-Based Planning Resource
    Read Only: true
    Indicates if the financial project plan resource assignment is rate based.
  • Identifier of the resource breakdown structure element used to create the financial project plan resource assignments line.
  • Read Only: true
    Maximum Length: 240
    Grouping of predefined resource types to which the resource in the financial project plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources.
  • Title: Resource Name
    Maximum Length: 240
    Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial project plan resource assignment.
  • Title: Spread Curve
    Read Only: true
    Maximum Length: 240
    Name of the set of distribution factors that enables the application to automatically distribute quantity and cost for a resource on a task assignment across a range of accounting or project accounting periods.
  • Title: Task ID
    Identifier of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment.
  • Title: Task Name
    Maximum Length: 255
    Name of the task for which a financial project plan resource assignment is created. You must enter either Task ID or Task Number but not for all three or a combination of them while creating a financial project plan resource assignment.
  • Title: Task Number
    Maximum Length: 100
    Number of the task for which a financial project plan resource assignment is created. You must enter either Task Name or Task ID but not for all three or a combination of them while creating a financial project plan resource assignment.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Unit of work that measures the quantity of effort for which the resource is planned for on the financial project plan resource assignment.
  • Title: Unplanned
    Maximum Length: 1
    Indicates if the financial project plan resource assignment is unplanned.
  • Title: Use Task Planned Dates as Task Assignment Dates
    Indicates if the resource assignment dates on the task in the financial project plan resource assignment are the same as the task dates on the project.
Nested Schema : Planning Amounts
Type: array
Title: Planning Amounts
The Planning Amounts resource is used to view, create, update, and delete a financial project plan resource assignment amounts.
Show Source
Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-item-response
Type: object
Show Source
  • Title: Baseline Burdened Cost
    Read Only: true
    Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in planning currency.
  • Title: Rolled-up Baseline Cost for Resource in Project Currency
    Read Only: true
    Total planned cost for the baseline financial project plan resource assignment, including raw and burden costs, in project currency.
  • Title: Baseline Burdened Cost
    Read Only: true
    Total planned cost for the financial project plan resource assignment, including raw and burden costs, in project ledger currency in the baseline financial project plan version.
  • Title: Baseline Currency
    Read Only: true
    Maximum Length: 30
    Currency of the rendered baseline amounts.
  • Title: Baseline Quantity
    Read Only: true
    Measure of the effort planned for the resource assignment in the baseline financial project plan version, expressed in hours.
  • Title: Baseline Raw Cost
    Read Only: true
    Planned cost for the project in planning currency in the baseline financial project plan version that corresponds to the work performed.
  • Title: Baseline Raw Cost
    Read Only: true
    Planned cost for the baseline financial project plan resource assignment in project currency that corresponds to the work performed.
  • Title: Baseline Raw Cost
    Read Only: true
    Planned cost for the baseline financial project plan resource assignment in project ledger currency that corresponds to the work performed.
  • Title: Burdened Cost
    Total planned cost for the financial project plan resource assignment in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost in Project Currency: Total
    Read Only: true
    Total planned cost for the financial project plan resource assignment in project currency that includes both raw and burden costs.
  • Title: Burdened Cost in Project Ledger Currency: Total
    Read Only: true
    Total planned cost for the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.
  • Title: Currency
    Maximum Length: 15
    Code that identifies the planning currency on the financial project plan resource assignment.
  • Title: Average Effective Burden Cost Rate
    Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
  • Title: Effective Raw Cost Rate
    Cost rate that is used to calculate amounts for a financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
  • Title: ITD Actual Burdened Cost
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.
  • Title: ITD Actual Burdened Cost
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.
  • Title: ITD Actual Burdened Cost
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.
  • Title: ITD Actual Quantity
    Read Only: true
    Actual effort for the financial project plan resource assignment from the start of the project till the current date, expressed in hours.
  • Title: ITD Actual Raw Cost
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.
  • Title: ITD Actual Raw Cost
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.
  • Title: ITD Actual Raw Cost
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.
  • Links
  • Maximum Length: 1
    Indicates if the periodic planning is modified and retained for the plan line on date changes.
  • Title: Plan Line ID
    Identifier of the summary level planning amounts for a resource assignment in the financial project plan.
  • Plan Lines Descriptive Flexfields
    Title: Plan Lines Descriptive Flexfields
    The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans.
  • Title: Planned Quantity
    Measure of the effort planned for in the financial project plan resource assignment, expressed in hours.
  • Planning Amount Details
    Title: Planning Amount Details
    The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.
  • Title: Raw Cost
    Planned cost for the financial project plan resource assignment in planning currency that corresponds to the work performed.
  • Title: Raw Cost in Project Currency: Total
    Read Only: true
    Planned cost for the financial project plan resource assignment in project currency that corresponds to the work performed.
  • Title: Raw Cost in Project Ledger Currency
    Read Only: true
    Planned cost for the financial project plan resource assignment in project ledger currency that corresponds to the work performed.
  • Title: Standard Burdened Cost Rate
    Read Only: true
    Average rate derived from the rate schedule for calculating the planned burdened cost for the financial project plan resource assignment.
  • Title: Standard Raw Cost Rate
    Read Only: true
    Rate derived from the rate schedule for calculating the planned raw cost for the financial project plan resource assignment.
Nested Schema : Plan Lines Descriptive Flexfields
Type: array
Title: Plan Lines Descriptive Flexfields
The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans.
Show Source
Nested Schema : Planning Amount Details
Type: array
Title: Planning Amount Details
The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.
Show Source
Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanLinesDFF-item-response
Type: object
Show Source
Nested Schema : financialProjectPlans-ResourceAssignments-PlanningAmounts-PlanningAmountDetails-item-response
Type: object
Show Source
  • Title: Planned Burdened Cost
    Total planned cost for the period in the financial project plan resource assignment in planning currency that includes both raw and burden costs.
  • Title: Burdened Cost in Project Currency: Total
    Read Only: true
    Total planned cost for a period in the financial project plan resource assignment in project currency that includes both raw and burden costs.
  • Title: Burdened Cost in Project Ledger Currency: Total
    Read Only: true
    Total planned cost for a period in the financial project plan resource assignment in project ledger currency that includes both raw and burden costs.
  • Title: Burdened Cost Rate
    Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective burdened cost rate gives the burdened cost amounts.
  • Title: Effective Rate
    Cost rate that is used to calculate amounts for a period in the financial project plan resource assignment. Quantity multiplied by the effective raw cost rate gives the raw cost amounts.
  • Title: ITD Actual Burdened Cost
    Read Only: true
    Actual cost incurred for the period in the financial project plan resource assignment, including raw and burden costs, in planning currency from the start date of the project till the current date.
  • Title: ITD Actual Burdened Cost
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project currency from the start date of the project till the current date.
  • Title: ITD Actual in Project Ledger Currency
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment, including raw and burden costs, in project ledger currency from the start date of the project till the current date.
  • Title: ITD Actual Quantity
    Read Only: true
    Actual effort for the period in the financial project plan resource assignment from the start of the project till the current date, expressed in hours.
  • Title: ITD Actual Raw Cost
    Read Only: true
    Actual cost incurred for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed from the start date of the project till the current date.
  • Title: ITD Actual in Project Currency
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment in project currency that corresponds to the work performed from the start date of the project till the current date.
  • Title: ITD Actual in Project Ledger Currency
    Read Only: true
    Actual cost incurred for the financial project plan resource assignment in project ledger currency that corresponds to the work performed from the start date of the project till the current date.
  • Links
  • Maximum Length: 1
    Indicates if the periodic planning is modified and retained for the plan line on date changes.
  • Title: Period
    Maximum Length: 30
    Period for which the periodic level planning amounts are created for a resource assignment in the financial project plan.
  • Title: Planned Quantity
    Measure of the effort planned for the period in the financial project plan resource assignment, expressed in hours.
  • Title: Raw cost
    Planned cost for the period in the financial project plan resource assignment in planning currency that corresponds to the work performed.
  • Title: Raw Cost in Project Currency: Total
    Read Only: true
    Planned cost for a period in the financial project plan resource assignment in project currency that corresponds to the work performed.
  • Title: Raw Cost in Project Ledger Currency: Total
    Read Only: true
    Planned cost for a period in the financial project plan resource assignment in project ledger currency that corresponds to the work performed.
  • Title: Standard Burdened Cost Rate
    Read Only: true
    Average rate derived from the rate schedule for calculating the planned burdened cost for the period in the financial project plan resource assignment.
  • Title: Standard Raw Cost Rate
    Read Only: true
    Rate derived from the rate schedule for calculating the planned raw cost for the period in the financial project plan resource assignment.
Back to Top

Examples

The following example shows how to get all resource assignments for a financial project plan version 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/financialProjectPlans/4067307/child/ResourceAssignments

Response Body Example

The following shows an example of the response body in JSON format.

{
"items": [
  {
"PlanningElementId": 1987603435,
"TaskId": 100010025119108,
"TaskNumber": "2.1",
"TaskName": "Oracle Financials Familiarization",
"RbsElementId": 100000042522497,
"ResourceName": "Henry Holt",
"PlanningStartDate": "2008-09-30T00:00:00+00:00",
"PlanningFinishDate": "2008-12-30T00:00:00+00:00",
"BaselineStartDate": null,
"BaselineFinishDate": null,
"SpreadCurve": "Prorated Even",
"UnitOfMeasure": "Hours",
"ResourceClass": "Labor",
"UseTaskDatesAsTaskAssignmentDatesFlag": false,
"RateBasedFlag": true,
"UnplannedFlag": false,
"AdministrativeCode": null
}
Back to Top