Jump to

• Request
• Response

Refresh rates for the forecast version

post

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

Refresh rates for the project forecast version.

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

• refreshOnlyConversionRates: string
  Indicates if only conversion rates are refreshed for the forecast version. Valid values are Y and N.
• refreshRatesPeriodForward: string
  The period from which the rates are refreshed for the forecast version.
• retainRateOverride: string
  Indicates if user-specified rates should be preserved during a rates refresh. Valid values are Y and N. When set to Y, the application retains manually entered rates and skips updating them during a refresh. If nothing is specified, the application treats it as N, and user-specified rates are preserved.

{
    "type":"object",
    "properties":{
        "retainRateOverride":{
            "type":"string",
            "description":"Indicates if user-specified rates should be preserved during a rates refresh. Valid values are Y and N. When set to Y, the application retains manually entered rates and skips updating them during a refresh. If nothing is specified, the application treats it as N, and user-specified rates are preserved.",
            "nullable":true
        },
        "refreshOnlyConversionRates":{
            "type":"string",
            "description":"Indicates if only conversion rates are refreshed for the forecast version. Valid values are Y and N.",
            "nullable":true
        },
        "refreshRatesPeriodForward":{
            "type":"string",
            "description":"The period from which the rates are refreshed for the forecast version.",
            "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 rates are refreshed successfully.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Indicates if the rates are refreshed successfully."
        }
    },
    "additionalProperties":false
}

Back to Top