Data Models

Returns a specific data model

get

Authorizations

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/bi/data-models/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "locales": {},
      "columns": [
        {
          "name": "text",
          "type": "date",
          "attribute": "text",
          "cid": "text",
          "lov": [
            {}
          ],
          "locales": {}
        }
      ],
      "orderBy": 1,
      "type": "file",
      "query": "text",
      "format": "json",
      "fileName": "text",
      "tag": "text",
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "appId": "text",
      "parameters": [
        {
          "mode": "config",
          "type": "date",
          "locales": {},
          "optional": true,
          "multiple": true,
          "hidden": true,
          "defaultValue": {},
          "lovDependKey": "text",
          "targets": {},
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "key": "text",
          "lovUid": "text"
        }
      ],
      "templateUids": [
        "text"
      ]
    }
  }
}

Fetch data for a specific data model

post

Authorizations

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

Responses

200Success

application/json

400

Functional Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/bi/data-models/{uid}/fetch HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "params": {
    "organizationUid": "text",
    "parameters": [
      {
        "key": "text",
        "value": {}
      }
    ],
    "query": {},
    "lang": "ar"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "output": [
      {}
    ],
    "parameters": [
      {
        "key": "text",
        "value": {}
      }
    ],
    "next": "text"
  }
}