Monitor Reconciliations (Reconciliation Compliance)
Returns the list of reconciliations for a given period name and filter name.
Note:
-
If the Reconciliation status for all the Reconciliations in the given Period Name and Filter Name were closed, then the output status would be ‘0’.
-
If the Reconciliations status for any one of the Reconciliations in the given Period Name and Filter Name is open, then the output status would be ‘-1’.
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.
Table 17-29 MONITOR_RECONCILIATIONS
Name | Description | Path | Required |
---|---|---|---|
api_version |
Version of the API you are working with, such as v1 | Yes | Yes |
jobName |
The name of the job, MONITOR_RECONCILIATIONS |
No | Yes |
periodName |
The name of the period, such as September 2017 | No | Yes |
filterName |
The name of the filter. For example, Recon status filter .
|
No | Yes |
Example of request body
{
"parameters":
{"periodName":"September 2017","filterName":"DemoFilter"},
"jobName":"MONITOR_RECONCILIATIONS"
}
Response
Supported Media Types: application/json
Parameters:
Table 17-30 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 the API call |
action |
The HTTP call type |
rel |
Relationship type (self , Job Status ). if set to Job Status , you can use the href to get the status of the operation
|
data |
Parameters as key value pairs passed in the request |
Examples of Response Body
The following is an example of the response body in JSON format when all reconciliations are closed:
{
"error":null,
"details":"Account ID : 100-1210, Name : Accounts Receivable, Status : Closed",
"items":null,
"status":0,
"link":null,
"links":[{"action":"GET","rel":"self","href":"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/armARCS/rest/v1/jobs/monitorReconciliations/September%202017/DemoFilter"}],
"type":"ARCS"
}
The following is an example of the response body in JSON format when any reconciliation status is open:
{
"error":null,
"details":"Account ID : 100-1210, Name : Accounts Receivable, Status : Open",
"items":null,
"status":-1,
"link":null,
"links":[{"action":"GET","rel":"self","href":"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/armARCS/rest/v1/jobs/monitorReconciliations/September%202017/DemoFilter"}],
"type":"ARCS"
}