Get an award budget version
get
/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}
Request
Path Parameters
-
PlanVersionId(required): integer(int64)
Identifier of the award budget version.
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-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Read Only:
true
Identifier of the award on which the budget is created. -
AwardName: string
Read Only:
true
Maximum Length:300
Name of the award on which the budget is created. -
AwardNumber: string
Read Only:
true
Maximum Length:120
Number of the award on which the budget is created. -
FinancialPlanType: string
Title:
Financial Plan Type
Read Only:true
Maximum Length:240
Name of the financial plan type used to create the award budget version. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PCBurdenedCostAmounts: number
Read Only:
true
Budget burdened cost amounts in project currency for the award budget version. -
PCRawCostAmounts: number
Read Only:
true
Budget raw cost amounts in project currency for the award budget version. -
PCRevenueAmounts: number
Read Only:
true
Budget revenue amounts in project currency for the award budget version. -
PFCBurdenedCostAmounts: number
Read Only:
true
Budget burdened cost amounts in project ledger currency for the award budget version. -
PFCRawCostAmounts: number
Read Only:
true
Budget raw cost amounts in project ledger currency for the award budget version. -
PFCRevenueAmounts: number
Read Only:
true
Budget revenue amounts in project ledger currency for the award budget version. -
PlanningAmounts: string
Read Only:
true
Maximum Length:30
The planning amount, either cost or revenue, that you must specify when using a financial plan type that allows creation of cost and revenue versions separately. -
PlanVersionDescription: string
Title:
Description
Read Only:true
Maximum Length:2000
Plan version description for the award budget. -
PlanVersionId: integer
(int64)
Read Only:
true
Identifier of the award budget version. -
PlanVersionName: string
Title:
Name
Read Only:true
Maximum Length:225
Plan version name for the award budget. -
PlanVersionNumber: integer
(int64)
Title:
Number
Read Only:true
Plan version number for the award budget. -
PlanVersionStatus: string
Title:
Status
Read Only:true
Maximum Length:80
Plan version status for the award budget. -
ProjectId: integer
(int64)
Title:
Project ID
Read Only:true
Identifier of the project on which the award budget is created. -
ProjectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
Name of the project on which the award budget is created. -
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
Number of the project on which the award budget is created. -
Resources: array
Resources
Title:
Resources
The Resources resource is used to view the resources in the planning resource breakdown structure that are included in the award budget. -
Tasks: array
Tasks
Title:
Tasks
The Tasks resource is used to view an award budget version task. -
VersionErrors: array
Version Errors
Title:
Version Errors
The Version Errors resource is used to view award budget version errors.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Resources
Type:
array
Title:
Resources
The Resources resource is used to view the resources in the planning resource breakdown structure that are included in the award budget.
Show Source
Nested Schema : Tasks
Type:
array
Title:
Tasks
The Tasks resource is used to view an award budget version task.
Show Source
Nested Schema : Version Errors
Type:
array
Title:
Version Errors
The Version Errors resource is used to view award budget version errors.
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-item-response
Type:
Show Source
object
-
BudgetLines: array
Budget Lines
Title:
Budget Lines
The Budget Lines resource is used to view the budget lines for a resource. -
BurdenedCostAmounts: number
Read Only:
true
Award budget line burdened cost amounts in transaction currency. -
Currency: string
Title:
Project Currency
Read Only:true
Maximum Length:15
Currency code for the award budget lines. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentElementId: integer
(int64)
Read Only:
true
Identifier of the parent resource breakdown structure element. -
PCBurdenedCostAmounts: number
Read Only:
true
Award budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Read Only:
true
Award budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Read Only:
true
Award budget line revenue amounts in project currency. -
PFCBurdenedCostAmounts: number
Read Only:
true
Award budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Read Only:
true
Award budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Read Only:
true
Award budget line revenue amounts in project ledger currency. -
Quantity: number
Read Only:
true
Measure of the effort planned for the award budget line. -
RawCostAmounts: number
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
Read Only:
true
Award budget line revenue amounts in transaction currency.
Nested Schema : Budget Lines
Type:
array
Title:
Budget Lines
The Budget Lines resource is used to view the budget lines for a resource.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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 : 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
Nested Schema : awardBudgetSummary-Tasks-item-response
Type:
Show Source
object
-
BudgetLines: array
Budget Lines
Title:
Budget Lines
The Budget Lines resource is used to view the budget lines for a task. -
BurdenedCostAmounts: number
Read Only:
true
Award budget line burdened cost amounts in transaction currency. -
Currency: string
Title:
Project Currency
Read Only:true
Maximum Length:15
Currency code for the award budget lines. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentTaskId: integer
(int64)
Title:
Parent Task ID
Read Only:true
Identifier of the parent task. -
PCBurdenedCostAmounts: number
Read Only:
true
Award budget line burdened cost amounts in project currency. -
PCRawCostAmounts: number
Read Only:
true
Award budget line raw cost amounts in project currency. -
PCRevenueAmounts: number
Read Only:
true
Award budget line revenue amounts in project currency. -
PFCBurdenedCostAmounts: number
Read Only:
true
Award budget line burdened cost amounts in project ledger currency. -
PFCRawCostAmounts: number
Read Only:
true
Award budget line raw cost amounts in project ledger currency. -
PFCRevenueAmounts: number
Read Only:
true
Award budget line revenue amounts in project ledger currency. -
PlanningEndDate: string
(date)
Title:
Planned Finish Date
Read Only:true
Scheduled end date of the project task. -
PlanningStartDate: string
(date)
Title:
Planned Start Date
Read Only:true
Scheduled start date of the project task. -
Quantity: number
Read Only:
true
Measure of the effort planned for the award budget line. -
RawCostAmounts: number
Read Only:
true
Award budget line raw cost amounts in transaction currency. -
RevenueAmounts: number
Read Only:
true
Award budget line revenue amounts in transaction currency. -
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 : Budget Lines
Type:
array
Title:
Budget Lines
The Budget Lines resource is used to view the budget lines for a task.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awardBudgetSummary-Tasks-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 : awardBudgetSummary-Tasks-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
Nested Schema : awardBudgetSummary-VersionErrors-item-response
Type:
Show Source
object
-
ErrorType: string
Title:
Severity
Read Only:true
Maximum Length:30
Specifies whether a warning or error. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageCause: string
Read Only:
true
Maximum Length:4000
Explanation for the reason of an error or warning message. -
MessageName: string
Read Only:
true
Maximum Length:30
Message code for the issue encountered. -
MessageText: string
Title:
Message Text
Read Only:true
Maximum Length:240
Error or warning that occurs or information that informs users, to know what action to take or to understand what is happening. -
MessageUserAction: string
Read Only:
true
Maximum Length:4000
States the response that end users must perform to continue and complete their tasks in response to an error or warning message. -
MessageUserDetails: string
Read Only:
true
Maximum Length:4000
More detailed explanation of message text that states why the message occurred. -
PeriodName: string
Title:
Period
Read Only:true
Maximum Length:30
Period for which the periodic budget amount is entered. -
PlanVersionId: integer
Read Only:
true
Identifier of the award budget version. -
ResourceName: string
Title:
Resource
Read Only:true
Maximum Length:240
The name of the resource used to create the budget line. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
Name of the task which is used to create a budget line. -
TaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
Number of the task which is used to create a budget line. -
TaskSequence: integer
(int64)
Read Only:
true
Position of the task in the task hierarchy. -
TransactionCurrencyCode: string
Title:
Entered Currency
Read Only:true
Maximum Length:15
Currency code for the budget lines.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Resources
-
Parameters:
- PlanVersionId:
$request.path.PlanVersionId
The Resources resource is used to view the resources in the planning resource breakdown structure that are included in the award budget. - PlanVersionId:
- Tasks
-
Parameters:
- PlanVersionId:
$request.path.PlanVersionId
The Tasks resource is used to view an award budget version task. - PlanVersionId:
- VersionErrors
-
Operation: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/VersionErrorsParameters:
- PlanVersionId:
$request.path.PlanVersionId
The Version Errors resource is used to view award budget version errors. - PlanVersionId:
Examples
The following example shows how to get an award budget version for an award 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/100100053015964
Response Body Example
The following example shows the contents of the response body in JSON format of the award budget version with the plan version ID 100100053015964.
{ "FinancialPlanType": "Award Cost Budget - Approved", "PlanVersionId": 100100053015964, "PlanVersionNumber": 2, "PlanVersionName": "Version 2", "PlanVersionDescription": null, "PlanVersionStatus": "Current Working", "AwardId": 300100090708043, "AwardNumber": "Award_001", "AwardName": "Award_001", "ProjectId": 300100095525314, "ProjectNumber": "Award_PRJ1", "ProjectName": "Award_PRJ1", "PlanningAmounts": "COST", "PCRawCostAmounts": 1925, "PCBurdenedCostAmounts": 2310, "PCRevenueAmounts": 0, "PFCRawCostAmounts": 1925, "PFCBurdenedCostAmounts": 2310, "PFCRevenueAmounts": 0, "links": [ { "rel": "self", "href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964", "name": "awardBudgetSummary", "kind": "item" }, { "rel": "canonical", "href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964", "name": "awardBudgetSummary", "kind": "item" }, { "rel": "child", "href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964/child/VersionErrors", "name": "VersionErrors", "kind": "collection" }, { "rel": "child", "href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964/child/Tasks", "name": "Tasks", "kind": "collection" }, { "rel": "child", "href": "http://servername/fscmRestApi/resources/11.13.18.05/awardBudgetSummary/100100053015964/child/Resources", "name": "Resources", "kind": "collection" } ], }