Get a budget line for a task
get
/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}/child/BudgetLines/{BudgetLinesUniqID}
Request
Path Parameters
-
BudgetLinesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Budget Lines resource and used to uniquely identify an instance of Budget Lines. The client should not generate the hash key value. Instead, the client should query on the Budget Lines collection resource in order to navigate to a specific instance of Budget Lines to get the hash key.
-
PlanVersionId(required): integer(int64)
Identifier of the award budget version.
-
RbsElementId(required): integer(int64)
Identifier of the resource used to create the award 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 : awardBudgetSummary-Resources-BudgetLines-item-response
Type:
Show Source
object
-
BurdenedCostAmounts: number
Title:
Total
Read Only:true
Award budget line burdened cost amounts in transaction currency. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:15
Currency code for the award budget lines. -
EffectiveBurdenedCostRate: number
Title:
Effective Rate
Read Only:true
Effective burdened cost rate for award budget line. -
EffectiveRawCostRate: number
Title:
Effective Rate
Read Only:true
Effective raw cost rate for award budget line. -
EffectiveRevenueRate: number
Title:
Effective Rate
Read Only:true
Effective revenue rate for award budget line. -
FundingSourceId: integer
(int64)
Read Only:
true
Identifier of the funding source used to create the award budget line. -
FundingSourceName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the funding source used to create the award budget line. -
FundingSourceNumber: string
Read Only:
true
Maximum Length:50
Number of the funding source used to create the award budget line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PCBurdenedCostAmounts: number
Title:
Total
Read Only:true
Award budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Total
Read Only:true
Award budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Total
Read Only:true
Award budget line revenue amounts in project currency. -
PFCBurdenedCostAmounts: number
Title:
Total
Read Only:true
Award budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Total
Read Only:true
Award budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Title:
Total
Read Only:true
Award budget line revenue amounts in project ledger currency. -
PlanningAmountDetails: array
Planning Amount Details
Title:
Planning Amount Details
The Planning Amount Details resource is used to view periodic amounts for a budget line. -
PlanningEndDate: string
(date)
Title:
Planned Finish Date
Read Only:true
Award budget line end date. -
PlanningStartDate: string
(date)
Title:
Planned Start Date
Read Only:true
Award budget line start date. -
Quantity: number
Title:
Total
Read Only:true
Measure of the effort planned for the award budget line. -
RawCostAmounts: number
Title:
Total
Read Only:true
Award budget line raw cost amounts in transaction currency. -
RbsElementId: integer
(int64)
Read Only:
true
Identifier of the resource used to create the award budget line. -
ResourceClass: string
Title:
Resource Class
Read Only:true
Maximum Length:240
A resource type that is available for use within resource format hierarchies on planning resource breakdown structure. -
ResourceFormat: string
Title:
Resource Combination
Read Only:true
Maximum Length:240
Resource format to add resource element to the planning resource breakdown structure. -
ResourceName: string
Title:
Resource
Read Only:true
Maximum Length:240
The name of the resource used to create the award budget line. -
RevenueAmounts: number
Title:
Total
Read Only:true
Award budget line revenue amounts in transaction currency. -
SpreadCurve: string
Title:
Name
Read Only:true
Maximum Length:240
Determines how quantity, cost, and revenue amounts are distributed across accounting or project accounting periods. -
StandardBurdenedCostRate: number
Read Only:
true
Standard burdened cost rate for award budget line. -
StandardRawCostRate: number
Read Only:
true
Standard raw cost rate for award budget line. -
StandardRevenueRate: number
Read Only:
true
Standard revenue rate for award budget line. -
TaskId: integer
(int64)
Title:
Task ID
Read Only:true
Identifier of the task which is used to create a award budget line. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
Name of the task which is used to create a award budget line. -
TaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
Number of the task which is used to create a award budget line. -
TaskSequence: integer
(int64)
Title:
Task Sequence
Read Only:true
Position of the task in the task hierarchy.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Planning Amount Details
Type:
array
Title:
Planning Amount Details
The Planning Amount Details resource is used to view 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 : awardBudgetSummary-Resources-BudgetLines-PlanningAmountDetails-item-response
Type:
Show Source
object
-
BurdenedCostAmounts: number
Read Only:
true
Periodic award budget line burdened cost amounts in transaction currency. -
EffectiveBurdenedCostRate: number
Read Only:
true
Effective burdened cost rate for periodic line. -
EffectiveRawCostRate: number
Read Only:
true
Effective raw cost rate for periodic line. -
EffectiveRevenueRate: number
Title:
Effective Rate
Read Only:true
Effective revenue rate for periodic line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PCBurdenedCostAmounts: number
Title:
Burdened Cost
Read Only:true
Periodic award budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Title:
Total
Read Only:true
Periodic award budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Title:
Total
Read Only:true
Periodic award budget line revenue amounts in project currency. -
PeriodName: string
Title:
Period
Read Only:true
Maximum Length:30
Period for which the periodic budget amount is entered. -
PFCBurdenedCostAmounts: number
Read Only:
true
Periodic award budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Title:
Total
Read Only:true
Periodic award budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Read Only:
true
Periodic award budget line revenue amounts in project ledger currency. -
Quantity: number
Title:
Total
Read Only:true
Measure of the effort planned for the award budget line by period. -
RawCostAmounts: number
Title:
Total
Read Only:true
Periodic award budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Read Only:
true
Periodic award budget line revenue amounts in transaction currency. -
StandardBurdenedCostRate: number
Title:
Effective Rate
Read Only:true
Standard burdened cost rate for periodic line. -
StandardRawCostRate: number
Read Only:
true
Standard raw cost rate for periodic line. -
StandardRevenueRate: number
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
- PlanningAmountDetails
-
Parameters:
- BudgetLinesUniqID:
$request.path.BudgetLinesUniqID
- PlanVersionId:
$request.path.PlanVersionId
- RbsElementId:
$request.path.RbsElementId
The Planning Amount Details resource is used to view periodic amounts for a budget line. - BudgetLinesUniqID:
Examples
The following example shows how to get an award budget lines for an award budget 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/awardBudgetSummary/300100152462989/child/Resources/300100038787345/child/BudgetLines/100100076566600
Response Body Example
The following shows an example of the response body in JSON format of all the award budget lines for an award budget version with the plan version ID 300100152462989 and planning element ID 100100076566600.
{ "TaskId": 100100051713676, "TaskNumber": "2.1", "TaskName": "Therapies in Stroke Rehabilitation", "ResourceFormat": "Expenditure Category", "ResourceClass": "Labor", "SpreadCurve": "Even", "RbsElementId": 300100038787345, "ResourceName": "Salary", "PlanningStartDate": "2013-09-01", "PlanningEndDate": "2015-09-01", "FundingSourceId": 300100038787369, "FundingSourceNumber": "CDRM_70255", "FundingSourceName": "Dept of Health and Human Services (DHHS)", "Quantity": 75, "Currency": "USD", "RawCostAmounts": 750, "BurdenedCostAmounts": 900, "RevenueAmounts": null, "EffectiveRawCostRate": 10, "StandardRawCostRate": 10, "EffectiveBurdenedCostRate": 12, "StandardBurdenedCostRate": 12, "EffectiveRevenueRate": null, "StandardRevenueRate": null, "PCRawCostAmounts": 750, "PCBurdenedCostAmounts": 900, "PCRevenueAmounts": null, "PFCRawCostAmounts": 750, "PFCBurdenedCostAmounts": 900, "PFCRevenueAmounts": null, "TaskSequence": 500000, "links": [ { "rel": "self", "href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/300100152462989/child/Resources/300100038787345/child/BudgetLines/100100076566600", "name": "BudgetLines", "kind": "item" }, { "rel": "canonical", "href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/300100152462989/child/Resources/300100038787345/child/BudgetLines/100100076566600", "name": "BudgetLines", "kind": "item" }, { "rel": "parent", "href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/300100152462989/child/Resources/300100038787345", "name": "Resources", "kind": "item" }, { "rel": "child", "href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/300100152462989/child/Resources/300100038787345/child/BudgetLines/100100076566600/child/PlanningAmountDetails", "name": "PlanningAmountDetails", "kind": "collection" } ], }