Import Rates (Reconciliation Compliance)

Imports rates for a particular period and rate type, and returns the success or failure status.

REST Resource

POST       /armARCS/rest/{api_version}/jobs

Required Roles

Service Administrator, Power User, User, Viewer

Users with Power User, User, and Viewer predefined roles may require additional application roles.

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request parameters specific to this job.

Table 17-21 IMPORT_RATES

Name	Description	Required
`api_version`	Version of the API you are working with, such as v1	Yes
`jobName`	The name of a job, `IMPORT_RATES`	Yes
`period`	The name of the period, such as `July2016`	Yes
`rateType`	The rate type, such as `Accounting`	Yes
`file`	Name of the import file, such as `rates.csv`	Yes
`importType`	Supported import types are `Replace` and `ReplaceAll`	Yes

Example of request body

{
 "jobName" : "IMPORT_RATES",
 "parameters": {
                             "period":"July2016",
                              "rateType":"Accounting",
                               "file":"rates.csv",
                               "importType":"ReplaceAll"
                              }
}

Response

Supported Media Types: application/json

Parameters:

Table 17-22 Parameters

Name	Description
`details`	In case of errors, details are published with the error string
`status`	See Migration Status Codes
`links`	Detailed information about the link
`href`	Links to API call
`action`	The HTTP call type
`rel`	Relationship type
`data`	Parameters as key value pairs passed in the request

Example of Response Body

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

{
  "type": "ARCS",
  "status": -1,
  "details": "In Process",
  "links": [
    {
      "rel": "self",
      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/armARCS/rest/v1/jobs/2141",
      "action": "GET"
    }
  ]
}