Статья создана

Get entries relations

Returns the specified DataLens entries relations.

Request

POST

https://api.datalens.tech/rpc/getEntriesRelations

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 2

Example: 2

x-dl-audit-mode

Type: string

Const: true

Example: ``

Body

application/json

{
  "entryIds": [
    "example"
  ],
  "linkDirection": "from",
  "includePermissionsInfo": true,
  "limit": 0.5,
  "pageToken": "example",
  "scope": "dash"
}

Name	Description
entryIds	Type: string[] ID of the entries to get relations for. Example `[ "example" ]`
includePermissionsInfo	Type: boolean Include permission information in the response.
limit	Type: number Maximum number of results to return.
linkDirection	Type: string The direction of the link relatively to the original entry: `from` — entries that are linked to the original entry `to` — the original entry is linked to the entries Enum: `from`, `to`
pageToken	Type: string Token for retrieving the next page of results. Example: `example`
scope	Type: EntryScope Type of the entry, e.g. `dash` — dashboard, `widget` — chart, etc. Enum: `dash`, `report`, `widget`, `dataset`, `folder`, `connection`, `compute`, `artifact`

EntryScope

Type of the entry, e.g. dash — dashboard, widget — chart, etc.

Type: string

Enum: dash, report, widget, dataset, folder, connection, compute, artifact

Responses

200 OK

Response

Body

application/json

{
  "relations": [
    {
      "entryId": "example",
      "key": "example",
      "scope": "dash",
      "type": "example",
      "createdAt": "example",
      "public": true,
      "tenantId": "example",
      "workbookId": "example",
      "collectionId": "example",
      "isLocked": true,
      "permissions": {
        "execute": true,
        "read": true,
        "edit": true,
        "admin": true
      },
      "fullPermissions": {
        "listAccessBindings": true,
        "updateAccessBindings": true,
        "limitedView": true,
        "view": true,
        "update": true,
        "copy": true,
        "move": true,
        "delete": true,
        "createEntryBinding": true,
        "createLimitedEntryBinding": true
      }
    }
  ],
  "nextPageToken": "example"
}

Name

Description

relations

Type: GetEntriesRelationsEntry[]

List of related entries.

Example

[
  {
    "entryId": "example",
    "key": "example",
    "scope": "dash",
    "type": "example",
    "createdAt": "example",
    "public": true,
    "tenantId": "example",
    "workbookId": "example",
    "collectionId": "example",
    "isLocked": true,
    "permissions": {
      "execute": true,
      "read": true,
      "edit": true,
      "admin": true
    },
    "fullPermissions": {
      "listAccessBindings": true,
      "updateAccessBindings": true,
      "limitedView": true,
      "view": true,
      "update": true,
      "copy": true,
      "move": true,
      "delete": true,
      "createEntryBinding": true,
      "createLimitedEntryBinding": true
    }
  }
]

nextPageToken

Type: string

Token for retrieving the next page of results.

Example: example