Response examples

Authorization response

{
  "message": "Success",
  "timestamp": "2023-06-13T08:11:59.270084506Z",
  "data": {
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ0YlNqUzZ1RkU5TkZWemZadEJKV2YtcnF0M0dOLVU0dDdZdnRwRjZmYUVvIn0.eyJleHAiOjE2ODY2Nzk5MTksImlhdCI6MTY4NjY0MzkxOSwianRpIjoiMzgyNzRhMDEtNzYyNS00ZDJjLTgyYWYtNWUxZmE4NGU4OTUxIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo5OTkwL3JlYWxtcy9haS1yZWFsbSIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI2ZmM3M2I3OS0yZWNhLTQzNTQtOTY0Ni1lNjBjNDViNTM4YjciLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJhaS1jbGllbnQiLCJzZXNzaW9uX3N0YXRlIjoiMzRkY2ZlNDUtZTRlNS00NDM2LWI1ZTktMzFhNDFkY2ZiNDYyIiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyIvKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiZGVmYXVsdC1yb2xlcy1haS1yZWFsbSIsIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhaS1jbGllbnQiOnsicm9sZXMiOlsic2VjdXJpdHkucm9sZWdyb3VwLmRlbGV0ZSIsInNlY3VyaXR5LnVzZXIuY3JlYXRlIiwic2VjdXJpdHkudXNlci51cGRhdGUiLCJzZWN1cml0eS51c2VyLmRlbGV0ZSIsInNlY3VyaXR5LnJvbGVncm91cC5jcmVhdGUiLCJkb2N1bWVudC5kZWxldGUiLCJkb2N1bWVudC5jcmVhdGUiLCJkb2N1bWVudC5yZWFkIiwiZG9jdW1lbnQudXBkYXRlIiwic2VjdXJpdHkudXNlci5yZWFkIiwic2VjdXJpdHkucm9sZWdyb3VwLnJlYWQiXX0sImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsInNpZCI6IjM0ZGNmZTQ1LWU0ZTUtNDQzNi1iNWU5LTMxYTQxZGNmYjQ2MiIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJlZmVycmVkX3VzZXJuYW1lIjoiZGF2aWQiLCJnaXZlbl9uYW1lIjoiIiwiZmFtaWx5X25hbWUiOiIifQ.abUPrFCg9a9XxZRLLIv_vBYp_PmaQVkdeGJ8wgPVzQYE4_YJRrbFYNFB2iFQhyMDhwpOa_w4g9xzl1uiPkTnOmlP25TfnZiAiYC9mSHaVaHK45q02xQe9vELgrvm9aPS2LYia_H-zPatR1fmonQ-dScqKFCfaXPK8TE9gvKVt026a6JY5meWsa-WMHLTOChOX3A_ncDIIofC394uDl43_0kLXoNSOcb9QTv6DdWk6dKmuM0vgfL-bJ61T1J3BZ9DCblOrnlZV-fJ5jH4YK7X0Tul5qipYmK-41yj8HziAXtVvU5zq-sEyTtQirFf7O1-eNp5iQEQKyd9QoA5rv-7HQ",
    "expires_in": 36000,
    "refresh_expires_in": 1800,
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI0NTI1MzkwYy0yY2VjLTQwOGYtOGUwNy0zY2UwMzYyMjNhYzEifQ.eyJleHAiOjE2ODY2NDU3MTksImlhdCI6MTY4NjY0MzkxOSwianRpIjoiNThlMWM3ZDMtZjM1Ny00YTk3LTgxNWUtNmM1NjczN2FmM2Y1IiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo5OTkwL3JlYWxtcy9haS1yZWFsbSIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6OTk5MC9yZWFsbXMvYWktcmVhbG0iLCJzdWIiOiI2ZmM3M2I3OS0yZWNhLTQzNTQtOTY0Ni1lNjBjNDViNTM4YjciLCJ0eXAiOiJSZWZyZXNoIiwiYXpwIjoiYWktY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjM0ZGNmZTQ1LWU0ZTUtNDQzNi1iNWU5LTMxYTQxZGNmYjQ2MiIsInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsInNpZCI6IjM0ZGNmZTQ1LWU0ZTUtNDQzNi1iNWU5LTMxYTQxZGNmYjQ2MiJ9.e_BCoAwIjE_zGgMxeqwQxl7bw5dpKVvhB0VIQIp_8qo",
    "token_type": "Bearer",
    "id_token": null,
    "not-before-policy": 0,
    "session_state": "34dcfe45-e4e5-4436-b5e9-31a41dcfb462",
    "scope": "email profile",
    "error": null,
    "error_description": null,
    "error_uri": null
  },
  "version": "1"
}

Authorization 401 response

{
  "message": "Error",
  "timestamp": "2023-06-13T10:07:40.836425400Z",
  "data": "Access denied",
  "version": "1"
}

404 response

{
  "timestamp": "2023-06-13T10:10:13.166+00:00",
  "status": 404,
  "error": "Not Found",
  "path": "/api/v1/authh"
}

500 response

{
  "message": "Error",
  "timestamp": "2023-06-13T10:12:11.321487096Z",
  "data": "Unexpected error occurred",
  "version": "1"
}

412 Validation error

{
  "message": "Validation error",
  "timestamp": "2023-06-13T10:18:29.735304909Z",
  "data": {
    "fieldErrors": [
      {
        "codes": [
          "NotBlank.authCred.password",
          "NotBlank.password",
          "NotBlank.java.lang.String",
          "NotBlank"
        ],
        "arguments": [
          {
            "codes": [
              "authCred.password",
              "password"
            ],
            "arguments": null,
            "defaultMessage": "password",
            "code": "password"
          }
        ],
        "defaultMessage": "must not be blank",
        "objectName": "authCred",
        "field": "password",
        "rejectedValue": null,
        "bindingFailure": false,
        "code": "NotBlank"
      },
      {
        "codes": [
          "Email.authCred.email",
          "Email.email",
          "Email.java.lang.String",
          "Email"
        ],
        "arguments": [
          {
            "codes": [
              "authCred.email",
              "email"
            ],
            "arguments": null,
            "defaultMessage": "email",
            "code": "email"
          },
          [],
          {
            "arguments": null,
            "defaultMessage": ".*",
            "codes": [
              ".*"
            ]
          }
        ],
        "defaultMessage": "must be a well-formed email address",
        "objectName": "authCred",
        "field": "email",
        "rejectedValue": "david",
        "bindingFailure": false,
        "code": "Email"
      }
    ],
    "globalErrors": []
  },
  "version": "1"
}

Role group list response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:26:05.597482025Z",
  "data": [
    {
      "id": "4c19578e-61f6-47e3-86a7-5514c1996b3a",
      "name": "admin",
      "roles": [
        "security.rolegroup.delete",
        "document.update",
        "microtask.update",
        "security.user.create",
        "document.create",
        "security.rolegroup.create",
        "security.user.read",
        "microtask.create",
        "security.user.update",
        "security.rolegroup.read",
        "security.rolegroup.update",
        "microtask.delete",
        "document.delete",
        "document.read",
        "security.user.delete"
      ]
    },
    {
      "id": "4c19578e-61f6-47e3-86a7-5514c1996b3a",
      "name": "data analytic",
      "roles": [
        "document.read"
      ]
    }
  ],
  "version": "1"
}

Role group create response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:28:15.765521687Z",
  "data": {
    "id": "1db3aff1-704b-405b-bd0f-8165504b449f",
    "name": "myGroup2",
    "roles": [
      "security.rolegroup.read"
    ]
  },
  "version": "1"
}

Role group update response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:31:11.840593392Z",
  "data": {
    "id": "1db3aff1-704b-405b-bd0f-8165504b449f",
    "name": "Changed name",
    "roles": [
      "security.rolegroup.create"
    ]
  },
  "version": "1"
}

Delete role group response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:31:11.840593392Z",
  "version": "1"
}

Find documents response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:26:32.368492045Z",
  "data": {
    "content": [
      {
        "creationTimestamp": "2023-06-13T11:26:02.558347Z",
        "createdBy": "8c7bf018-0bbe-46f1-9528-0b7a0e207063",
        "id": "7775d29c-1a85-4187-a87a-219965ecf311",
        "name": "Doc name",
        "description": "Doc description",
        "metadata": null,
        "status": null,
        "labels": []
      }
    ],
    "pageable": {
      "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
      },
      "offset": 0,
      "pageNumber": 0,
      "pageSize": 10,
      "paged": true,
      "unpaged": false
    },
    "last": true,
    "totalPages": 1,
    "totalElements": 1,
    "size": 10,
    "number": 0,
    "sort": {
      "empty": true,
      "sorted": false,
      "unsorted": true
    },
    "first": true,
    "numberOfElements": 1,
    "empty": false
  },
  "version": "1"
}

Find document by id response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:07:06.172404464Z",
  "data": {
    "creationTimestamp": "2023-06-13T11:07:06.136351343Z",
    "createdBy": "59560891-5667-40da-bd02-14fb1b8f9c6d",
    "id": "74821ec1-c4c0-42ab-ad5b-ed8fb1609cf6",
    "name": "doc name",
    "description": "doc description",
    "metadata": {},
    "status": "status",
    "labels": []
  },
  "version": "1"
}

Upload document response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:07:06.172404464Z",
  "data": {
    "creationTimestamp": "2023-06-13T11:07:06.136351343Z",
    "createdBy": "59560891-5667-40da-bd02-14fb1b8f9c6d",
    "id": "74821ec1-c4c0-42ab-ad5b-ed8fb1609cf6",
    "name": "doc name",
    "description": "doc description",
    "metadata": {},
    "status": "status",
    "labels": []
  },
  "version": "1"
}

Update document response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:07:06.172404464Z",
  "data": {
    "creationTimestamp": "2023-06-13T11:07:06.136351343Z",
    "createdBy": "59560891-5667-40da-bd02-14fb1b8f9c6d",
    "id": "74821ec1-c4c0-42ab-ad5b-ed8fb1609cf6",
    "name": "doc name",
    "description": "doc description",
    "metadata": {},
    "status": "status",
    "labels": []
  },
  "version": "1"
}

Delete document response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:31:11.840593392Z",
  "version": "1"
}

Create user response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:48:46.332547985Z",
  "data": {
    "externalId": "c3674c4c-1b52-4954-b184-6d5d50425750",
    "firstName": "name",
    "lastName": "lastname",
    "email": "username@mail.com",
    "password": "12334",
    "roleGroups": [
      {
        "id": "aad775f8-4e5e-4712-ac30-01f94d8cb423",
        "name": "admin",
        "roles": [
          "security.rolegroup.delete",
          "security.rolegroup.read",
          "security.rolegroup.update",
          "security.rolegroup.create"
        ]
      }
    ]
  },
  "version": "1"
}

Find user by id response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:48:46.332547985Z",
  "data": {
    "externalId": "c3674c4c-1b52-4954-b184-6d5d50425750",
    "firstName": "name",
    "lastName": "lastname",
    "email": "username@mail.com",
    "password": "12334",
    "roleGroups": [
      {
        "id": "aad775f8-4e5e-4712-ac30-01f94d8cb423",
        "name": "admin",
        "roles": [
          "security.rolegroup.delete",
          "security.rolegroup.read",
          "security.rolegroup.update",
          "security.rolegroup.create"
        ]
      }
    ]
  },
  "version": "1"
}

Update user response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:48:46.332547985Z",
  "data": {
    "externalId": "c3674c4c-1b52-4954-b184-6d5d50425750",
    "firstName": "name",
    "lastName": "lastname",
    "email": "username@mail.com",
    "password": "12334",
    "roleGroups": [
      {
        "id": "aad775f8-4e5e-4712-ac30-01f94d8cb423",
        "name": "admin",
        "roles": [
          "security.rolegroup.delete",
          "security.rolegroup.read",
          "security.rolegroup.update",
          "security.rolegroup.create"
        ]
      }
    ]
  },
  "version": "1"
}

Find all users response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:07:06.172404464Z",
  "data": [
    {
      "message": "Success",
      "timestamp": "2023-06-13T11:48:46.332547985Z",
      "data": {
        "externalId": "c3674c4c-1b52-4954-b184-6d5d50425750",
        "firstName": "name",
        "lastName": "lastname",
        "email": "username@mail.com",
        "password": "12334",
        "roleGroups": [
          {
            "id": "aad775f8-4e5e-4712-ac30-01f94d8cb423",
            "name": "admin",
            "roles": [
              "security.rolegroup.delete",
              "security.rolegroup.read",
              "security.rolegroup.update",
              "security.rolegroup.create"
            ]
          }
        ]
      },
      "version": "1"
    }
  ],
  "version": "1"
}

Delete user response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:07:06.172404464Z",
  "version": "1"
}

Find model input response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:28:15.765521687Z",
  "data": {
    "id": "1db3aff1-704b-405b-bd0f-8165504b449f",
    "model": {},
    "fields": {
      "key": [{}]
    }
  },
  "version": "1"
}

Find model by id response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:28:15.765521687Z",
  "data": {
    "id": "1db3aff1-704b-405b-bd0f-8165504b449f",
    "name": "string",
    "recipe": {},
    "gitRepository": "string"
  },
  "version": "1"
}

Find ai models list response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:28:15.765521687Z",
  "data": [
    {
    "id": "1db3aff1-704b-405b-bd0f-8165504b449f",
    "name": "string",
    "recipe": {},
    "gitRepository": "string"
  }
  ],
  "version": "1"
}

Save model output response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:28:15.765521687Z",
  "data": {
    "id": "1db3aff1-704b-405b-bd0f-8165504b449f",
    "name": "string",
    "recipe": {},
    "gitRepository": "string"
  },
  "version": "1"
}

Delete model response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:07:06.172404464Z",
  "version": "1"
}

Delete ai interface response

{
  "message": "Success",
  "timestamp": "2023-06-13T11:07:06.172404464Z",
  "version": "1"
}

Create AI interface response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:28:15.765521687Z",
  "data": {},
  "version": "1"
}

Find AI interfaces response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:28:15.765521687Z",
  "data": [],
  "version": "1"
}

Find AI interface fields response

{
  "message": "Success",
  "timestamp": "2023-06-13T10:28:15.765521687Z",
  "data": [],
  "version": "1"
}

Attach insight to document response

{
  "message": "Success",
  "timestamp": "2023-07-12T12:38:03.442328Z",
  "data": [
    {
      "creationTimestamp": "2023-07-04T09:35:06.680739Z",
      "createdBy": "1f31850d-2960-49ec-bf31-51a080ecd284",
      "id": "c67bd32d-d3b1-4720-aeb3-df6eb6c5acf2",
      "insight": {
        "creationTimestamp": "2023-07-04T09:34:37.586899Z",
        "createdBy": "1f31850d-2960-49ec-bf31-51a080ecd284",
        "name": "string",
        "description": "string",
        "id": "57f54af4-cc85-4aa1-83cc-b17463f21ae8",
        "isFinalized": false
      },
      "document": {
        "creationTimestamp": "2023-07-04T09:18:11.953065Z",
        "createdBy": "1f31850d-2960-49ec-bf31-51a080ecd284",
        "id": "0e206fd2-212a-4fbc-ad34-7aadda6e69d0",
        "name": "test4",
        "description": "test4",
        "labels": []
      }
    }
  ],
  "version": "1"
}

Detach insight form document response

{
  "message": "Success",
  "timestamp": "2023-07-12T13:38:03.442328Z",
  "version": "1"
}

Find Document Insights by Document ID response

{
  "message": "Success",
  "timestamp": "2023-07-12T12:38:03.442328Z",
  "data": [
    {
      "creationTimestamp": "2023-07-04T09:35:06.680739Z",
      "createdBy": "1f31850d-2960-49ec-bf31-51a080ecd284",
      "id": "c67bd32d-d3b1-4720-aeb3-df6eb6c5acf2",
      "insight": {
        "creationTimestamp": "2023-07-04T09:34:37.586899Z",
        "createdBy": "1f31850d-2960-49ec-bf31-51a080ecd284",
        "name": "string",
        "description": "string",
        "id": "57f54af4-cc85-4aa1-83cc-b17463f21ae8",
        "isFinalized": false
      },
      "document": {
        "creationTimestamp": "2023-07-04T09:18:11.953065Z",
        "createdBy": "1f31850d-2960-49ec-bf31-51a080ecd284",
        "id": "0e206fd2-212a-4fbc-ad34-7aadda6e69d0",
        "name": "test4",
        "description": "test4",
        "labels": []
      }
    }
  ],
  "version": "1"
}