Import control executions using public API
Use the public API call /arcm/api/app/v1/create/controlexecution (POST method) to generate control execution objects in the ARIS Risk and Compliance database. You can use the public API call with any application that has access to the ARIS installation URL.
Specification
URL | /arcm/app/v1/create/:objectType |
Method | POST |
Path parameter | objectType: controlexecution is currently the only supported value |
Data | Structure: {
"environment": "<environment-id in Risk and Compliance database>",
"name": "<name of control-execution to be created>",
"masterObjGuid": “<GUID of control-execution definition>",
"attributes": {
"[attribute-id]": "[attribute value]",
"[attribute-id]": "[attribute value]",
"[attribute-id]": "[attribute value]",
...
}
}
{
"kind": "RESULT",
"request": "/app/create/{objectType}/",
"status": "OK",
"environment": "stse",
"name": "Control trial balance (4-eyes principle) (Control execution)",
"ovid": "44515:2",
"guid": "12947ec0-ac56-11ed-189a-0a0027000005",
"error_message": "",
"info_message": "Object 'Control trial balance (4-eyes principle) (Control execution)' created."
}
|
Success response | Code 200: {
"kind": "RESULT",
"request": "/app/create/{objectType}/",
"status": "OK",
"environment": "stse",
"name": "Control trial balance (4-eyes principle) (Control execution)",
"ovid": "44515:2",
"guid": "12947ec0-ac56-11ed-189a-0a0027000005",
"info_message": "Object 'Control trial balance (4-eyes principle) (Control execution)' created."
}
|
Error response | Code 400: {
"kind": "RESULT",
"request": "/app/create/{objectType}/",
"status": "ILLEGAL_PARAMETER_VALUE",
"error_message": "Target environment 'umg' does not exist. ",
"info_message": ""
}
|
Note | To get a list of all supported attribute IDs, send a request with an empty attribute list. In the error response, all supported attributes are listed under info_message. |