Jump to

• Request
• Response
• Examples

Refresh rates for range of projects

post

/fscmRestApi/resources/11.13.18.05/projectBudgets/action/refreshRatesForRangeOfProjects

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

Request

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

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

Root Schema : schema

Type: object

Show Source

• financialPlanType: string
  The name of the budget 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 budget 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 budget versions.
• 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 budget 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
        },
        "toProjectNumber":{
            "type":"string",
            "description":"The project number at which the range of projects end.",
            "nullable":true
        },
        "planVersionStatus":{
            "type":"string",
            "description":"The status of the budget 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 budget 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

Examples

The following example shows how to refresh rates for range of projects 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/action/refreshRatesForRangeOfProjects" -H 'cache-control: no-cache'

Request Body Example

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

 {

"fromProjectNumber": "project01",

"toProjectNumber": "project20",

"financialPlanType": "Approved Cost Budget",

"planVersionStatus": "Current Working",

"refreshOnlyConversionRates": "N"

}

Response Body Example

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

{

"Result" : "Success"

}

Back to Top