Get Basic Entity Details

post

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

Use this API to retrieve basic 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 migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.

Query Params

page

integer

Defaults to 0

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

size

integer

1 to 50

Defaults to 20

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

sort

string

enum

Defaults to name,asc

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

Allowed:

Body Params

criteria

object

The criteria used to search for entities, including filters, full-text search, and sorting

organizationTraversalStrategy

string

enum

The strategy for fetching entities across related organizations. Default: null (no organization traversal applicable)

Allowed:

requestedOrganizationId

uuid

The overridden requested organization identifier. If supplied, would be used instead of request context organization

queryAction

string

The query action specifies the source of the API call and allows a service to apply a predicate

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK - Successfully retrieved matching entities

429Too Many Requests. For more information, see API Rate Limits.