Skip to main content

Get help for ARIS Risk and Compliance

Test public API using swagger UI

Use the Swagger documentation to test the public API.

Prerequisite

  • You have the credentials of a user who has the Risk and Compliance administrator function privilege in ARIS Administration.

  • An environment with a Control execution definition object exists in the ARIS Risk and Compliance database.

    The example in the following procedure requires the umg environment in the ARIS Risk and Compliance database, which contains data from the United Motor Group ARIS database.

Procedure. Procedure

  1. Open ARIS API using https://<ARIS -server-name>/apidocs/.

  2. Click ARIS Risk and Compliance API.

  3. In the section Public application API, click POST /app/v1/create/{objectType}.

  4. To test the creation of control execution objects, click Try it out.

    Example data to test the creation of an endpoint:

    Parameters: Set the objectType path parameter to controlexecution.

    Request body:

    {
"environment": "umg",
"name": "Control trial balance (4-eyes principle)",
"masterObjGuid": "97567081-5bb9-11e5-4b84-0050569d449b",
"attributes": {
"owner_status": "completed",
"items_to_control": "200",
"items_actual_controlled": "180"
}
}

  5. Click Execute to send the request. You are prompted to authenticate.

  6. Enter the credentials of a user with Risk and Compliance administrator function privilege in ARIS Administration, then click Sign in.

The response body and headers are displayed under Execute in the Responses section. If you used the response code 200, a control execution was created in ARIS Risk and Compliance. For information about other response codes, see error_message in the response body.