v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Model Management

Get Basic Model Object Details

Use this API to retrieve basic details for the specified Model object record by key terms and filters.

🗒 Things to Know

This API only supports Model objects created via Object Manager.

post/api/custom-entity/v2/models/basic-details/search

Query parameters

pageinteger

Results page to be retrieved (0..N). Example- '?page=1

The page number of the results.

sizeinteger

Number of records per page (1..50). Example- '?size=20

The number of results per page.

sort'name,asc' | 'name,desc'

The sort criteria that dictates the order of the results.

Request body

Response

Successfully retrieved list of basic model details matching query

totalElementsinteger required

The total number of results in the list.

totalPagesinteger required

The total number of pages in the list.

numberinteger required

The page number of the results.

sizeinteger required

The number of results per page.

firstboolean required

This flag indicates whether the current page is the first page of the list.

lastboolean required

This flag indicates whether the current page is the last page of the list.

emptyboolean required

The flag indicates whether no results exist on the page.

numberOfElementsinteger required

The number of results on the current page.

hasNextboolean required

This flag indicates whether there is a next page in the list.

hasPreviousboolean required

This flag indicates whether there is a previous page in the list.

Example response

{
  "content": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Customer Entity",
      "type": "customer",
      "status": "active"
    }
  ],
  "totalElements": 250,
  "totalPages": 25,
  "number": 0,
  "size": 10,
  "first": true,
  "last": false,
  "empty": false,
  "numberOfElements": 10
}