​
API Endpoints

​
Cloud Databrain Endpoint

POST https://api.usedatabrain.com/api/v2/dataApp/datamart/{method_path}

​
Self-hosted Databrain Endpoint

POST <SELF_HOSTED_URL>/api/v2/dataApp/datamart/{method_path}

​
Headers

​
Authorization
string
required
Bearer API TOKEN

​
Create Datamart

​
POST /create

Create a new datamart for the given datasource and schema.
Request Body
{
  "name": "string", // Required
  "datasourceName": "string", // Required
  "tableList": [ // Required, non-empty
    {
      "schemaName": "string", // Optional if non-schema datasource
      "name": "string", // Required
      "columns": [ // Required, non-empty
        {
          "name": "string", // Required
          "alias": "string" // Optional
        }
      ]
    }
  ]
}

{
  "id": "string", // Datamart name
  "error": null
}

​
Error Response

​
2. Delete Datamart

Endpoint: POST / delete Description: Deletes an existing datamart by name.

​
Request body

Request Body
{
  "datamartName": "string"   // Required
}

​
Sucess Response

Request Body
{
  "id": "string",   // Name of deleted datamart
  "error": null
}

​
Error Response

HTTP CodeCodeMessage
400INVALID_REQUEST_BODYInvalid datamart name
500INVALID_SERVER_ERRORGQL or server-side error

​
3. List Datamarts

Endpoint: POST /list Description: Returns all datamarts linked to the current user’s account.

​
Request Body

Request Body
{
  "isPagination": "boolean (optional)",
  "pageNumber": "number (optional)" //10 items per page
}

​
Success Body

Request Body
{
  "data": [
    {
      "name": "string",
      "datamartOrganization": {
        "tenancyLevel": "string",
        "schemaName": "string",
        "tableName": "string",
        "clientColumnType": "string",
        "tableClientNameColumn": "string",
        "tablePrimaryKeyColumn": "string"
      },
      "companyIntegration": {
        "name": "string"
      },
      "datamartTables": [
        {
          "schemaName": "string",
          "tableName": "string",
          "datamartTableColumns": [
            {
              "columnName": "string",
              "datatype": "string",
              "alias": "string"
            }
          ]
        }
      ]
    }
  ],
  "error": null
}

​
Error Response

HTTP CodeCodeMessage
500INVALID_SERVER_ERRORGQL or server-side error