Admin API
List
/admin/{implementationCode}/{resourceCode}/api
Description: Get list view data
Methods: GET
Query parameters:
| Property | Description | Example |
|---|---|---|
| page | page number | ?page=1 |
| itemsPerPage | number of items per page | ?itemsPerPage=25 |
| sort | array of sort properties | ?sort[]=title&sort[]=subTitle |
| sort_dir | array of sort properties directions | ?sort_dir[]=ASC&sort_dir[]=DESC |
| filters | array of filters properties with values | ?filter[title]=value1&filter[subTitle]=value2 |
JsonReponse body
- success:
boolean - data:
array
| Key | Description |
|---|---|
| config | list view configuration |
| data | list view data |
Batch
/admin/{implementationCode}/{resourceCode}/api/batch
Description: Execute batch actions
Methods: POST
Request body:
| Property | Description | Example |
|---|---|---|
| ids | resource ids to execute | ids: [1,2,3] |
| batch_action | batch action code | batch_action: publish |
JsonReponse body
- success:
boolean - data:
array
| Key | Description |
|---|---|
| messages | array with succes/error messages |
Bulk
/admin/{implementationCode}/{resourceCode}/api/bulk
Description: Execute bulk action
Methods: POST
Request body:
| Property | Description | Example |
|---|---|---|
| data | array of objects with resource id and properties to bulk update | data=[{id: 1, title: value1, subTitle: value2}, {id: 2, title: value3, subTitle: value4}] |
JsonReponse body
- success:
boolean - data:
array
| Key | Description |
|---|---|
| messages | array with succes/error messages |