Change Period Status (Reconciliation Compliance)
Changes the status of a period (open, closed, pending, locked) and returns the success or failure status.
When a period's status is changed to Open, the returned job corresponds to the opening of reconciliations for the specified period. The job's success or failure does not impact the period's status because this change is made immediately. Even if there are failures while reopening reconciliations, the period status still remains Open.
If a period's status is set to Closed or Locked, no job is returned.
REST Resource
POST /armARCS/rest/{api_version}/jobs
Required Roles
Service Administrator or Periods - Manage
Request
Supported Media Types: application/json
Parameters
The following table summarizes the client request parameters specific to this job.
Table 17-9 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 17-10 Parameters
Name | Description |
---|---|
details |
In case of errors, details are published with the error string |
status |
See Migration Status Codes. When the period's status is changed to Open, the status of the job that opens reconciliations for the specified period is sent as additional information. Use this additional information to check the status of the open reconciliations job. |
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"
}
]
}