Get all award budget versions
get
/fscmRestApi/resources/11.13.18.05/awardBudgets
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:- CurrentBaselineAwardBudgetFinder: Finds the current baseline award budget for the specified award and financial plan type.
Finder Variables:- AwardId; integer; Identifier of the award on which the budget is created.
- FinancialPlanType; string; Name of the financial plan type used to create the award budget version.
- ProjectId; integer; Identifier of the project on which the award budget is created.
- CurrentWorkingAwardBudgetFinder: Finds the current working award budget for the specified award and financial plan type.
Finder Variables:- AwardId; integer; Identifier of the award on which the budget is created.
- FinancialPlanType; string; Name of the financial plan type used to create the award budget version.
- ProjectId; integer; Identifier of the project on which the award budget is created.
- PrimaryKey: Finds the award budget version.
Finder Variables:- PlanVersionId; integer; Identifier of the award budget version.
- CurrentBaselineAwardBudgetFinder: Finds the current baseline award budget for the specified award and financial plan type.
- 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:- AwardId; integer; Identifier of the award on which the budget is created.
- AwardName; string; Name of the award on which the budget is created.
- AwardNumber; string; Number of the award on which the budget is created.
- FinancialPlanType; string; Name of the financial plan type used to create the award budget version.
- LockedBy; string; Name of the user who has locked the award budget version.
- LockedFlag; boolean; Indicates if the award budget version is locked. A value of true means that the budget version is locked and can't be edited. A value of false means that the budget version is not locked and can be edited. The default value while creating an award budget version is false.
- PlanVersionDescription; string; Plan version description for the award budget.
- PlanVersionId; integer; Identifier of the award budget version.
- PlanVersionName; string; Plan version name for the award budget.
- PlanVersionNumber; integer; Plan version number for the award budget.
- PlanVersionStatus; string; Plan version status for the award budget.
- PlanningAmounts; string; 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.
- PlanningOptionId; integer; Unique identifier of the summary-level planning option in the award budget version.
- ProjectId; integer; Identifier of the project on which the award budget is created.
- ProjectName; string; Name of the project on which the award budget is created.
- ProjectNumber; string; Number of the project on which the award budget is created.
- RbsVersionId; integer; Identifier of the resource breakdown structure that is attached to the project for which you can view summarized data.
- 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 : awardBudgets
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 : awardBudgets-item-response
Type:
Show Source object
- AdministrativeCode: string Title:
Administrative Code
Identifies the action that an administrator can perform on the budget version based on specific requirements. Not to be used in typical implementations. - Attachments: array Award Budget Attachments Title:
Award Budget Attachments
The Attachment resource is used to view, create, update, and delete attachments for award budgets. - AwardId: integer (int64) Title:
Award Identifier
Identifier of the award on which the budget is created. - AwardName: string Title:
Award Name
Maximum Length:300
Name of the award on which the budget is created. - AwardNumber: string Title:
Award Number
Maximum Length:120
Number of the award on which the budget is created. - BudgetCreationMethod: string Title:
Budget Creation Method
Value of the budget creation method. Valid values are: MANUAL, GENERATE, and COPY. - BudgetGenerationSource: string Title:
Budget Generation Source
Value of the financial plan type to create a budget from an existing budget. Valid values are: Financial Plan Type and Project Plan Type. - CopyAdjustmentPercentage: number Title:
Adjustment Percentage
Percentage value, either positive or negative, used to adjust the existing values when creating new version values. - DeferFinancialPlanCreation: string Title:
Defer Financial Plan Creation
Default Value:Y
Indicates that the budget version will be created in a deferred mode. Valid values are Y and N. The default value is Y. A value of Y means that the budget version will be created in a deferred mode by the Process Financial Plan Versions process. A value of N means that the budget version will be created in real time and included in the response of the POST operation. - FinancialPlanType: string Title:
Financial Plan Type
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. - LockedBy: string Title:
Locked By
Read Only:true
Maximum Length:255
Name of the user who has locked the award budget version. - LockedFlag: boolean Title:
Locked
Indicates if the award budget version is locked. A value of true means that the budget version is locked and can't be edited. A value of false means that the budget version is not locked and can be edited. The default value while creating an award budget version is false. - PCBurdenedCostAmounts: number Title:
Burdened Cost in Project Currency
Read Only:true
Budget burdened cost amounts in project currency for the award budget version. - PCRawCostAmounts: number Title:
Raw Cost in Project Currency
Read Only:true
Budget raw cost amounts in project currency for the award budget version. - PCRevenueAmounts: number Title:
Revenue in Project Currency
Read Only:true
Budget revenue amounts in project currency for the award budget version. - PFCBurdenedCostAmounts: number Title:
Burdened Cost in Project Ledger Currency
Read Only:true
Budget burdened cost amounts in project ledger currency for the award budget version. - PFCRawCostAmounts: number Title:
Raw Cost in Project Ledger Currency
Read Only:true
Budget raw cost amounts in project ledger currency for the award budget version. - PFCRevenueAmounts: number Title:
Revenue in Project Ledger Currency
Read Only:true
Budget revenue amounts in project ledger currency for the award budget version. - PlanningAmounts: string Title:
Planning Amounts
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. - PlanningOptionId: integer (int64) Title:
Planning Option ID
Read Only:true
Unique identifier of the summary-level planning option in the award budget version. - PlanningOptions: array Planning Options Title:
Planning Options
The Planning Options resource is used to view the planning options configured for the award budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Award budget versions inherit planning options that are defined for financial plan types. - PlanningResources: array Planning Resources Title:
Planning Resources
The Planning resources is used to view, create, update, and delete an award budget line. - PlanVersionDescription: string Title:
Description
Maximum Length:2000
Plan version description for the award budget. - PlanVersionId: integer (int64) Title:
Budget Version ID
Read Only:true
Identifier of the award budget version. - PlanVersionName: string Title:
Version Name
Maximum Length:225
Plan version name for the award budget. - PlanVersionNumber: integer (int64) Title:
Version Number
Read Only:true
Plan version number for the award budget. - PlanVersionStatus: string Title:
Plan Version Status
Plan version status for the award budget. - ProjectId: integer (int64) Identifier of the project on which the award budget is created.
- ProjectName: string Title:
Project Name
Maximum Length:240
Name of the project on which the award budget is created. - ProjectNumber: string Title:
Project Number
Maximum Length:25
Number of the project on which the award budget is created. - RbsVersionId: integer (int64) Title:
Resource Breakdown Structure Version ID
Read Only:true
Identifier of the resource breakdown structure that is attached to the project for which you can view summarized data. - SourcePlanType: string Title:
Source Plan Type
Name of the financial plan type to create a budget from an existing budget. - SourcePlanVersionId: integer Title:
Source Plan Version
Identifier of the source plan version. The SourcePlanVersionId attributes takes precedence over all the other attributes such as generation source, plan type, and so on. - SourcePlanVersionNumber: integer Number of the source plan version.
- SourcePlanVersionStatus: string Status of the source plan version when creating a budget using a financial project plan. Valid values are: Current Working and Baseline.
- VersionErrors: array Version Errors Title:
Version Errors
The Version Errors resource is used to view award budget version and award budget line errors.
Nested Schema : Award Budget Attachments
Type:
array
Title:
Award Budget Attachments
The Attachment resource is used to view, create, update, and delete attachments for award budgets.
Show Source Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : Planning Options
Type:
array
Title:
Planning Options
The Planning Options resource is used to view the planning options configured for the award budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Award budget versions inherit planning options that are defined for financial plan types.
Show Source Nested Schema : Planning Resources
Type:
array
Title:
Planning Resources
The Planning resources is used to view, create, update, and delete an award budget line.
Show Source Nested Schema : Version Errors
Type:
array
Title:
Version Errors
The Version Errors resource is used to view award budget version and award budget line errors.
Show Source Nested Schema : awardBudgets-Attachments-item-response
Type:
Show Source object
- AsyncTrackerId: string Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. - AttachedDocumentId: integer (int64) Title:
Attached Document Id
The unique identifier of the attached document. - CategoryName: string Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
- CreatedBy: string Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. - CreatedByUserName: string Title:
Created By User Name
Read Only:true
The user name who created the record. - CreationDate: string (date-time) Title:
Creation Date
Read Only:true
The date when the record was created. - DatatypeCode: string Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. - Description: string Title:
Description
Maximum Length:255
The description of the attachment. - DmDocumentId: string Maximum Length:
255
The document ID from which the attachment is created. - DmFolderPath: string Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. - DmVersionNumber: string Maximum Length:
255
The document version number from which the attachment is created. - DownloadInfo: string Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. - ErrorStatusCode: string Title:
Error Status Code
The error code, if any, for the attachment. - ErrorStatusMessage: string Title:
Error Status Message
The error message, if any, for the attachment. - ExpirationDate: string (date-time) Title:
Expiration Date
The expiration date of the contents in the attachment. - FileContents: string (byte) Title:
File Contents
The contents of the attachment. - FileName: string Title:
File Name
Maximum Length:2048
The file name of the attachment. - FileUrl: string Title:
File Url
The URI of the file. - FileWebImage: string (byte) Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. - LastUpdateDate: string (date-time) Title:
Last Update Date
Read Only:true
The date when the record was last updated. - LastUpdatedBy: string Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. - LastUpdatedByUserName: string Title:
Last Updated By User
Read Only:true
The user name who last updated the record. - links: array Links Title:
Links
The link relations associated with the resource instance. - PostProcessingAction: string Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. - Title: string Title:
Title
The title of the attachment. - UploadedFileContentType: string Title:
Uploaded File Content Type
The content type of the attachment. - UploadedFileLength: integer Title:
File Size
The size of the attachment file. - UploadedFileName: string Title:
Uploaded File Name
The name to assign to a new attachment file. - UploadedText: string Title:
Uploaded Text
The text content for a new text attachment. - Uri: string Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. - Url: string Title:
Url
Maximum Length:4000
The URL of a web page type attachment. - UserName: string Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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.
Nested Schema : awardBudgets-PlanningOptions-item-response
Type:
Show Source object
- links: array Links Title:
Links
The link relations associated with the resource instance. - PlanningOptionId: integer (int64) Title:
Planning Option ID
Unique identifier of the summary-level planning option in the award budget version. - PlanningOptionsDFF: array Planning Options Descriptive Flexfields Title:
Planning Options Descriptive Flexfields
A listing of all the descriptive flexfields available for planning options in award budget versions.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : Planning Options Descriptive Flexfields
Type:
array
Title:
Planning Options Descriptive Flexfields
A listing of all the descriptive flexfields available for planning options in award budget versions.
Show Source Nested Schema : awardBudgets-PlanningOptions-PlanningOptionsDFF-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 planning options flexfields. - __FLEX_Context_DisplayValue: string Title:
Context Segment
Name of the context for the segments of the planning options flexfields. - links: array Links Title:
Links
The link relations associated with the resource instance. - PlanningOptionId: integer (int64) Unique identifier of the summary-level planning option in the award budget version.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : awardBudgets-PlanningResources-item-response
Type:
Show Source object
- FundingSourceId: integer (int64) Identifier of the funding source used to create the award budget line.
- FundingSourceName: string Title:
Funding Source Name
Maximum Length:360
Funding Source Name used to create the award budget line. - FundingSourceNumber: string Title:
Funding Source Number
Maximum Length:50
Funding Source Number used to create the award budget line. - links: array Links Title:
Links
The link relations associated with the resource instance. - PlanningAmounts: array Planning Amounts Title:
Planning Amounts
The Planning Amounts resource is used to view, create, and delete an award budget line amounts. - PlanningElementId: integer (int64) Title:
Planning Element ID
Identifier of the award budget line. - PlanningEndDate: string (date-time) Title:
Planning Dates: To Date
Award budget line end date. - PlanningStartDate: string (date-time) Title:
Planning Dates: From Date
Award budget line start date. - RbsElementId: integer (int64) Identifier of the resource used to create the award budget line.
- ResourceName: string Title:
Resource Name
Maximum Length:240
The name of the resource used to create the award budget line. - TaskId: integer (int64) Identifier of the task which is used to create a award budget line.
- TaskName: string Title:
Task Name
Maximum Length:255
Name of the task which is used to create a award budget line. - TaskNumber: string Title:
Task Number
Maximum Length:100
Number of the task which is used to create a award budget line. - UnitOfMeasure: string Read Only:
true
The units, such as hours and days, used for measuring the work or effort that is planned for a resource on a budget line.
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, and delete an award budget line amounts.
Show Source Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-item-response
Type:
Show Source object
- BurdenedCostAmounts: number Title:
Burdened Cost
Read Only:true
Award budget line burdened cost amounts in transaction currency. - Currency: string Maximum Length:
15
Currency code for the award budget lines. - EffectiveBurdenedCostRate: number Title:
Burdened Cost: Effective Rate
Read Only:true
Effective burdened cost rate for award budget line. - EffectiveRawCostRate: number Title:
Effective Raw Cost Rate
Read Only:true
Effective raw cost rate for award budget line. - EffectiveRevenueRate: number Title:
Effective Revenue Rate
Read Only:true
Effective revenue rate for award budget line. - links: array Links Title:
Links
The link relations associated with the resource instance. - PCBurdenedCostAmounts: number Title:
Burdened Cost in Project Currency
Read Only:true
Award budget line burdened cost amounts in project currency. - PCRawCostAmounts: number Title:
Raw Cost in Project Currency
Read Only:true
Award budget line raw cost amounts in project currency. - PCRevenueAmounts: number Title:
Revenue in Project Currency
Read Only:true
Award budget line revenue amounts in project currency. - PFCBurdenedCostAmounts: number Title:
Burdened Cost in Project Ledger Currency
Read Only:true
Award budget line burdened cost amounts in project ledger currency. - PFCRawCostAmounts: number Title:
Raw Cost in Project Ledger Currency
Read Only:true
Award budget line raw cost amounts in project ledger currency. - PFCRevenueAmounts: number Title:
Revenue in Project Ledger Currency
Read Only:true
Award budget line revenue amounts in project ledger currency. - PlanLineId: integer (int64) Title:
Plan Line ID
Identifier of the award budget line amounts. - 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 award budgets. - PlanningAmountDetails: array Planning Amount Details Title:
Planning Amount Details
The Planning Amount Details resource is used to view, create, and update an award budget line periodic amounts. - Quantity: number Title:
Quantity
Read Only:true
Measure of the effort planned for the award budget line. - RawCostAmounts: number Title:
Raw Cost
Read Only:true
Award budget line raw cost amounts in transaction currency. - RevenueAmounts: number Title:
Revenue
Read Only:true
Award budget line revenue amounts in transaction currency. - StandardBurdenedCostRate: number Title:
Standard Burdened Cost Rate
Read Only:true
Standard burdened cost rate for award budget line. - StandardRawCostRate: number Title:
Standard Raw Cost Rate
Read Only:true
Standard raw cost rate for award budget line. - StandardRevenueRate: number Title:
Standard Revenue Rate
Read Only:true
Standard revenue rate for award 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 award 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 an award budget line periodic amounts.
Show Source Nested Schema : awardBudgets-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 award budget.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type:
Show Source object
- BurdenedCostAmounts: number Title:
Burdened Cost
Periodic award 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. - PCBurdenedCostAmounts: number Title:
Burdened Cost in Project Currency
Read Only:true
Periodic award budget line burdened cost amounts in project currency. - PCRawCostAmounts: number Title:
Raw Cost in Project Currency
Read Only:true
Periodic award budget line raw cost amounts in project currency. - PCRevenueAmounts: number Title:
Revenue in Project Currency
Read Only:true
Periodic award 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 award budget line burdened cost amounts in project ledger currency. - PFCRawCostAmounts: number Title:
Raw Cost in Project Ledger Currency
Read Only:true
Periodic award budget line raw cost amounts in project ledger currency. - PFCRevenueAmounts: number Title:
Revenue in Project Ledger Currency
Read Only:true
Periodic award budget line revenue amounts in project ledger currency. - PlanLineDetailId: integer (int64) Title:
Plan Line Details ID
Identifier of the award budget periodic amounts. - Quantity: number Title:
Quantity
Measure of the effort planned for the award budget line by period. - RawCostAmounts: number Title:
Raw Cost
Periodic award budget line raw cost amounts in transaction currency. - RevenueAmounts: number Title:
Revenue
Periodic award 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 Nested Schema : awardBudgets-VersionErrors-item-response
Type:
Show Source object
- ErrorType: string Title:
Rejection Type
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 Title:
Cause
Read Only:true
Maximum Length:4000
Explanation for the reason of an error or warning message. - MessageName: string Title:
Message Name
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 Title:
Action
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 Title:
Additional Details
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: number Title:
Plan Version
Read Only:true
Identifier of the project 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. - TransactionCurrencyCode: string Title:
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
- adjustForRangeOfProjects
- Adjusts the award budget version for the range of projects using the adjustment type and adjustment percentage.
- refreshRatesForRangeOfProjects
- Refresh rates for the award budget version for the range of projects from the rate schedules.
- reprocessFailedAwardBudgets
- This action will reprocess all the award budget versions which are showing as failed and bring them back to working state.
Examples
The following example shows how to get all award budgets 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/awardBudgets
Response Body Example
The following shows an example of the response body in JSON format.
"{ ""items"": [ { ""FinancialPlanType"": ""QC Award Cost Budget - Budgetary Control (Approved)"", ""PlanningAmounts"": ""COST"", ""PlanVersionId"": 300100104145060, ""PlanVersionNumber"": 1, ""PlanVersionName"": ""Version 1"", ""PlanVersionDescription"": null, ""PlanVersionStatus"": ""Current and Original Baseline"", ""AwardId"": 300100090708661, ""AwardNumber"": ""PRE_REL13_EXP_A2"", ""AwardName"": ""PRE_REL13_EXP_A2"", ""ProjectId"": 300100104135179, ""ProjectNumber"": ""PRE_REL13_EXP_A2_P1"", ""ProjectName"": ""PRE_REL13_EXP_A2_P1"", ""BudgetCreationMethod"": null, ""SourcePlanVersionId"": null, ""BudgetGenerationSource"": null, ""SourcePlanType"": null, ""SourcePlanVersionStatus"": null, ""SourcePlanVersionNumber"": null, ""CopyAdjustmentPercentage"": null, ""PCRawCostAmounts"": 100000, ""PCBurdenedCostAmounts"": 100000, ""PCRevenueAmounts"": 0, ""PFCRawCostAmounts"": 100000, ""PFCBurdenedCostAmounts"": 100000, ""PFCRevenueAmounts"": 0, ""DeferFinancialPlanCreation"": null, ""AdministrativeCode"": null }, { ""FinancialPlanType"": ""QC Award Cost Budget - Budgetary Control (Approved)"", ""PlanningAmounts"": ""COST"", ""PlanVersionId"": 100100052933323, ""PlanVersionNumber"": 2, ""PlanVersionName"": ""Version 2"", ""PlanVersionDescription"": null, ""PlanVersionStatus"": ""Current Working"", ""AwardId"": 300100090708661, ""AwardNumber"": ""PRE_REL13_EXP_A2"", ""AwardName"": ""PRE_REL13_EXP_A2"", ""ProjectId"": 300100104135179, ""ProjectNumber"": ""PRE_REL13_EXP_A2_P1"", ""ProjectName"": ""PRE_REL13_EXP_A2_P1"", ""BudgetCreationMethod"": null, ""SourcePlanVersionId"": null, ""BudgetGenerationSource"": null, ""SourcePlanType"": null, ""SourcePlanVersionStatus"": null, ""SourcePlanVersionNumber"": null, ""CopyAdjustmentPercentage"": null, ""PCRawCostAmounts"": 100000, ""PCBurdenedCostAmounts"": 100000, ""PCRevenueAmounts"": 0, ""PFCRawCostAmounts"": 100000, ""PFCBurdenedCostAmounts"": 100000, ""PFCRevenueAmounts"": 0, ""DeferFinancialPlanCreation"": null, ""AdministrativeCode"": null } ], ""count"": 2, ""hasMore"": false, ""limit"": 25, ""offset"": 0, ""links"": [ { ""rel"": ""self"", ""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/awardBudgets"", ""name"": ""awardBudgets"", ""kind"": ""collection"" } ] }"