Jump to

• Request
• Response

Refresh rates for range of projects

post

/fscmRestApi/resources/11.13.18.05/projectForecasts/action/refreshRatesForRangeOfProjects

Refresh rates for the project forecast version for the range of projects from the rate schedules.

Request

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

• financialPlanType: string
  The name of the forecast financial plan type that is used to filter the version. If it's not specified, then all the financial plan types are used.
• fromProjectNumber: string
  The project number from which the range of projects start.
• planVersionStatus: string
  The status of the forecast version that is used to filter. Valid values are Current Working and Working.
• refreshOnlyConversionRates: string
  Indicates if only conversion rates are refreshed for the filtered versions. Valid values are Y and N.
• refreshRatesPeriodForward: string
  The period from which the rates are refreshed for the forecast versions.
• 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.
• toProjectNumber: string
  The project number at which the range of projects end.

{
    "type":"object",
    "properties":{
        "fromProjectNumber":{
            "type":"string",
            "description":"The project number from which the range of projects start.",
            "nullable":true
        },
        "financialPlanType":{
            "type":"string",
            "description":"The name of the forecast financial plan type that is used to filter the version. If it's not specified, then all the financial plan types are used.",
            "nullable":true
        },
        "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
        },
        "toProjectNumber":{
            "type":"string",
            "description":"The project number at which the range of projects end.",
            "nullable":true
        },
        "planVersionStatus":{
            "type":"string",
            "description":"The status of the forecast version that is used to filter. Valid values are Current Working and Working.",
            "nullable":true
        },
        "refreshOnlyConversionRates":{
            "type":"string",
            "description":"Indicates if only conversion rates are refreshed for the filtered versions. Valid values are Y and N.",
            "nullable":true
        },
        "refreshRatesPeriodForward":{
            "type":"string",
            "description":"The period from which the rates are refreshed for the forecast versions.",
            "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): object result
  Additional Properties Allowed: additionalProperties

  Indicates if the Enterprise Scheduling Service process is submitted successfully.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Indicates if the Enterprise Scheduling Service process is submitted successfully."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Indicates if the Enterprise Scheduling Service process is submitted successfully."
}

Indicates if the Enterprise Scheduling Service process is submitted successfully.

Back to Top