Demo Get Started Join the community
Documentation
Tutorials
01. Installation instructions 02. Adding resources 03. Customize resources 04. Customize actions 05. Writing your own Components 06. Using AdminJS features 07. Customize dashboard 08. Role-Based Access Control 09. Internationalization (i18n) 11. Content Management System

Class

ApiClient

ApiClient

Client which access the admin API. Use it to fetch data from auto generated AdminJS API.

In the backend it uses axios client library.

Usage:

import { ApiClient } from 'adminjs'

const api = new ApiClient()
// fetching all records
api.resourceAction({ resourceId: 'Comments', actionName: 'list' }).then(results => {...})
See:

View Source adminjs/src/frontend/utils/api-client.ts, line 54

Methods

# async bulkAction(options) → {Promise.<BulkActionResponse>}

Invokes given bulk Action on the backend.
Parameters:
Name Type Description
options BulkActionAPIParams

View Source adminjs/src/frontend/utils/api-client.ts, line 266

response from an Action

Promise.<BulkActionResponse>

# async getDashboard(options) → {Promise.<AxiosResponse.<any>>}

Invokes dashboard handler.
Parameters:
Name Type Description
options AxiosRequestConfig

View Source adminjs/src/frontend/utils/api-client.ts, line 276

response from the handler function defined in AdminJSOptions#dashboard

Promise.<AxiosResponse.<any>>

# async getPage(options) → {Promise.<AxiosResponse.<any>>}

Invokes handler function of given page and returns its response.
Parameters:
Name Type Description
options GetPageAPIParams

View Source adminjs/src/frontend/utils/api-client.ts, line 286

response from the handler of given page defined in AdminJSOptions#pages

Promise.<AxiosResponse.<any>>

# async recordAction(options) → {Promise.<RecordActionResponse>}

Invokes given record Action on the backend.
Parameters:
Name Type Description
options RecordActionAPIParams

View Source adminjs/src/frontend/utils/api-client.ts, line 257

response from an Action

Promise.<RecordActionResponse>

# async resourceAction(options) → {Promise.<ActionResponse>}

Invokes given resource Action on the backend.
Parameters:
Name Type Description
options ResourceActionAPIParams

View Source adminjs/src/frontend/utils/api-client.ts, line 248

response from an Action

Promise.<ActionResponse>

# async searchRecords(options) → {Promise.<SearchResponse>}

Search by query string for records in a given resource.
Parameters:
Name Type Description
options Object
resourceId String

id of a ResourceJSON
query String

query string

View Source adminjs/src/frontend/utils/api-client.ts, line 239

Promise.<SearchResponse>

Type Definitions

object

# ActionAPIParams

Extends AxiosRequestConfig
Properties:
Name Type Description
... any

any property supported by AxiosRequestConfig

View Source adminjs/src/frontend/utils/api-client.ts, line 184

object

# AxiosRequestConfig

Type of an axios request
See:

View Source adminjs/src/frontend/utils/api-client.ts, line 15

object

# BulkActionAPIParams

Extends ActionAPIParams
Properties:
Name Type Description
... any

any property supported by ActionAPIParams
See:

View Source adminjs/src/frontend/utils/api-client.ts, line 209

object

# GetPageAPIParams

Extends AxiosRequestConfig
Properties:
Name Type Description
... any

any property supported by AxiosRequestConfig
pageName string

Unique page name

View Source adminjs/src/frontend/utils/api-client.ts, line 218

object

# RecordActionAPIParams

Extends ActionAPIParams
Properties:
Name Type Description
... any

any property supported by ActionAPIParams

View Source adminjs/src/frontend/utils/api-client.ts, line 201

object

# ResourceActionAPIParams

Extends ActionAPIParams
Properties:
Name Type Attributes Description
... any

any property supported by AxiosRequestConfig
query string <optional>

View Source adminjs/src/frontend/utils/api-client.ts, line 192