Jump to

• Request
• Response

Adjust the forecast version

post

/fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/action/adjust

Adjusts the project forecast version using the adjustment parameters.

Request

Path Parameters

• PlanVersionId(required): integer(int64)
  Identifier of the forecast version.

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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• adjustmentPercentage: number
  The percentage of adjustment to be made to the existing forecast version.
• adjustmentType: string
  The value to be adjusted in the project forecast 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 forecast version is adjusted.
• toPeriod: string
  The period name up to which the forecast version is adjusted.

{ "type":"object", "properties":{ "adjustmentPercentage":{ "type":"number", "description":"The percentage of adjustment to be made to the existing forecast version.", "nullable":true }, "fromPeriod":{ "type":"string", "description":"The period name from which the forecast version is adjusted.", "nullable":true }, "adjustmentType":{ "type":"string", "description":"The value to be adjusted in the project forecast versions.", "nullable":true }, "toPeriod":{ "type":"string", "description":"The period name up to which the forecast version is adjusted.", "nullable":true }, "createNewWorkingVersion":{ "type":"string", "description":"Indicates whether to create a working version and then adjust. Valid values are Y and N.", "nullable":true } }, "additionalProperties":false }

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Indicates if the forecast version is adjusted successfully.

{ "required":[ "result" ], "type":"object", "properties":{ "result":{ "type":"string", "description":"Indicates if the forecast version is adjusted successfully." } }, "additionalProperties":false }

Back to Top