v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Entity Management

Get Full Entity Details

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

🗒 Things to Know

  • This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).
  • AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
post/api/ai-governance/v1/entities/search

Query parameters

pageinteger

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

sizeinteger

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

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

Sorting criteria in the format: property,(asc|desc). Example: '?sort=name,asc'

entityTypeNamestring

entityTypeName

Request body

Response

OK - Successfully retrieved matching entities

totalElementsinteger
totalPagesinteger
sizeinteger
contentobject[]
numberinteger
firstboolean
lastboolean
numberOfElementsinteger
emptyboolean