1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Award Budgets

Create an award budget version

post

/fscmRestApi/resources/11.13.18.05/awardBudgets

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • 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.
  • Award Budget Attachments
    Title: Award Budget Attachments
    The Attachment resource is used to view, create, update, and delete attachments for award budgets.
  • Title: Award Identifier
    Identifier of the award on which the budget is created.
  • Title: Award Name
    Maximum Length: 300
    Name of the award on which the budget is created.
  • Title: Award Number
    Maximum Length: 120
    Number of the award on which the budget is created.
  • Title: Budget Creation Method
    Value of the budget creation method. Valid values are: MANUAL, GENERATE, and COPY.
  • 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.
  • Title: Adjustment Percentage
    Percentage value, either positive or negative, used to adjust the existing values when creating new version values.
  • 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.
  • Title: Financial Plan Type
    Maximum Length: 240
    Name of the financial plan type used to create the award budget version.
  • 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.
  • 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.
  • 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.
  • Planning Resources
    Title: Planning Resources
    The Planning resources is used to view, create, update, and delete an award budget line.
  • Title: Description
    Maximum Length: 2000
    Plan version description for the award budget.
  • Title: Version Name
    Maximum Length: 225
    Plan version name for the award budget.
  • Title: Plan Version Status
    Plan version status for the award budget.
  • Identifier of the project on which the award budget is created.
  • Title: Project Name
    Maximum Length: 240
    Name of the project on which the award budget is created.
  • Title: Project Number
    Maximum Length: 25
    Number of the project on which the award budget is created.
  • Title: Source Plan Type
    Name of the financial plan type to create a budget from an existing budget.
  • 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.
  • Number of the source plan version.
  • Status of the source plan version when creating a budget using a financial project plan. Valid values are: Current Working and Baseline.
  • 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 : 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-post-request
Type: object
Show Source
Nested Schema : awardBudgets-PlanningOptions-item-post-request
Type: object
Show Source
Nested Schema : PlanningOptionsDFF
Type: array
Show Source
Nested Schema : awardBudgets-PlanningOptions-PlanningOptionsDFF-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
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-post-request
Type: object
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-post-request
Type: object
Show Source
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-post-request
Type: object
Show Source
Nested Schema : awardBudgets-VersionErrors-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : awardBudgets-item-response
Type: object
Show Source
  • 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.
  • Award Budget Attachments
    Title: Award Budget Attachments
    The Attachment resource is used to view, create, update, and delete attachments for award budgets.
  • Title: Award Identifier
    Identifier of the award on which the budget is created.
  • Title: Award Name
    Maximum Length: 300
    Name of the award on which the budget is created.
  • Title: Award Number
    Maximum Length: 120
    Number of the award on which the budget is created.
  • Title: Budget Creation Method
    Value of the budget creation method. Valid values are: MANUAL, GENERATE, and COPY.
  • 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.
  • Title: Adjustment Percentage
    Percentage value, either positive or negative, used to adjust the existing values when creating new version values.
  • 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.
  • Title: Financial Plan Type
    Maximum Length: 240
    Name of the financial plan type used to create the award budget version.
  • Links
  • Title: Locked By
    Read Only: true
    Maximum Length: 255
    Name of the user who has locked the award budget version.
  • 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.
  • Title: Burdened Cost in Project Currency
    Read Only: true
    Budget burdened cost amounts in project currency for the award budget version.
  • Title: Raw Cost in Project Currency
    Read Only: true
    Budget raw cost amounts in project currency for the award budget version.
  • Title: Revenue in Project Currency
    Read Only: true
    Budget revenue amounts in project currency for the award budget version.
  • Title: Burdened Cost in Project Ledger Currency
    Read Only: true
    Budget burdened cost amounts in project ledger currency for the award budget version.
  • Title: Raw Cost in Project Ledger Currency
    Read Only: true
    Budget raw cost amounts in project ledger currency for the award budget version.
  • Title: Revenue in Project Ledger Currency
    Read Only: true
    Budget revenue amounts in project ledger currency for the award budget version.
  • 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.
  • Title: Planning Option ID
    Read Only: true
    Unique identifier of the summary-level planning option in the award budget version.
  • 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.
  • Planning Resources
    Title: Planning Resources
    The Planning resources is used to view, create, update, and delete an award budget line.
  • Title: Description
    Maximum Length: 2000
    Plan version description for the award budget.
  • Title: Budget Version ID
    Read Only: true
    Identifier of the award budget version.
  • Title: Version Name
    Maximum Length: 225
    Plan version name for the award budget.
  • Title: Version Number
    Read Only: true
    Plan version number for the award budget.
  • Title: Plan Version Status
    Plan version status for the award budget.
  • Identifier of the project on which the award budget is created.
  • Title: Project Name
    Maximum Length: 240
    Name of the project on which the award budget is created.
  • Title: Project Number
    Maximum Length: 25
    Number of the project on which the award budget is created.
  • 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.
  • Title: Source Plan Type
    Name of the financial plan type to create a budget from an existing budget.
  • 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.
  • Number of the source plan version.
  • Status of the source plan version when creating a budget using a financial project plan. Valid values are: Current Working and Baseline.
  • 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 : 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: object
Show Source
Nested Schema : awardBudgets-PlanningOptions-item-response
Type: object
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: object
Show Source
Nested Schema : awardBudgets-PlanningResources-item-response
Type: object
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: object
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: object
Show Source
Nested Schema : awardBudgets-PlanningResources-PlanningAmounts-PlanningAmountDetails-item-response
Type: object
Show Source
Nested Schema : awardBudgets-VersionErrors-item-response
Type: object
Show Source
  • Title: Rejection Type
    Read Only: true
    Maximum Length: 30
    Specifies whether a warning or error.
  • Links
  • Title: Cause
    Read Only: true
    Maximum Length: 4000
    Explanation for the reason of an error or warning message.
  • Title: Message Name
    Read Only: true
    Maximum Length: 30
    Message code for the issue encountered.
  • 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.
  • 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.
  • Title: Additional Details
    Read Only: true
    Maximum Length: 4000
    More detailed explanation of message text that states why the message occurred.
  • Title: Period
    Read Only: true
    Maximum Length: 30
    Period for which the periodic budget amount is entered.
  • Title: Plan Version
    Read Only: true
    Identifier of the project budget version.
  • Title: Resource
    Read Only: true
    Maximum Length: 240
    The name of the resource used to create the budget line.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    Name of the task which is used to create a budget line.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    Number of the task which is used to create a budget line.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    Currency code for the budget lines.
Links
Attachments
Parameters:
  • PlanVersionId: $request.path.PlanVersionId
The Attachment resource is used to view, create, update, and delete attachments for award budgets.
PlanningOptions
Parameters:
  • PlanVersionId: $request.path.PlanVersionId
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
Parameters:
  • PlanVersionId: $request.path.PlanVersionId
The Planning resources is used to view, create, update, and delete an award budget line.
VersionErrors
Parameters:
  • PlanVersionId: $request.path.PlanVersionId
The Version Errors resource is used to view award budget version and award budget line errors.
adjust
Parameters:
  • PlanVersionId: $request.path.PlanVersionId
Adjusts the award budget version using the adjustment parameters.
refreshRates
Parameters:
  • PlanVersionId: $request.path.PlanVersionId
Refresh rates for the award budget version.
Back to Top

Examples

Example 1

The following example shows how to create an award budget version for an award by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets

Example 1 Request Body

The following example shows the request body to create a new award budget version.

{ "FinancialPlanType": "Award Cost Budget - UnApproved", "PlanVersionName": "Gen from Fin Plan", "PlanVersionDescription": "Gen from Fin Plan", "AwardNumber": "Award_001", "AwardName": "Award_001", "ProjectName": "Award_PRJ1", "BudgetCreationMethod": "GENERATE", "BudgetGenerationSource": "FINANCIAL_PLAN", "SourcePlanType": "Award Cost Budget - Approved", "SourcePlanVersionStatus": "Baseline", "SourcePlanVersionNumber": "1" }

Example 1 Response Body

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

{ "FinancialPlanType" : "Award Cost Budget - Approved", "PlanningAmounts" : "COST", "PlanVersionId" : 300100151626991, "PlanVersionNumber" : 3, "PlanVersionName" : "Award Budget", "PlanVersionDescription" : null, "PlanVersionStatus" : "Current Working", "AwardId" : 300100090708043, "AwardNumber" : "Award_001", "AwardName" : "Award_001", "ProjectId" : 300100095525314, "ProjectNumber" : "Award_PRJ1", "ProjectName" : "Award_PRJ1", "BudgetCreationMethod" : "MANUAL", "SourcePlanVersionId" : null, "BudgetGenerationSource" : null, "SourcePlanType" : null, "SourcePlanVersionStatus" : null, "SourcePlanVersionNumber" : null, "CopyAdjustmentPercentage" : null, "PCRawCostAmounts" : null, "PCBurdenedCostAmounts" : null, "PCRevenueAmounts" : null, "PFCRawCostAmounts" : null, "PFCBurdenedCostAmounts" : null, "PFCRevenueAmounts" : null, "DeferFinancialPlanCreation" : "Y", "AdministrativeCode" : null, "PlanningResources" : [ { "TaskId" : 300100095525318, "TaskNumber" : "Award_PRJ1", "TaskName" : "Award_PRJ1", "RbsElementId" : 300100038787333, "ResourceName" : "Labor", "UnitOfMeasure" : "HOURS", "PlanningStartDate" : "2013-09-01T00:00:00+00:00", "PlanningEndDate" : "2018-11-29T00:00:00+00:00", "FundingSourceId" : 300100038787369, "FundingSourceNumber" : "CDRM_70255", "FundingSourceName" : "Dept of Health and Human Services (DHHS)", "PlanningAmounts" : [ { "Quantity" : null, "Currency" : "USD", "RawCostAmounts" : null, "BurdenedCostAmounts" : null, "RevenueAmounts" : null, "EffectiveRawCostRate" : null, "StG6andardRawCostRate" : null, "EffectiveBurdenedCostRate" : null, "StandardBurdenedCostRate" : null, "EffectiveRevenueRate" : null, "StandardRevenueRate" : null, "PCRawCostAmounts" : null, "PCBurdenedCostAmounts" : null, "PCRevenueAmounts" : null, "PFCRawCostAmounts" : null, "PFCBurdenedCostAmounts" : null, "PFCRevenueAmounts" : null, "PlanningAmountDetails" : [ { "PeriodName" : "P1", "Quantity" : 15, "RawCostAmounts" : null, "BurdenedCostAmounts" : null, "RevenueAmounts" : null, "EffectiveRawCostRate" : null, "StandardRawCostRate" : null, "EffectiveBurdenedCostRate" : null, "StandardBurdenedCostRate" : null, "EffectiveRevenueRate" : null, "StandardRevenueRate" : null, "PCRawCostAmounts" : null, "PCBurdenedCostAmounts" : null, "PCRevenueAmounts" : null, "PFCRawCostAmounts" : null, "PFCBurdenedCostAmounts" : null, "PFCRevenueAmounts" : null, } ]

Example 2

The following example shows how to create award budget versions using a batch operation.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.oracle.adf.batch+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05" -H 'cache-control: no-cache'

Example 2 Request Body

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

 { "parts":[ { "id":"part1", "path":"/awardBudgets", "operation":"create", "payload":{ "FinancialPlanType":"Award Cost Budget - Approved", "PlanVersionName":"Working 1", "PlanVersionStatus":"Working", "PlanVersionDescription":"Working 1", "AwardName": "GMS09_Award Billing (Multi-Award) ", "ProjectId": 300100048824157, "BudgetCreationMethod":"GENERATE", "SourcePlanVersionId":100100036069212 } }, { "id":"part2", "path":"/awardBudgets", "operation":"create", "payload":{ "FinancialPlanType":"Award Cost Budget - Approved", "PlanVersionName":"Working 2", "PlanVersionStatus":"Working", "PlanVersionDescription":"Working 2", "AwardName": "GMS QA Research Award 1", "ProjectId": 300100040184749, "BudgetCreationMethod":"GENERATE", "SourcePlanVersionId":100100036091654 } }, { "id":"part3", "path":"/awardBudgets", "operation":"create", "payload":{ "FinancialPlanType":"Award Cost Budget - Approved", "PlanVersionName":"Working 3", "PlanVersionStatus":"Working", "PlanVersionDescription":"Working 3", "AwardName": "GMS QA Research Award 1", "ProjectId": 300100040184737, "BudgetCreationMethod":"GENERATE", "SourcePlanVersionId":300100048187320 } } ] }

Example 2 Response Body

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

{ "parts": [ { "id": "part1", "path": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets", "operation": "create", "payload": { "FinancialPlanType": "Award Cost Budget - Approved", "PlanningAmounts": "COST", "PlanVersionId": 300100185594119, "PlanVersionNumber": 3, "PlanVersionName": "Working 1", "PlanVersionDescription": "Working 1", "PlanVersionStatus": "Processing", "AwardId": 300100049647877, "AwardNumber": "GMS09_Award_02", "AwardName": "GMS09_Award Billing (Multi-Award) ", "ProjectId": 300100048824157, "ProjectNumber": "GMS09_BILL_PRJ_02", "ProjectName": "GMS09_BILLABLE PROJECT_02", "BudgetCreationMethod": null, "SourcePlanVersionId": null, "BudgetGenerationSource": null, "SourcePlanType": null, "SourcePlanVersionStatus": null, "SourcePlanVersionNumber": null, "LockedFlag": "false", "LockedBy": null, "CopyAdjustmentPercentage": null, "PCRawCostAmounts": null, "PCBurdenedCostAmounts": null, "PCRevenueAmounts": null, "PFCRawCostAmounts": null, "PFCBurdenedCostAmounts": null, "PFCRevenueAmounts": null, "DeferFinancialPlanCreation": null, "AdministrativeCode": null, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594119", "name": "awardBudgets", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594119", "name": "awardBudgets", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594119/lov/ProjectLOVVO", "name": "ProjectLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594119/lov/BudgetGenerationSourceLOVVO", "name": "BudgetGenerationSourceLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594119/lov/FinancialPlanTypesLOVVO", "name": "FinancialPlanTypesLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594119/lov/ProjectAwardLOVVO", "name": "ProjectAwardLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594119/lov/BudgetCreationMethodLOVVO", "name": "BudgetCreationMethodLOVVO", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594119/child/PlanningResources", "name": "PlanningResources", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594119/child/VersionErrors", "name": "VersionErrors", "kind": "collection" } ], } }, { "id": "part2", "path": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets", "operation": "create", "payload": { "FinancialPlanType": "Award Cost Budget - Approved", "PlanningAmounts": "COST", "PlanVersionId": 300100185594120, "PlanVersionNumber": 3, "PlanVersionName": "Working 2", "PlanVersionDescription": "Working 2", "PlanVersionStatus": "Processing", "AwardId": 300100048085665, "AwardNumber": "GMS_QA_RES_A1", "AwardName": "GMS QA Research Award 1", "ProjectId": 300100040184749, "ProjectNumber": "GMS_QA_INT_RES_SP_P2", "ProjectName": "GMS QA Int Res Spons Project2", "BudgetCreationMethod": null, "SourcePlanVersionId": null, "BudgetGenerationSource": null, "SourcePlanType": null, "SourcePlanVersionStatus": null, "SourcePlanVersionNumber": null, "LockedFlag": "false", "LockedBy": null, "CopyAdjustmentPercentage": null, "PCRawCostAmounts": null, "PCBurdenedCostAmounts": null, "PCRevenueAmounts": null, "PFCRawCostAmounts": null, "PFCBurdenedCostAmounts": null, "PFCRevenueAmounts": null, "DeferFinancialPlanCreation": null, "AdministrativeCode": null, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594120", "name": "awardBudgets", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594120", "name": "awardBudgets", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594120/lov/ProjectLOVVO", "name": "ProjectLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594120/lov/BudgetGenerationSourceLOVVO", "name": "BudgetGenerationSourceLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594120/lov/FinancialPlanTypesLOVVO", "name": "FinancialPlanTypesLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594120/lov/ProjectAwardLOVVO", "name": "ProjectAwardLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594120/lov/BudgetCreationMethodLOVVO", "name": "BudgetCreationMethodLOVVO", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594120/child/PlanningResources", "name": "PlanningResources", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594120/child/VersionErrors", "name": "VersionErrors", "kind": "collection" } ], } }, { "id": "part3", "path": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets", "operation": "create", "payload": { "FinancialPlanType": "Award Cost Budget - Approved", "PlanningAmounts": "COST", "PlanVersionId": 300100185594121, "PlanVersionNumber": 3, "PlanVersionName": "Working 3", "PlanVersionDescription": "Working 3", "PlanVersionStatus": "Processing", "AwardId": 300100048085665, "AwardNumber": "GMS_QA_RES_A1", "AwardName": "GMS QA Research Award 1", "ProjectId": 300100040184737, "ProjectNumber": "GMS_QA_EXT_RES_SP_P1", "ProjectName": "GMS QA Ext Res Spons Project1", "BudgetCreationMethod": null, "SourcePlanVersionId": null, "BudgetGenerationSource": null, "SourcePlanType": null, "SourcePlanVersionStatus": null, "SourcePlanVersionNumber": null, "LockedFlag": "false", "LockedBy": null, "CopyAdjustmentPercentage": null, "PCRawCostAmounts": null, "PCBurdenedCostAmounts": null, "PCRevenueAmounts": null, "PFCRawCostAmounts": null, "PFCBurdenedCostAmounts": null, "PFCRevenueAmounts": null, "DeferFinancialPlanCreation": null, "AdministrativeCode": null, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594121", "name": "awardBudgets", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594121", "name": "awardBudgets", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594121/lov/ProjectLOVVO", "name": "ProjectLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594121/lov/BudgetGenerationSourceLOVVO", "name": "BudgetGenerationSourceLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594121/lov/FinancialPlanTypesLOVVO", "name": "FinancialPlanTypesLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594121/lov/ProjectAwardLOVVO", "name": "ProjectAwardLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594121/lov/BudgetCreationMethodLOVVO", "name": "BudgetCreationMethodLOVVO", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594121/child/PlanningResources", "name": "PlanningResources", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594121/child/VersionErrors", "name": "VersionErrors", "kind": "collection" } ], } } ], }

Example 3

The following example shows how to create award budget versions with resources using a batch operation.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.oracle.adf.batch+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05" -H 'cache-control: no-cache'

Example 3 Request Body

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

{ "parts":[ { "id":"part1", "path":"/awardBudgets", "operation":"create", "payload":{ "FinancialPlanType":"QC Award Cost Budget - Budgetary Control (Approved)", "PlanVersionName":"Working 1", "PlanVersionStatus":"Working", "PlanVersionDescription":"Working 1", "AwardName": "PRE_REL13_RES_A2", "ProjectId": 300100101030536, "BudgetCreationMethod":"MANUAL", "PlanningResources":[ { "TaskNumber":"PRE_REL13_RES_A2_P1", "ResourceName":"Chargebacks", "FundingSourceName": "Dept of Health and Human Services (DHHS)", "PlanningAmounts":[ { "Currency":"USD", "PlanningAmountDetails":[ { "PeriodName":"YrStartOct-14", "Quantity":100 } ] } ] } ] } } ] }

Example 3 Response Body

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

{ "parts": [ { "id": "part1", "path": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets", "operation": "create", "payload": { "FinancialPlanType": "QC Award Cost Budget - Budgetary Control (Approved)", "PlanningAmounts": "COST", "PlanVersionId": 300100185594131, "PlanVersionNumber": 3, "PlanVersionName": "Working 1", "PlanVersionDescription": "Working 1", "PlanVersionStatus": "Processing", "AwardId": 300100090708713, "AwardNumber": "PRE_REL13_RES_A2", "AwardName": "PRE_REL13_RES_A2", "ProjectId": 300100101030536, "ProjectNumber": "PRE_REL13_RES_A2_P1", "ProjectName": "PRE_REL13_RES_A2_P1", "BudgetCreationMethod": null, "SourcePlanVersionId": null, "BudgetGenerationSource": null, "SourcePlanType": null, "SourcePlanVersionStatus": null, "SourcePlanVersionNumber": null, "LockedFlag": "false", "LockedBy": null, "CopyAdjustmentPercentage": null, "PCRawCostAmounts": null, "PCBurdenedCostAmounts": null, "PCRevenueAmounts": null, "PFCRawCostAmounts": null, "PFCBurdenedCostAmounts": null, "PFCRevenueAmounts": null, "DeferFinancialPlanCreation": null, "AdministrativeCode": null, "PlanningResources": { "items": [ { "PlanningElementId": 300100185594132, "TaskId": 300100101030540, "TaskNumber": "PRE_REL13_RES_A2_P1", "TaskName": "PRE_REL13_RES_A2_P1", "RbsElementId": 300100038787348, "ResourceName": "Chargebacks", "UnitOfMeasure": "HOURS", "PlanningStartDate": "2013-10-01T00:00:00+00:00", "PlanningEndDate": "2018-10-30T00:00:00+00:00", "FundingSourceId": 300100038787369, "FundingSourceNumber": "CDRM_70255", "FundingSourceName": "Dept of Health and Human Services (DHHS)", "PlanningAmounts": { "items": [ { "PlanLineId": 300100185594133, "Quantity": null, "Currency": "USD", "RawCostAmounts": null, "BurdenedCostAmounts": null, "RevenueAmounts": null, "EffectiveRawCostRate": null, "StandardRawCostRate": null, "EffectiveBurdenedCostRate": null, "StandardBurdenedCostRate": null, "EffectiveRevenueRate": null, "StandardRevenueRate": null, "PCRawCostAmounts": null, "PCBurdenedCostAmounts": null, "PCRevenueAmounts": null, "PFCRawCostAmounts": null, "PFCBurdenedCostAmounts": null, "PFCRevenueAmounts": null, "PlanningAmountDetails": { "items": [ { "PlanLineDetailId": 300100185594134, "PeriodName": "YrStartOct-14", "Quantity": 100, "RawCostAmounts": null, "BurdenedCostAmounts": null, "RevenueAmounts": null, "EffectiveRawCostRate": null, "StandardRawCostRate": null, "EffectiveBurdenedCostRate": null, "StandardBurdenedCostRate": null, "EffectiveRevenueRate": null, "StandardRevenueRate": null, "PCRawCostAmounts": null, "PCBurdenedCostAmounts": null, "PCRevenueAmounts": null, "PFCRawCostAmounts": null, "PFCBurdenedCostAmounts": null, "PFCRevenueAmounts": null, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts/300100185594133/child/PlanningAmountDetails/300100185594134", "name": "PlanningAmountDetails", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts/300100185594133/child/PlanningAmountDetails/300100185594134", "name": "PlanningAmountDetails", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts/300100185594133", "name": "PlanningAmounts", "kind": "item" } ], } ], "count": 1, "hasMore": false, "limit": 24, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts/300100185594133/child/PlanningAmountDetails", "name": "PlanningAmountDetails", "kind": "collection" } ], }, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts/300100185594133", "name": "PlanningAmounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts/300100185594133", "name": "PlanningAmounts", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132", "name": "PlanningResources", "kind": "item" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts/300100185594133/child/PlanLinesDFF", "name": "PlanLinesDFF", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts/300100185594133/child/PlanningAmountDetails", "name": "PlanningAmountDetails", "kind": "collection" } ], } ], "count": 1, "hasMore": false, "limit": 24, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts", "name": "PlanningAmounts", "kind": "collection" } ], }, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132", "name": "PlanningResources", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132", "name": "PlanningResources", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131", "name": "awardBudgets", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/lov/PrimaryPlanningRBSLOVVO", "name": "PrimaryPlanningRBSLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/lov/FinancialTaskVersionLOVVO", "name": "FinancialTaskVersionLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/lov/ProjectAwardFundingSourceLOVVO", "name": "ProjectAwardFundingSourceLOVVO", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources/300100185594132/child/PlanningAmounts", "name": "PlanningAmounts", "kind": "collection" } ], } ], "count": 1, "hasMore": false, "limit": 24, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources", "name": "PlanningResources", "kind": "collection" } ], }, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131", "name": "awardBudgets", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131", "name": "awardBudgets", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/lov/ProjectLOVVO", "name": "ProjectLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/lov/BudgetGenerationSourceLOVVO", "name": "BudgetGenerationSourceLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/lov/FinancialPlanTypesLOVVO", "name": "FinancialPlanTypesLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/lov/ProjectAwardLOVVO", "name": "ProjectAwardLOVVO", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/lov/BudgetCreationMethodLOVVO", "name": "BudgetCreationMethodLOVVO", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/PlanningResources", "name": "PlanningResources", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/300100185594131/child/VersionErrors", "name": "VersionErrors", "kind": "collection" } ], } } ], }
Back to Top