Skip to main content

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

Properties

PropertyTypeDefault value
stickyMetaStickyMeta...

Accessors

admin

get admin(): AdminDataSource

Administering API endpoint

Returns

AdminDataSource

Source

src/dapi.ts:242


connections

get connections(): DataConnectionsDataSource

Data Connections API endpoint

Returns

DataConnectionsDataSource

Source

src/dapi.ts:80


credentials

get credentials(): CredentialsDataSource

Credentials API endpoint

Returns

CredentialsDataSource

Source

src/dapi.ts:86


docker

get docker(): DockerDataSource

Returns

DockerDataSource

Source

src/dapi.ts:168


entities

get entities(): EntitiesDataSource

Entities API endpoint

Returns

EntitiesDataSource

Source

src/dapi.ts:64


environments

get environments(): HttpDataSource <ScriptEnvironment>

Environments API endpoint

Returns

HttpDataSource <ScriptEnvironment>

Source

src/dapi.ts:164


files

get files(): FileSource

Users Files management API endpoint

Returns

FileSource

Source

src/dapi.ts:182


functions

get functions(): FuncsDataSource

Returns

FuncsDataSource

Source

src/dapi.ts:74


groups

get groups(): GroupsDataSource

Groups API endpoint

Returns

GroupsDataSource

Source

src/dapi.ts:140


jobs

get jobs(): HttpDataSource <DataJob>

Data Jobs API endpoint

Returns

HttpDataSource <DataJob>

Source

src/dapi.ts:92


layouts

get layouts(): LayoutsDataSource

View Layouts API endpoint

Returns

LayoutsDataSource

Source

src/dapi.ts:116


log

get log(): HttpDataSource <LogEvent>

Logging API endpoint

Returns

HttpDataSource <LogEvent>

Source

src/dapi.ts:248


logTypes

get logTypes(): HttpDataSource <LogEventType>

Logging API endpoint

Returns

HttpDataSource <LogEventType>

Source

src/dapi.ts:254


models

get models(): HttpDataSource <Model>

Predictive Models API endpoint

Returns

HttpDataSource <Model>

Source

src/dapi.ts:104


notebooks

get notebooks(): HttpDataSource <Notebook>

Jupyter Notebooks API endpoint

Returns

HttpDataSource <Notebook>

Source

src/dapi.ts:98


packages

get packages(): HttpDataSource <Package>

Packages API endpoint

Returns

HttpDataSource <Package>

Source

src/dapi.ts:110


permissions

get permissions(): PermissionsDataSource

Permissions API endpoint

Returns

PermissionsDataSource

Source

src/dapi.ts:146


projects

get projects(): ProjectsDataSource

Projects API endpoint

Returns

ProjectsDataSource

Source

src/dapi.ts:158


queries

get queries(): HttpDataSource <DataQuery>

Data Queries API endpoint

Returns

HttpDataSource <DataQuery>

Source

src/dapi.ts:70


reports

get reports(): UserReportsDataSource

Returns

UserReportsDataSource

Source

src/dapi.ts:186


root

get root(): string

HTTP root for DAPI

Returns

string

Source

src/dapi.ts:52


rules

get rules(): HttpDataSource <UserReportsRule>

Returns

HttpDataSource <UserReportsRule>

Source

src/dapi.ts:190


scripts

get scripts(): HttpDataSource <Script>

Scripts API endpoint

Returns

HttpDataSource <Script>

Source

src/dapi.ts:152


tables

get tables(): TablesDataSource

Data Table Infos API endpoint

Returns

TablesDataSource

Source

src/dapi.ts:128


userDataStorage

get userDataStorage(): UserDataStorage

Deprecated

The UserDataStorage should not be used. Use UserSettingsStorage instead

Returns

UserDataStorage

Source

src/dapi.ts:175


users

get users(): UsersDataSource

Users API endpoint

Returns

UsersDataSource

Source

src/dapi.ts:134


views

get views(): ViewsDataSource

View Views API endpoint

Returns

ViewsDataSource

Source

src/dapi.ts:122

Methods

fetchProxy()

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

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

Parameters

ParameterTypeDescription
urlstring
params?RequestInit
maxAge?numberforces server to send Cache-Control in response with configured max-age directive

Returns

Promise<Response>

{Promise<Object>}

Source

src/dapi.ts:218


getEntities()

getEntities(ids): Promise <Entity[]>

Retrieves entities from server by list of IDs

Parameters

ParameterType
idsstring[]

Returns

Promise <Entity[]>

Source

src/dapi.ts:58


proxyFetch()

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

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

Parameters

ParameterTypeDescription
methodstring
urlstring
headersRecord<string, string>
bodyobject

Returns

Promise<object>

{Promise<Object>}

Deprecated

Source

src/dapi.ts:201