Description

An "Integration" in Clarify Client Microservice mirrors an integration in clarify database. The configurations provided through the "Integration" entity can be listed as below:

General configurations such as the Integration id and uuid, the json api url, ...
Authentication configurations
Schemes configurations
Dataset configurations

Model File Format

The above mentioned settings will form the Integration's configuration with the following structure.

"@Microservice.Clarify.Integration": {
   "id": "Integration 1",
   "uuid": "fe7dea6d-7eac-430f-95eb-88a21b104d1d",
   "integration": "ceg2421...5q4heik0",
   "url": "https://api.clarify.io/v1/rpc",
   "credentials": {
      ...
   },
   "customSchemes": {
      ...
   },
   "children": [
      {
          ...
      },
      {
          ...
      }
   ]
}

Object Members

id	A string value containing the ID of the "Integration". The ID is used to construct the Integrations's Primary Keys
uuid	A string value containing the unique UUID of the "Integration"
integration	A string value containing the clarify database integration id that data will be stored in
credentials	A json object describing the authentication method and configurations
customSchemes	A json object describing one or more custom schemes
children	A json list describing one or more Datasets

Published Attributes

An overview of the microservice current operation conditions can be obtained by reading its published attributes. The Integration's published attributes are explained here.