Retrieve assets - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product

Data_Integrity

Spatial_Analytics

Data_Enrichment

geo_addressing_1

Services

Spatial Analytics

Data Enrichment

Geo Addressing

ft:title

Data Integrity Suite APIs

ft:locale

en-US

PublicationType

pt_developer

copyrightfirst

2023

copyrightlast

2026

Retrieve list of assets with filters, pagination, and sorting.

HTTP

GET https://hostname/v2/catalog/assets

Request

Query parameters

Key	Required	Type	Description
filter	Yes	string	Filter the results by specifying one or more filters. The format is: field:operator(value):index Filter operators: eq Equal to ne Not equal to lt Less than le Less than or equal to gt Greater than ge Greater than or equal to in In a list of comma separated values ni Not in a list of comma separated values ct Contains a value sw Starts with a value ew Ends with a value ex Exists (only accepts Boolean (true or false) values) By default, multiple filter expressions are combined in an AND expression. Filter expressions can be grouped by appending the optional group `index` (`:0`, `:1`,…,, `:n` ) to each filter expression. Filters in the same group are combined using AND while different groups are combined using OR. For example, these filter expressions are in two different groups (0 and 1), so the combined expressions return results where `name` is either `Bob` or `Alice`. `filter=name:eq(Bob):0&filter=name:eq(Alice):1` Filter expressions are case insensitive.
sort	No	string	Sort the results by a field in ascending or descending order. The format is: asc(field) or desc(field) Specify `asc` to sort in ascending order (0–9, a–z) or `desc` to sort in descending order (z–a, 9–0). Specify multiple sort fields with multiple sort parameters. Sorting is applied in the same order that sort query parameters are ordered. Example: To first sort by `field1` in ascending order and then by `field2` in descending order, use two sort expressions: `sort=asc(field1)&sort=desc(field2)`
offset	No	number	The number of records to skip before returning results. The minimum is `0`. The default is none (`0`).
limit	No	number	The number of records to return per page. The minimum is `1`.
includeTotal	No	boolean	Return a count of the total number of records that match the specified filter expression regardless of the number of number of records returned in the response page. True — Return the total count of records that match the specified filter. False — Do not return the count (default). The count is returned by the total property in the response body. If the totalOverflow property is set to true in the response body, then the total count is an estimate that may exceed the actual number of records returned by the search.
search	No	boolean	Use search engine to perform the filter operation. True — Use the search engine. False — Do not use the search engine (default). The search engine: Performs a case insensitive search. May improve performance for complex filter expressions, such as those that use the contains operator. When `search` and `includeTotal` are both set to true, the search engine will always return the total number of records that match the specified filter expression. When `search` is not set to true, the total count may be limited to 10,000 results with `totalOverflow` in the result body set to `true` to indicate that the total count is an estimate and may exceed the returned total. Note: In rare cases, the `search=true` parameter setting may not return recently created or updated records.
synonymSearch	No	boolean	Expand search results by associating equivalent words (such as "dog" and "canine") for the specified field values. True — Match synonyms in the specified fields. False — Do not match synonyms in the specified fields (default). The default is false.
sections	No	string	Specifies properties to be included in the response. List properties names separated by commas. The asset id is always included in the response. All properties are included if this parameter is not included in the query string. Example: The query string parameter setting `sections=name,class,displayFormat` returns only id and class, and displayFormat in the result body.
permissions	No	string	Apply role-based access control filtering. The format is `action:scope`. The default value is `catalog:view`. Example: The query string parameter setting `permissions=business::view` filters results based on business view permissions.
isPlaceholder	No	boolean	Indicate whether an asset is a temporary placeholder created when referencing non-existent assets in relations. The default is false. Note: The query string parameter setting `isPlaceholder=true` includes placeholder assets in the result.

Response

The successful response returns the collection of assets that match the filter criteria.

Response body properties

Ancestors	Property	Required	Type	Description
	data		array(object)	Data envelope for response.
data	id	No	string	Format: `objectId` Pattern: `^[a-fA-F\d]{24}$`
data	parentId	No	string	Format: `objectId` Pattern: `^[a-fA-F\d]{24}$`
data	assetTypeId	No	string	Format: `objectId` Pattern: `^[a-fA-F\d]{24}$`
data	xref	No	array
data	scoresValues	No
data	scoresUpdated	No
data	counter	No	object
data/counter	value	Yes	number
data/counter	valueWithPrefix	No	string
data	color	No	string
data	class	No	string	This property is an enumerated string type (enum) set to one of these values: `Business` `Model` `Policy` `Reference` `Technical` `Rule` `Diagram` `Generic` `Configuration` `Domain` `Internal`
data	properties	No	array
data	tags	No	array
data	displayValue	No	string	Maximum length: 100 characters
data	assetTypeName	No	string
data	path	No	array
data	assetGroups	No	array
data	semanticType	No	object
data/semanticType	qualifier	Yes	string
data/semanticType	overridden	No	boolean	This property may be set to `true` or `false`.
data/semanticType	updatedAt	No	string	Format: `date-time`
data	createdBy	No	string
data	createdAt	No	string	Format: `date-time`
data	updatedBy	No	string
data	updatedAt	No	string	Format: `date-time`
data	metrics	No	array
data	assetTypeXrefs	No	array
data	isPlaceholder	No	boolean	This property may be set to `true` or `false`.
data	keyPath	No	string
data	level	No	number
data	displayPath	No	string
data	location	No	string
data	isLeaf	No	boolean	This property may be set to `true` or `false`.
	links	No	object

Response body examples

Example status code responses for this method are shown here. To view the response schemas, you can download the Data Catalog APIs Open API Specification from the Precisely Developer Portal..

Examples

"data": [
  {
    "id": "29a46857Dcf9c747D0E3dAb6",
    "parentId": "e67386deFF4cad39c29AFDC1",
    "assetTypeId": "18947A13bEdcbCea38CAAF7a",
    "xref": [
      "Sample xref"
    ],
    "color": "Sample color",
    "class": "Policy",
    "createdBy": "Sample User",
    "createdAt": "2024-10-01T07:51:41.666Z",
    "updatedBy": "Sample User",
    "updatedAt": "2004-10-06T08:44:23.634Z",
    "metrics": [
      {
        "metricTypeId": "99dcE59Fd936Fe5A93CE29DB",
        "value": 16276178.307024926,
        "lastUpdatedOn": "2006-03-16T05:22:38.802Z"
      }
    ],
    "assetTypeXrefs": [
      "Sample assetTypeXref 1",
      "Sample assetTypeXref 2"
    ],
    "isPlaceholder": false,
    "keyPath": "Sample keyPath",
    "level": 19537439.285527468
  }
],
"links": {
  "self": "https://api.cloud.precisely.com/assets"
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Resource not found"
}

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Rate limit exceeded"
}

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred"
}

{
  "statusCode": 503,
  "error": "Service Unavailable",
  "message": "Service temporarily unavailable"
}

{
  "statusCode": 504,
  "error": "Gateway Timeout",
  "message": "Request timeout"
}