Skip to main content

Get schema for service.

GET 
/:api_prefix/:service_name/admin/schema

Get schema for service. This endpoint is the main entry point for the service. There are described all resources with actions, views and menus with low-level details. Main purpose of this endpoint is to generate UI structure and menu for the service. The list of base resource schema is returned. Every base schema contains:

  • name - name of the resource
  • label - label of the resource
  • pk_field_name - name of the primary key field
  • views - list of all views that can be used for the resource.
  • actions - list of all actions that can be used for the resource.
  • menu - description of the menu for the resource.

Request​

Responses​

Service schema response.