Changes to the External API in version 9.10.0

External API Changes

Reference Document based on the Previous Version (9.9.5):

OpenAPI Specification JSON Reference Document

external_9_9_5.json

Deleted External API

Approval Rule API
- Create
- Update

Added External API

Workflow API (Here are the updated Workflow API endpoints, which replace the previous Access Approval API and Approval API)
- [Access Request| Detail
- [Access Request] Approve
- [Access Request] Reject
- [Export Request] Detail
- [Export Request] Approve
- [Export Request] Reject
- [SQL Request] Detail
- [SQL Request] Approve
- [SQL Request] Reject
- All Requests
Approval Rule API V2 (Replaces the Existing Approval Rule API)
- List
- Add approval rule
- Remove approval rule
- Detail
- Edit approval rule

Changed External API

Access Approval API
- List of Access Approval
Approval Rule API
- Detail
Approval API
- List of Approval

Access Approval API - List of Access Approval

GET /api/external/access-approvals

Modified Request
- The status parameter that can be used as a query parameter has changed. "PARTIALLY_APPROVED" has been replaced by "IN_PROGRESS", and "NONE" has been removed.
  - before : "NONE" "PENDING" "CANCELED" "REJECTED" "PARTIALLY_APPROVED" "APPROVED" "EXPIRED"
  - after : "PENDING" "CANCELED" "REJECTED" "IN_PROGRESS" "APPROVED" "EXPIRED"
Changes in Response

Before

After

CODE

{
  "list": [
    {
      "approvalStatus": "PENDING",
      "connections": [
        {
          "clusterGroupDescription": "Cluster Group description",
          "clusterGroupName": "Cluster Group Name",
          "clusterGroupUuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3",
          "clusterHost": "Cluster Host",
          "clusterReplicationType": "`MASTER`, `SLAVE`, `SINGLE`",
          "clusterUuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3",
          "databaseName": "Database Name",
          "roleName": "Role Name",
          "roleUuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3",
          "schemaName": "Schema Name",
          "uuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdUser": "User Information",
      "currentDegree": 1,
      "description": "Approval Description",
      "id": 0,
      "lines": [
        {
          "approvedAt": "2019-08-24T14:15:22Z",
          "comment": "comment",
          "degree": 1,
          "status": "APPROVED",
          "type": "APPROVER",
          "userDepartment": "string",
          "userEmail": "string",
          "userLoginId": "string",
          "userName": "string",
          "userType": "USER",
          "userUuid": "string",
          "uuid": "UUID"
        }
      ],
      "title": "Approval Title",
      "type": "ACCESS",
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedUser": "User Information",
      "uuid": "UUID"
    }
  ],
  "page": {
    "currentPage": 0,
    "pageSize": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}

CODE

{
  "list": [
    {
      "approvalStatus": "PENDING",
      "connections": [
        {
          "clusterGroupName": "Cluster Group Name",
          "clusterGroupUuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3",
          "clusterHost": "Cluster Host",
          "clusterReplicationType": "`MASTER`, `SLAVE`, `SINGLE`",
          "clusterUuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3",
          "roleName": "Role Name",
          "roleUuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3",
          "uuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdUser": "User Information",
      "description": "Approval Description",
      "id": 0,
      "lines": [
        {
          "actionAt": "2019-08-24T14:15:22Z",
          "comment": "comment",
          "status": "APPROVED",
          "step": 1,
          "type": "APPROVER",
          "userDepartment": "string",
          "userEmail": "string",
          "userLoginId": "string",
          "userName": "string",
          "userType": "USER",
          "userUuid": "string"
        }
      ],
      "title": "Approval Title",
      "type": "ACCESS",
      "updatedAt": "2019-08-24T14:15:22Z",
      "uuid": "UUID"
    }
  ],
  "page": {
    "currentPage": 0,
    "pageSize": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}

The currentDegree field has been removed.
The approvalStatus field has been updated:
- before : "NONE" "PENDING" "CANCELED" "REJECTED" "PARTIALLY_APPROVED" "APPROVED" "EXPIRED"
- after : "PENDING" "CANCELED" "REJECTED" "IN_PROGRESS" "APPROVED" "EXPIRED"
The updatedUser field has been removed.
The uuid field under lines has been removed.
The degree field under lines has been replaced by step.
The approvedAt field under lines has been replaced by actionAt.
The status field under lines has been updated:
- before : "PENDING" "REQUESTED" "CANCELED" "APPROVED" "REJECTED" "SQL_EXECUTED" "SQL_CANCELED" "SQL_SUCCEED" "SQL_FAILED" "CONFIRMED"
- after : "NONE" "PENDING" "CANCELED" "APPROVED" "REJECTED" "EXECUTED" "UNREAD" "CONFIRMED"
The type field under lines has been updated:
- before : "REPORTER" "APPROVER" "EXECUTOR" "REFERRER" "REVIEWER"
- after : "APPROVER" "EXECUTOR" "REVIEWER"
The clusterGroupDescription field under connections has been removed.
The databaseName field under connections has been removed.
The schemaName field under connections has been removed.

Approval Rule API - Detail

GET /api/external/approval-rules/{uuid}

Changes in Response

Before

After

CODE

{
  "approvalCondition": "MANUAL",
  "createdAt": "2019-08-24T14:15:22Z",
  "executionCondition": "MANUAL",
  "lines": [
    {
      "degree": 1,
      "resourceType": "USER",
      "resourceUuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3",
      "type": "APPROVER",
      "uuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3"
    }
  ],
  "name": "Default Rule",
  "requestType": "SQL",
  "reviewEnabled": true,
  "updatedAt": "2019-08-24T14:15:22Z",
  "uuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3"
}

CODE

{
  "createdAt": "2019-08-24T14:15:22Z",
  "executionCondition": "ADMIN_ONLY",
  "lines": [
    {
      "resourceType": "USER",
      "resourceUuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3",
      "step": 1,
      "type": "APPROVER"
    }
  ],
  "name": "Default Rule",
  "requestType": "SQL",
  "updatedAt": "2019-08-24T14:15:22Z",
  "urgentMode": true,
  "uuid": "63d2cc6d-dd83-4a31-a817-fc13f1fc57a3"
}

The approvalCondition field has been removed.
The executionCondition field has been updated:
- before : "NONE" "MANUAL" "SELF" "CONNECTION_OWNER" "ANY"
- after : "ADMIN_ONLY" "ALL_USERS" "FIXED" "CONNECTION_OWNER"
The reviewEnabled field has been removed.
The urgentMode field has been added.
The degree field under lines has been replaced by step.
The type field under lines has been updated:
- before : "REPORTER" "APPROVER" "EXECUTOR" "REFERRER" "REVIEWER"
- after : "APPROVER" "EXECUTOR" "REVIEWER"
The resourceType field under lines has been updated:
- before : USER, ROLE
- after : USER, GROUP
The uuid field under lines has been removed.

Approval API - List of Approval

GET /api/external/approvals

Before

After

CODE

{
  "list": [
    {
      "approvalStatus": "PENDING",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdUser": "User Information",
      "currentDegree": 1,
      "description": "Approval Description",
      "id": 0,
      "lines": [
        {
          "approvedAt": "2019-08-24T14:15:22Z",
          "comment": "comment",
          "degree": 1,
          "status": "APPROVED",
          "type": "APPROVER",
          "userDepartment": "string",
          "userEmail": "string",
          "userLoginId": "string",
          "userName": "string",
          "userType": "USER",
          "userUuid": "string",
          "uuid": "UUID"
        }
      ],
      "title": "Approval Title",
      "type": "ACCESS",
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedUser": "User Information",
      "uuid": "UUID"
    }
  ],
  "page": {
    "currentPage": 0,
    "pageSize": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}

CODE

{
  "list": [
    {
      "approvalStatus": "PENDING",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdUser": "User Information",
      "description": "Approval Description",
      "id": 0,
      "lines": [
        {
          "actionAt": "2019-08-24T14:15:22Z",
          "comment": "comment",
          "status": "APPROVED",
          "step": 1,
          "type": "APPROVER",
          "userDepartment": "string",
          "userEmail": "string",
          "userLoginId": "string",
          "userName": "string",
          "userType": "USER",
          "userUuid": "string"
        }
      ],
      "title": "Approval Title",
      "type": "ACCESS",
      "updatedAt": "2019-08-24T14:15:22Z",
      "uuid": "UUID"
    }
  ],
  "page": {
    "currentPage": 0,
    "pageSize": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}

currentDegree has been removed.
approvalStatus has been changed:
- before : "NONE" "PENDING" "CANCELED" "REJECTED" "PARTIALLY_APPROVED" "APPROVED" "EXPIRED"
- after : "PENDING" "CANCELED" "REJECTED" "IN_PROGRESS" "APPROVED" "EXPIRED"
updatedUser has been removed.
uuid under lines has been removed.
degree under lines has been replaced by step.
approvedAt under lines has been replaced by actionAt.
status under lines has been changed:
- before : "PENDING" "REQUESTED" "CANCELED" "APPROVED" "REJECTED" "SQL_EXECUTED" "SQL_CANCELED" "SQL_SUCCEED" "SQL_FAILED" "CONFIRMED"
- after : "NONE" "PENDING" "CANCELED" "APPROVED" "REJECTED" "EXECUTED" "UNREAD" "CONFIRMED"
type under lines has been updated:
- before : "REPORTER" "APPROVER" "EXECUTOR" "REFERRER" "REVIEWER"
- after : "APPROVER" "EXECUTOR" "REVIEWER"