ONoneuptime
BI Tool

Get BI Tool

Endpoint to retrieve a single BI Tool by ID

post/data-bi-connection/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the BI Tool to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "tool": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Finance Metabase",
    "tool": "Metabase",
    "baseUrl": "https://metabase.acme.com",
    "isEnabled": true,
    "lastSyncedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastSyncError": "This is an example of longer text content that might be stored in this field.",
    "dashboardCount": 42,
    "matchedTableCount": 42,
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.