Adjust the budget version
post
/fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/action/adjust
Adjusts the project budget version using the adjustment parameters.
Request
Path Parameters
-
PlanVersionId(required): integer(int64)
Identifier of the project budget version.
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.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
adjustmentPercentage: number
The percentage of adjustment to be made to the existing budget version.
-
adjustmentType: string
The value to be adjusted in the project budget versions.
-
createNewWorkingVersion: string
Indicates whether to create a working version and then adjust. Valid values are Y and N.
-
fromPeriod: string
The period name from which the budget version is adjusted.
-
toPeriod: string
The period name up to which the budget version is adjusted.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): string
Indicates if the budget version is adjusted successfully.
Examples
The following example shows how to adjust the budget version by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.oracle.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBudgets/<PlanVersionId>/action/adjust" -H 'cache-control: no-cache'
Request Body Example
The following shows an example of the request body in JSON format.
{ "adjustmentType" : "Quantity", "adjustmentPercentage" : 5, "createNewWorkingVersion" : "Y", "fromPeriod" : "Jan-19", "toPeriod" : "Dec-19" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "Result" : "Success" }