Dapi

Exposes Datagrok's server-side functionality.

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

Constructors

new Dapi()

new Dapi(): Dapi

Returns

Dapi

Source

src/dapi.ts:49

Properties

Property	Type	Default value
stickyMeta	StickyMeta	...

Accessors

admin

get admin(): AdminDataSource

Administering API endpoint

Returns

AdminDataSource

Source

src/dapi.ts:219

---

connections

get connections(): DataConnectionsDataSource

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

Returns

DataConnectionsDataSource

Source

src/dapi.ts:82

---

credentials

get credentials(): CredentialsDataSource

Credentials API (search, saving, deleting credentials)

Returns

CredentialsDataSource

Source

src/dapi.ts:87

---

docker

get docker(): DockerDataSource

Returns

DockerDataSource

Source

src/dapi.ts:159

---

entities

get entities(): EntitiesDataSource

Entities API

Returns

EntitiesDataSource

Source

src/dapi.ts:66

---

environments

get environments(): HttpDataSource <ScriptEnvironment>

Environments API endpoint

Returns

HttpDataSource <ScriptEnvironment>

Source

src/dapi.ts:155

---

files

get files(): FilesDataSource

Users Files management API endpoint

Returns

FilesDataSource

Source

src/dapi.ts:177

---

functions

get functions(): FuncsDataSource

Functions API (finding functions and historical function calls)

Returns

FuncsDataSource

Source

src/dapi.ts:76

---

groups

get groups(): GroupsDataSource

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

Returns

GroupsDataSource

Source

src/dapi.ts:133

---

jobs

get jobs(): HttpDataSource <DataJob>

Data Jobs API

Returns

HttpDataSource <DataJob>

Source

src/dapi.ts:92

---

layouts

get layouts(): LayoutsDataSource

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

Returns

LayoutsDataSource

Source

src/dapi.ts:112

---

log

get log(): LogDataSource

Logging API endpoint

Returns

LogDataSource

Source

src/dapi.ts:225

---

logTypes

get logTypes(): HttpDataSource <LogEventType>

Logging API endpoint

Returns

HttpDataSource <LogEventType>

Source

src/dapi.ts:231

---

models

get models(): HttpDataSource <Model>

Predictive Models API endpoint

Returns

HttpDataSource <Model>

Source

src/dapi.ts:102

---

notebooks

get notebooks(): HttpDataSource <Notebook>

Jupyter Notebooks API

Returns

HttpDataSource <Notebook>

Source

src/dapi.ts:97

---

packages

get packages(): HttpDataSource <Package>

Packages API endpoint

Returns

HttpDataSource <Package>

Source

src/dapi.ts:107

---

permissions

get permissions(): PermissionsDataSource

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

Returns

PermissionsDataSource

Source

src/dapi.ts:138

---

projects

get projects(): ProjectsDataSource

Projects API endpoint

Returns

ProjectsDataSource

Source

src/dapi.ts:149

---

queries

get queries(): HttpDataSource <DataQuery>

Data Queries API

Returns

HttpDataSource <DataQuery>

Source

src/dapi.ts:71

---

reports

get reports(): UserReportsDataSource

Returns

UserReportsDataSource

Source

src/dapi.ts:181

---

root

get root(): string

HTTP root for DAPI

set root(root): void

Parameters

Parameter	Type
root	string

Returns

string

Source

src/dapi.ts:53

---

rules

get rules(): HttpDataSource <UserReportsRule>

Returns

HttpDataSource <UserReportsRule>

Source

src/dapi.ts:185

---

scripts

get scripts(): HttpDataSource <Script>

Scripts API (finding, saving, deleting scripts)

Returns

HttpDataSource <Script>

Source

src/dapi.ts:143

---

spaces

get spaces(): SpacesDataSource

Returns

SpacesDataSource

Source

src/dapi.ts:163

---

tables

get tables(): TablesDataSource

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

Returns

TablesDataSource

Source

src/dapi.ts:122

---

token

get token(): string

Session token

set token(token): void

Parameters

Parameter	Type
token	undefined | string

Returns

string

Source

src/dapi.ts:57

---

userDataStorage

get userDataStorage(): UserDataStorage

Deprecated

The UserDataStorage should not be used. Use UserSettingsStorage instead

Returns

UserDataStorage

Source

src/dapi.ts:170

---

users

get users(): UsersDataSource

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

Returns

UsersDataSource

Source

src/dapi.ts:128

---

views

get views(): ViewsDataSource

View Views API endpoint

Returns

ViewsDataSource

Source

src/dapi.ts:117

Methods

fetchProxy()

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

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

Source

src/dapi.ts:193

---

getEntities()

getEntities(ids): Promise <Entity[]>

Retrieves entities from server by list of IDs

Parameters

Parameter	Type
ids	string[]

Returns

Promise <Entity[]>

Source

src/dapi.ts:61