Dapi

Defined in: js-api/src/dapi.ts:87

Exposes Datagrok's server-side functionality.

See examples: https://public.datagrok.ai/js/samples/dapi/projects-list

Constructors

Constructor

new Dapi(): Dapi

Defined in: js-api/src/dapi.ts:88

Returns

Dapi

Properties

Property	Type	Defined in
stickyMeta	StickyMeta	js-api/src/dapi.ts:296

Accessors

admin

Get Signature

get admin(): AdminDataSource

Defined in: js-api/src/dapi.ts:274

Administering API endpoint

Returns

AdminDataSource

---

connections

Get Signature

get connections(): DataConnectionsDataSource

Defined in: js-api/src/dapi.ts:131

Data Connections API (finding, saving, sharing data connections and folders, getting database schemas)

Returns

DataConnectionsDataSource

---

credentials

Get Signature

get credentials(): CredentialsDataSource

Defined in: js-api/src/dapi.ts:136

Credentials API (search, saving, deleting credentials)

Returns

CredentialsDataSource

---

docker

Get Signature

get docker(): DockerDataSource

Defined in: js-api/src/dapi.ts:208

Returns

DockerDataSource

---

domains

Get Signature

get domains(): DomainsDataSource

Defined in: js-api/src/dapi.ts:218

Domain tables API: generic row CRUD over entity-mapped domain schemas declared by plugin manifests (databases/<schema>/schema.json).

Returns

DomainsDataSource

---

entities

Get Signature

get entities(): EntitiesDataSource

Defined in: js-api/src/dapi.ts:115

Entities API

Returns

EntitiesDataSource

---

environments

Get Signature

get environments(): HttpDataSource<ScriptEnvironment>

Defined in: js-api/src/dapi.ts:204

Environments API endpoint

Returns

HttpDataSource<ScriptEnvironment>

---

files

Get Signature

get files(): FilesDataSource

Defined in: js-api/src/dapi.ts:232

Users Files management API endpoint

Returns

FilesDataSource

---

functions

Get Signature

get functions(): FuncsDataSource

Defined in: js-api/src/dapi.ts:125

Functions API (finding functions and historical function calls)

Returns

FuncsDataSource

---

groups

Get Signature

get groups(): GroupsDataSource

Defined in: js-api/src/dapi.ts:182

Groups API (finding, saving, deleting groups, adding members, adding admins, including to parent groups, excluding from parent groups)

Returns

GroupsDataSource

---

impersonationToken

Get Signature

get impersonationToken(): string | null

Defined in: js-api/src/dapi.ts:106

Token of a user to act AS until this is cleared.

A browser session authenticates with the HttpOnly auth cookie, which script can neither read nor overwrite, so assigning token same-origin changes nothing. Set this to a token you already hold — a signup response, a service token — and it travels in the Authorization header, which the server prefers over the cookie. Always clear it in a finally; while it is set, every call runs as that user.

Returns

string | null

Set Signature

set impersonationToken(token): void

Defined in: js-api/src/dapi.ts:107

Parameters

Parameter	Type
token	string | null

Returns

void

---

info

Get Signature

get info(): InfoDataSource

Defined in: js-api/src/dapi.ts:280

Server info API endpoint

Returns

InfoDataSource

---

jobs

Get Signature

get jobs(): HttpDataSource<DataJob>

Defined in: js-api/src/dapi.ts:141

Data Jobs API

Returns

HttpDataSource<DataJob>

---

layouts

Get Signature

get layouts(): LayoutsDataSource

Defined in: js-api/src/dapi.ts:161

View Layouts API (getting applicable view layouts for a dataframe)

Returns

LayoutsDataSource

---

log

Get Signature

get log(): LogDataSource

Defined in: js-api/src/dapi.ts:286

Logging API endpoint

Returns

LogDataSource

---

logTypes

Get Signature

get logTypes(): HttpDataSource<LogEventType>

Defined in: js-api/src/dapi.ts:292

Logging API endpoint

Returns

HttpDataSource<LogEventType>

---

models

Get Signature

get models(): HttpDataSource<Model>

Defined in: js-api/src/dapi.ts:151

Predictive Models API endpoint

Returns

HttpDataSource<Model>

---

notebooks

Get Signature

get notebooks(): HttpDataSource<Notebook>

Defined in: js-api/src/dapi.ts:146

Jupyter Notebooks API

Returns

HttpDataSource<Notebook>

---

packages

Get Signature

get packages(): HttpDataSource<Package>

Defined in: js-api/src/dapi.ts:156

Packages API endpoint

Returns

HttpDataSource<Package>

---

permissions

Get Signature

get permissions(): PermissionsDataSource

Defined in: js-api/src/dapi.ts:187

Permissions API (checking, granting, revoking permissions on entities)

Returns

PermissionsDataSource

---

projects

Get Signature

get projects(): ProjectsDataSource

Defined in: js-api/src/dapi.ts:198

Projects API endpoint

Returns

ProjectsDataSource

---

queries

Get Signature

get queries(): HttpDataSource<DataQuery>

Defined in: js-api/src/dapi.ts:120

Data Queries API

Returns

HttpDataSource<DataQuery>

---

reports

Get Signature

get reports(): UserReportsDataSource

Defined in: js-api/src/dapi.ts:236

Returns

UserReportsDataSource

---

root

Get Signature

get root(): string

Defined in: js-api/src/dapi.ts:92

HTTP root for DAPI

Returns

string

Set Signature

set root(root): void

Defined in: js-api/src/dapi.ts:93

Parameters

Parameter	Type
root	string

Returns

void

---

rules

Get Signature

get rules(): HttpDataSource<UserReportsRule>

Defined in: js-api/src/dapi.ts:240

Returns

HttpDataSource<UserReportsRule>

---

scripts

Get Signature

get scripts(): HttpDataSource<Script>

Defined in: js-api/src/dapi.ts:192

Scripts API (finding, saving, deleting scripts)

Returns

HttpDataSource<Script>

---

spaces

Get Signature

get spaces(): SpacesDataSource

Defined in: js-api/src/dapi.ts:212

Returns

SpacesDataSource

---

tables

Get Signature

get tables(): TablesDataSource

Defined in: js-api/src/dapi.ts:171

Data Table Infos API (finding, uploadeing, deleting tables)

Returns

TablesDataSource

---

token

Get Signature

get token(): string

Defined in: js-api/src/dapi.ts:96

Session token

Returns

string

Set Signature

set token(token): void

Defined in: js-api/src/dapi.ts:97

Parameters

Parameter	Type
token	string | undefined

Returns

void

---

userDataStorage

Get Signature

get userDataStorage(): UserDataStorage

Defined in: js-api/src/dapi.ts:225

Deprecated

The UserDataStorage should not be used. Use UserSettingsStorage instead

Returns

UserDataStorage

---

users

Get Signature

get users(): UsersDataSource

Defined in: js-api/src/dapi.ts:177

Users API (finding, saving, deleting users, notifications). Also, current user and current session.

Returns

UsersDataSource

---

views

Get Signature

get views(): ViewsDataSource

Defined in: js-api/src/dapi.ts:166

View Views API endpoint

Returns

ViewsDataSource

Methods

fetchProxy()

fetchProxy(url, params?, maxAge?): Promise<Response>

Defined in: js-api/src/dapi.ts:248

Proxies URL request via Datagrok server with same interface as "fetch". Useful for cicrumventing CORS restrictions, and for caching results.

Parameters

Parameter	Type	Description
url	string	-
params?	RequestInit	-
maxAge?	number	forces server to send Cache-Control in response with configured max-age directive

Returns

Promise<Response>

See

sample

---

getEntities()

getEntities(ids): Promise<Entity[]>

Defined in: js-api/src/dapi.ts:110

Retrieves entities from server by list of IDs

Parameters

Parameter	Type
ids	string[]

Returns

Promise<Entity[]>