Change Period Status (Reconciliation Compliance)

Changes the status of a period (open, closed, pending, locked) and returns the success or failure status.

REST Resource

POST       /armARCS/rest/{api_version}/jobs

Request

Supported Media Types: application/json

Parameters

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

Table 11-7 SET PERIOD STATUS

Name Description Required
api_version Version of the API you are working with, such as v1 Yes
jobName The name of a job, SET_PERIOD_STATUS Yes
period The name of the period, such as July2016 Yes
status Status to be changed; supported values: pending, open, closed, locked Yes

Example of request body

{
 "jobName" : "SET_PERIOD_STATUS",
 "parameters": {
                              "period":"July2016",
                              "status":"closed"
                              }
}

Response

Supported Media Types: application/json

Parameters:

Table 11-8 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 or status API
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"
    }
  ],
  "error": null,
  "items": null,
  "link": null
}