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:261

---

connections

get connections(): DataConnectionsDataSource

Data Connections API endpoint

Returns

DataConnectionsDataSource

Source

src/dapi.ts:97

---

credentials

get credentials(): CredentialsDataSource

Credentials API endpoint

Returns

CredentialsDataSource

Source

src/dapi.ts:103

---

docker

get docker(): DockerDataSource

Returns

DockerDataSource

Source

src/dapi.ts:185

---

entities

get entities(): EntitiesDataSource

Entities API endpoint

Returns

EntitiesDataSource

Source

src/dapi.ts:81

---

environments

get environments(): HttpDataSource <ScriptEnvironment>

Environments API endpoint

Returns

HttpDataSource <ScriptEnvironment>

Source

src/dapi.ts:181

---

files

get files(): FileSource

Users Files management API endpoint

Returns

FileSource

Source

src/dapi.ts:199

---

functions

get functions(): FuncsDataSource

Returns

FuncsDataSource

Source

src/dapi.ts:91

---

groups

get groups(): GroupsDataSource

Groups API endpoint

Returns

GroupsDataSource

Source

src/dapi.ts:157

---

jobs

get jobs(): HttpDataSource <DataJob>

Data Jobs API endpoint

Returns

HttpDataSource <DataJob>

Source

src/dapi.ts:109

---

layouts

get layouts(): LayoutsDataSource

View Layouts API endpoint

Returns

LayoutsDataSource

Source

src/dapi.ts:133

---

log

get log(): LogDataSource

Logging API endpoint

Returns

LogDataSource

Source

src/dapi.ts:267

---

logTypes

get logTypes(): HttpDataSource <LogEventType>

Logging API endpoint

Returns

HttpDataSource <LogEventType>

Source

src/dapi.ts:273

---

models

get models(): HttpDataSource <Model>

Predictive Models API endpoint

Returns

HttpDataSource <Model>

Source

src/dapi.ts:121

---

notebooks

get notebooks(): HttpDataSource <Notebook>

Jupyter Notebooks API endpoint

Returns

HttpDataSource <Notebook>

Source

src/dapi.ts:115

---

packages

get packages(): HttpDataSource <Package>

Packages API endpoint

Returns

HttpDataSource <Package>

Source

src/dapi.ts:127

---

permissions

get permissions(): PermissionsDataSource

Permissions API endpoint

Returns

PermissionsDataSource

Source

src/dapi.ts:163

---

projects

get projects(): ProjectsDataSource

Projects API endpoint

Returns

ProjectsDataSource

Source

src/dapi.ts:175

---

queries

get queries(): HttpDataSource <DataQuery>

Data Queries API endpoint

Returns

HttpDataSource <DataQuery>

Source

src/dapi.ts:87

---

reports

get reports(): UserReportsDataSource

Returns

UserReportsDataSource

Source

src/dapi.ts:203

---

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:207

---

scripts

get scripts(): HttpDataSource <Script>

Scripts API endpoint

Returns

HttpDataSource <Script>

Source

src/dapi.ts:169

---

tables

get tables(): TablesDataSource

Data Table Infos API endpoint

Returns

TablesDataSource

Source

src/dapi.ts:145

---

token

get token(): string

set token(token?): void

Parameters

Parameter	Type
token?	string

Returns

string

Source

src/dapi.ts:62

---

userDataStorage

get userDataStorage(): UserDataStorage

Deprecated

The UserDataStorage should not be used. Use UserSettingsStorage instead

Returns

UserDataStorage

Source

src/dapi.ts:192

---

users

get users(): UsersDataSource

Users API endpoint

Returns

UsersDataSource

Source

src/dapi.ts:151

---

views

get views(): ViewsDataSource

View Views API endpoint

Returns

ViewsDataSource

Source

src/dapi.ts:139

Methods

fetchProxy()

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

Proxies URL request via Datagrok server with same interface as "fetch".

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>

{Promise<Object>}

Source

src/dapi.ts:235

---

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:75

---

proxyFetch()

proxyFetch(method, url, headers, body): Promise<object>

Proxies URL request via Datagrok server with same interface as "fetch".

Parameters

Parameter	Type	Description
method	string
url	string
headers	Record<string, string>
body	object

Returns

Promise<object>

{Promise<Object>}

Deprecated

Source

src/dapi.ts:218