Skip to main content

Class: Dapi

dg.Dapi

Exposes Datagrok's server-side functionality.

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

Constructors​

constructor​

• new Dapi()

Defined in​

src/dapi.ts:47

Properties​

docker​

• docker: DockerDataSource

Defined in​

src/dapi.ts:167

stickyMeta​

• stickyMeta: StickyMeta

Defined in​

src/dapi.ts:238

Accessors​

admin​

• get admin(): AdminDataSource

Administering API endpoint

Returns​

AdminDataSource

Defined in​

src/dapi.ts:222

connections​

• get connections(): DataConnectionsDataSource

Data Connections API endpoint

Returns​

DataConnectionsDataSource

Defined in​

src/dapi.ts:79

credentials​

• get credentials(): CredentialsDataSource

Credentials API endpoint

Returns​

CredentialsDataSource

Defined in​

src/dapi.ts:85

entities​

• get entities(): EntitiesDataSource

Entities API endpoint

Returns​

EntitiesDataSource

Defined in​

src/dapi.ts:63

environments​

• get environments(): HttpDataSource<ScriptEnvironment>

Environments API endpoint

Returns​

HttpDataSource<ScriptEnvironment>

Defined in​

src/dapi.ts:163

files​

• get files(): FileSource

Users Files management API endpoint

Returns​

FileSource

Defined in​

src/dapi.ts:178

functions​

• get functions(): FuncsDataSource

Returns​

FuncsDataSource

Defined in​

src/dapi.ts:73

groups​

• get groups(): GroupsDataSource

Groups API endpoint

Returns​

GroupsDataSource

Defined in​

src/dapi.ts:139

jobs​

• get jobs(): HttpDataSource<DataJob>

Data Jobs API endpoint

Returns​

HttpDataSource<DataJob>

Defined in​

src/dapi.ts:91

layouts​

• get layouts(): LayoutsDataSource

View Layouts API endpoint

Returns​

LayoutsDataSource

Defined in​

src/dapi.ts:115

log​

• get log(): HttpDataSource<LogEvent>

Logging API endpoint

Returns​

HttpDataSource<LogEvent>

Defined in​

src/dapi.ts:228

logTypes​

• get logTypes(): HttpDataSource<LogEventType>

Logging API endpoint

Returns​

HttpDataSource<LogEventType>

Defined in​

src/dapi.ts:234

models​

• get models(): HttpDataSource<Model>

Predictive Models API endpoint

Returns​

HttpDataSource<Model>

Defined in​

src/dapi.ts:103

notebooks​

• get notebooks(): HttpDataSource<Notebook>

Jupyter Notebooks API endpoint

Returns​

HttpDataSource<Notebook>

Defined in​

src/dapi.ts:97

packages​

• get packages(): HttpDataSource<Package>

Packages API endpoint

Returns​

HttpDataSource<Package>

Defined in​

src/dapi.ts:109

permissions​

• get permissions(): PermissionsDataSource

Permissions API endpoint

Returns​

PermissionsDataSource

Defined in​

src/dapi.ts:145

projects​

• get projects(): ProjectsDataSource

Projects API endpoint

Returns​

ProjectsDataSource

Defined in​

src/dapi.ts:157

queries​

• get queries(): HttpDataSource<DataQuery>

Data Queries API endpoint

Returns​

HttpDataSource<DataQuery>

Defined in​

src/dapi.ts:69

root​

• get root(): string

HTTP root for DAPI

Returns​

string

Defined in​

src/dapi.ts:51

scripts​

• get scripts(): HttpDataSource<Script>

Scripts API endpoint

Returns​

HttpDataSource<Script>

Defined in​

src/dapi.ts:151

tables​

• get tables(): TablesDataSource

Data Table Infos API endpoint

Returns​

TablesDataSource

Defined in​

src/dapi.ts:127

userDataStorage​

• get userDataStorage(): UserDataStorage

Users Data Storage API endpoint

Returns​

UserDataStorage

Defined in​

src/dapi.ts:171

users​

• get users(): UsersDataSource

Users API endpoint

Returns​

UsersDataSource

Defined in​

src/dapi.ts:133

views​

• get views(): ViewsDataSource

View Views API endpoint

Returns​

ViewsDataSource

Defined in​

src/dapi.ts:121

Methods​

fetchProxy​

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

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

Parameters​

NameType
urlstring
params?RequestInit

Returns​

Promise<Response>

{Promise<Object>}

Defined in​

src/dapi.ts:205

getEntities​

▸ getEntities(ids): Promise<Entity[]>

Retrieves entities from server by list of IDs

Parameters​

NameType
idsstring[]

Returns​

Promise<Entity[]>

Defined in​

src/dapi.ts:57

proxyFetch​

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

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

Deprecated

Parameters​

NameType
methodstring
urlstring
headersRecord<string, string>
bodyobject

Returns​

Promise<object>

{Promise<Object>}

Defined in​

src/dapi.ts:189