Get a planning resource for a project budget version
get
/fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}
Request
Path Parameters
-
PlanVersionId(required): integer(int64)
Identifier of the project budget version.
-
PlanningElementId(required): integer(int64)
Identifier of the project budget line.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : projectBudgets-PlanningResources-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaintainManualSpreadOnDateChanges: string
Default Value:
N
Indicates if the periodic planning is retained on plan line date modifications. -
PlanningAmounts: array
Planning Amounts
Title:
Planning Amounts
The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line. -
PlanningElementId: integer
(int64)
Title:
Planning Element ID
Identifier of the project budget line. -
PlanningEndDate: string
(date-time)
Title:
Planning Dates: To Date
The finish date of the resource assignment on the task in the project budget version. -
PlanningStartDate: string
(date-time)
Title:
Planning Dates: From Date
The start date of the resource assignment on the task in the project budget version. -
RbsElementId: integer
(int64)
Identifier of the resource which is assigned to a task on a project budget line.
-
ResourceName: string
Title:
Resource Name
Maximum Length:240
Name of the resource which is assigned to a task on a project budget line. -
TaskId: integer
(int64)
Identifier of the task to which a planning resource is assigned on a project budget line.
-
TaskName: string
Title:
Task Name
Maximum Length:255
Name of the task to which a planning resource is assigned on a project budget line. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
Number of the task to which a planning resource is assigned on a project budget line. -
UnitOfMeasure: string
Read Only:
true
The unit, such as Hours, that is used to measure the work or effort that is planned for a resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Planning Amounts
Type:
array
Title:
Planning Amounts
The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.
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.
Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-item-response
Type:
Show Source
object
-
BurdenedCostAmounts: number
Title:
Burdened Cost
Budget line burdened cost amounts in transaction currency. -
Currency: string
Maximum Length:
15
Currency code for the budget lines. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective Rate
Effective burdened cost rate for budget line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost Rate
Effective raw cost rate for budget line. -
EffectiveRevenueRate: number
Title:
Effective Revenue Rate
Effective revenue rate for budget line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualSpreadFlag: boolean
Maximum Length:
1
Indicates if the periodic planning is modified and retained for the plan line on date changes. -
PCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Currency
Read Only:true
Budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Raw Cost in Project Currency
Read Only:true
Budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Revenue in Project Currency
Read Only:true
Budget line revenue amounts in project currency. -
PFCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Ledger Currency
Read Only:true
Budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Raw Cost in Project Ledger Currency
Read Only:true
Budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Title:
Revenue in Project Ledger Currency
Read Only:true
Budget line revenue amounts in project ledger currency. -
PlanLineId: integer
(int64)
Identifier of the planning amounts for a resource assignment in the project budget version.
-
PlanLinesDFF: array
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 project budgets. -
PlanningAmountDetails: array
Planning Amount Details
Title:
Planning Amount Details
The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line. -
Quantity: number
Title:
Quantity
Measure of the effort planned for the budget line. -
RawCostAmounts: number
Title:
Raw Cost
Budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
Revenue
Budget line revenue amounts in transaction currency. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost Rate
Read Only:true
Standard burdened cost rate for budget line. -
StandardRawCostRate: number
Title:
Standard Raw Cost Rate
Read Only:true
Standard raw cost rate for budget line. -
StandardRevenueRate: number
Title:
Standard Revenue Rate
Read Only:true
Standard revenue rate for budget line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 project budgets.
Show Source
Nested Schema : Planning Amount Details
Type:
array
Title:
Planning Amount Details
The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.
Show Source
Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-PlanLinesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Code that identifies the context for the segments of the plan lines flexfields. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Name of the context for the segments of the plan lines flexfields. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanLineId: integer
(int64)
Identifier of the summary level planning amounts for a plan line in the project budget.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type:
Show Source
object
-
BurdenedCostAmounts: number
Title:
Burdened Cost
Periodic budget line burdened cost amounts in transaction currency. -
EffectiveBurdenedCostRate: number
Title:
Burdened Cost: Effective Rate
Effective burdened cost rate for periodic line. -
EffectiveRawCostRate: number
Title:
Effective Raw Cost Rate
Effective raw cost rate for periodic line. -
EffectiveRevenueRate: number
Title:
Effective Revenue Rate
Effective revenue rate for periodic line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualSpreadFlag: boolean
Maximum Length:
1
Indicates if the periodic planning is modified and retained for the plan line on date changes. -
PCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Currency
Read Only:true
Periodic budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Raw Cost in Project Currency
Read Only:true
Periodic budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Revenue in Project Currency
Read Only:true
Periodic budget line revenue amounts in project currency. -
PeriodName: string
Maximum Length:
30
Period for which the periodic budget amount is entered. -
PFCBurdenedCostAmounts: number
Title:
Burdened Cost in Project Ledger Currency
Read Only:true
Periodic budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Raw Cost in Project Ledger Currency
Read Only:true
Periodic budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Title:
Revenue in Project Ledger Currency
Read Only:true
Periodic budget line revenue amounts in project ledger currency. -
PlanLineDetailId: integer
(int64)
Title:
Plan Line Details ID
Identifier of the periodic level planning amounts for a resource assignment in the project budget version. -
Quantity: number
Title:
Quantity
Measure of the effort planned for the budget line by period. -
RawCostAmounts: number
Title:
Raw Cost
Periodic budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Title:
Revenue
Periodic budget line revenue amounts in transaction currency. -
StandardBurdenedCostRate: number
Title:
Standard Burdened Cost Rate
Read Only:true
Standard burdened cost rate for periodic line. -
StandardRawCostRate: number
Title:
Standard Raw Cost Rate
Read Only:true
Standard raw cost rate for periodic line. -
StandardRevenueRate: number
Title:
Standard Revenue Rate
Read Only:true
Standard revenue rate for periodic line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PlanningAmounts
-
Parameters:
- PlanVersionId:
$request.path.PlanVersionId
- PlanningElementId:
$request.path.PlanningElementId
The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line. - PlanVersionId:
Examples
The following example shows how to get a project budget line 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/projectBudgets/100000043678717/child/PlanningResources/435158
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "TaskId": 100000042305227, "TaskNumber": "1.0", "TaskName": "Planning", "RbsElementId": 100000041113231, "ResourceName": "Per Diem", "UnitOfMeasure": "DOLLARS", "PlanningStartDate": "2008-07-01T00:00:00+00:00", "PlanningEndDate": "2008-07-31T00:00:00+00:00" }