v1

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

Get Full Object Details

Use this API to retrieve all the 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.
post/v1/entities/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.

entityTypeIdstring uuid

Identifier of the object type

The unique identifier of the object type.

entityTypeNamestring

Name of the object type

The name of the object type.

Request body

Response

OK - Successfully retrieved matching objects

totalElementsinteger
totalPagesinteger
sizeinteger
numberinteger
numberOfElementsinteger
lastboolean
firstboolean
emptyboolean

Example response

{
  "content": [
    {
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "number": 1,
      "name": "OneTrust",
      "orgGroupId": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
      "entityType": {
        "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46",
        "name": "Asset"
      },
      "workflowAndStage": {
        "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
        "name": "Vendor On-Boarding Workflow",
        "type": "Vendor",
        "workflowMode": "BASIC",
        "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
        "stageName": "Start On-Boarding"
      },
      "attributes": {
        "textAttributeName": [
          {
            "value": "Text"
          }
        ],
        "optionBasedAttributeName": [
          {
            "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          }
        ]
      },
      "auditFields": {
        "createdBy": {
          "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
          "name": "Name"
        },
        "lastModifiedBy": {
          "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
          "name": "Name"
        }
      }
    }
  ]
}