Get Basic Object Details

post

https://{hostname}/api/custom-entity/v1/entity-basic-details/search

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

🗒
Things to Know

This API only supports objects created via Object Manager, including Projects, Models, and Datasets.

Query Params

entityTypeId

uuid

required

The unique identifier of the object type.

page

integer

Defaults to 0

The page number of the results.

size

integer

Defaults to 10

The number of results per page.

sort

array of strings

The sort criteria that dictates the order of the results.

sort

Body Params

Criteria for filtering objects including attribute conditions and sorting preferences

criteria

object

The details of the filter criteria.

organizationTraversalStrategy

string

enum

The strategy used to return objects within the organizational hierarchy.

Allowed:

requestedOrganizationId

uuid

The unique identifier of the organization for the request.

queryAction

string

The action specifying the source of the API request.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK - Successfully retrieved matching objects