Import Reconciliation Attributes (Reconciliation Compliance)

Performs flat file loads of attribute values into existing reconciliations.

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-29 Import Reconciliation Attributes

Name Description Required
api_version Version of the API you are working with, such as v1 Yes
jobName The name of a job, IMPORT_RECONCILIATION_ATTRIBUTES Yes
fileName The name of the upload import file Yes
period The name of the period, such as July2020 Yes
rules The rules to run upon completion. Allowed values are:
  • ALL
  • SET_ATTR_VAL(Set Attribute Value)
  • CRT_ALT (Create Alert)
  • AUTO_APP(Auto Approve Reconciliation)
  • AUTO_SUB(Auto Submit Reconciliation)
You can send multiple values separated by comma. Default is None.
No
reopen Indicates whether to reopen changed reconciliations upon completion. Values is either true or false (default). No
dateFormat List of valid date formats, such asDD/MM/YYYY. You can send multiple values separated by semi-colon. No

Here are some examples of the request body:

Example 1


{
    "jobName" : "IMPORT_RECONCILIATION_ATTRIBUTES",
    "parameters": 
        {
         "fileName":"import_recon.csv",
         "period":"January 2010",        
         "rules":"AUTO_APP,AUTO_SUB",
         "reopen":"true",
         "dateformat":"MM-dd-yyyy;MMM d, yyyy"
        }
}

Example 2

{
    "jobName" : "IMPORT_RECONCILIATION_ATTRIBUTES",
    "parameters": 
        {
         "fileName":"Reconciliations.csv",
         "period":"June 2019",        
         "rules":"AUTO_APP,AUTO_SUB",
         "reopen":"true"
        }
}

Example 3

{
    "jobName" : "IMPORT_RECONCILIATION_ATTRIBUTES",
    "parameters": 
        {
         "fileName":"import_recon.csv",
         "period":"January 2010",        
         "rules":"ALL",
         "reopen":"true"
        }
}

Example 4

{
    "jobName" : "IMPORT_RECONCILIATION_ATTRIBUTES",
    "parameters": 
        {
         "fileName":"Reconciliations.csv",
         "period":"June 2019"
        }
}

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
  • -1 = In Progress
  • 0 = Success
  • 1 = Fail
links Detailed information about the link
href Links to API call or status API
action The HTTP call type
rel Relationship type. Can be self and/or Job Status. If set to Job Status, you can use the href to get the status of the import operation.

Example of Response Body

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

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