OData service document listing the BI entity sets (scope bi:read)

GET/api/v1/bi

Authorization

AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Responses

200

OData v4 service document

@odata.contextstringrequired

valueobject[]required

Show properties

Array of object

namestringrequired

kindstringrequired

Allowed:EntitySet

urlstringrequired

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X GET '/api/v1/bi' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("/api/v1/bi", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/bi",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "@odata.context": "string",
  "value": [
    {
      "name": "string",
      "kind": "EntitySet",
      "url": "string"
    }
  ]
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}