ONoneuptime
BI Tool

Update BI Tool

Endpoint to update an existing BI Tool

put/data-bi-connection/{id}

Request

Path parameters

idstring uuid required

ID of the BI Tool to update

Request body

Example request

{
  "data": {
    "name": "Example Text"
  }
}

Response

Updated successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "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"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "tool": "Example Text",
    "baseUrl": "This is an example of longer text content that provides detailed information.",
    "isEnabled": true,
    "lastSyncedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastSyncError": "This is an example of longer text content that provides detailed information.",
    "dashboardCount": 42,
    "matchedTableCount": 42,
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Changes

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