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
Source
Properties
Property | Type | Default value |
---|---|---|
stickyMeta | StickyMeta | ... |
Accessors
admin
get
admin():AdminDataSource
Administering API endpoint
Returns
Source
connections
get
connections():DataConnectionsDataSource
Data Connections API endpoint
Returns
Source
credentials
get
credentials():CredentialsDataSource
Credentials API endpoint
Returns
Source
docker
get
docker():DockerDataSource
Returns
Source
entities
get
entities():EntitiesDataSource
Entities API endpoint
Returns
Source
environments
get
environments():HttpDataSource
<ScriptEnvironment
>
Environments API endpoint
Returns
HttpDataSource
<ScriptEnvironment
>
Source
files
get
files():FileSource
Users Files management API endpoint
Returns
Source
functions
get
functions():FuncsDataSource
Returns
Source
groups
get
groups():GroupsDataSource
Groups API endpoint
Returns
Source
jobs
get
jobs():HttpDataSource
<DataJob
>
Data Jobs API endpoint
Returns
Source
layouts
get
layouts():LayoutsDataSource
View Layouts API endpoint
Returns
Source
log
get
log():HttpDataSource
<LogEvent
>
Logging API endpoint
Returns
Source
logTypes
get
logTypes():HttpDataSource
<LogEventType
>
Logging API endpoint
Returns
Source
models
get
models():HttpDataSource
<Model
>
Predictive Models API endpoint
Returns
Source
notebooks
get
notebooks():HttpDataSource
<Notebook
>
Jupyter Notebooks API endpoint
Returns
Source
packages
get
packages():HttpDataSource
<Package
>
Packages API endpoint
Returns
Source
permissions
get
permissions():PermissionsDataSource
Permissions API endpoint
Returns
Source
projects
get
projects():ProjectsDataSource
Projects API endpoint
Returns
Source
queries
get
queries():HttpDataSource
<DataQuery
>
Data Queries API endpoint
Returns
Source
reports
get
reports():UserReportsDataSource
Returns
Source
root
get
root():string
HTTP root for DAPI
Returns
string
Source
rules
get
rules():HttpDataSource
<UserReportsRule
>
Returns
HttpDataSource
<UserReportsRule
>
Source
scripts
get
scripts():HttpDataSource
<Script
>
Scripts API endpoint
Returns
Source
tables
get
tables():TablesDataSource
Data Table Infos API endpoint
Returns
Source
userDataStorage
get
userDataStorage():UserDataStorage
Deprecated
The UserDataStorage should not be used. Use UserSettingsStorage instead
Returns
Source
users
get
users():UsersDataSource
Users API endpoint
Returns
Source
views
get
views():ViewsDataSource
View Views API endpoint
Returns
Source
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
getEntities()
getEntities(
ids
):Promise
<Entity
[]>
Retrieves entities from server by list of IDs
Parameters
Parameter | Type |
---|---|
ids | string [] |
Returns
Promise
<Entity
[]>
Source
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>}