# Data Models

## GET /v1/bi/data-models/{uid}

> Returns a specific data model

```json
{"openapi":"3.0.0","info":{"title":"Gormic BI API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"GetDataModelApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/GetDataModel_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"GetDataModel_Data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/GetDataModel_Data_Item"}},"required":["item"]},"GetDataModel_Data_Item":{"type":"object","properties":{"locales":{"type":"object"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/GetDataModel_Data_Item_ColumnsItem"}},"orderBy":{"type":"number"},"type":{"type":"string","enum":["file","query","service","web"]},"query":{"type":"string"},"format":{"type":"string","enum":["json"]},"fileName":{"type":"string"},"tag":{"type":"string"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"uid":{"type":"string"},"appId":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/ParameterM"}},"templateUids":{"type":"array","items":{"type":"string"}}},"required":["locales","type","uid","appId","parameters","templateUids"]},"GetDataModel_Data_Item_ColumnsItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["date","jsonb","numeric","text","timestamptz"]},"attribute":{"type":"string"},"cid":{"type":"string"},"lov":{"type":"array","items":{"type":"object"}},"locales":{"type":"object"}},"required":["name"]},"ParameterM":{"type":"object","properties":{"mode":{"type":"string","enum":["config","preference"]},"type":{"type":"string","enum":["date","date-range","date-time","date-time-range","lookup","lov","number","text","yyyy-mm"]},"locales":{"type":"object"},"optional":{"type":"boolean"},"multiple":{"type":"boolean"},"hidden":{"type":"boolean"},"defaultValue":{"type":"object"},"lovDependKey":{"type":"string"},"targets":{"$ref":"#/components/schemas/Record_5494b96e"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"key":{"type":"string"},"lovUid":{"type":"string"}},"required":["mode","type","locales","key"]},"Record_5494b96e":{"type":"object","properties":{}},"GetDataModelApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GetDataModel_Error"}},"required":["error"]},"GetDataModel_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/GetDataModel_ErrorCodes_enum"}]}},"required":["code"]},"GetDataModel_ErrorCodes_enum":{"type":"string","enum":["NotFound"]}}},"paths":{"/v1/bi/data-models/{uid}":{"get":{"operationId":"DataModels_get","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDataModelApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDataModelApiError"}}}}},"summary":"Returns a specific data model","tags":["Data Models"]}}}}
```

## POST /v1/bi/data-models/{uid}/fetch

> Fetch data for a specific data model

```json
{"openapi":"3.0.0","info":{"title":"Gormic BI API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"FetchDataApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/FetchData_Params"}},"required":["params"]},"FetchData_Params":{"type":"object","properties":{"organizationUid":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/FetchData_Params_ParametersItem"}},"query":{"$ref":"#/components/schemas/ListQueryParams_570588af"},"lang":{"type":"string","enum":["ar","en"]}},"required":["lang"]},"FetchData_Params_ParametersItem":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"object"}},"required":["key","value"]},"ListQueryParams_570588af":{"type":"object","properties":{}},"FetchDataApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/FetchData_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"FetchData_Data":{"type":"object","properties":{"output":{"type":"array","items":{"type":"object"}},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/FetchData_Data_ParametersItem"}},"next":{"type":"string"}},"required":["output","parameters"]},"FetchData_Data_ParametersItem":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"object"}},"required":["key","value"]},"FetchDataApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/FetchData_Error"}},"required":["error"]},"FetchData_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/FetchData_ErrorCodes_enum"}]}},"required":["code"]},"FetchData_ErrorCodes_enum":{"type":"string","enum":["INVALID_DATA_MODEL_PARAMETER","INVALID_INSTANCE_IDS_PARAM","MISSIN_QUERY_PARAM","NOT_ALLOWED","NotFound","UNKNOWN_DATA_MODEL_PARAMETER"]}}},"paths":{"/v1/bi/data-models/{uid}/fetch":{"post":{"operationId":"DataModels_fetch","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchDataApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchDataApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchDataApiError"}}}}},"summary":"Fetch data for a specific data model","tags":["Data Models"]}}}}
```