Full-text search - 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

Full-text search of catalog assets across technical and business classes.

Search and retrieve catalog assets across technical and business classes with advanced filtering, sorting, and pagination. This method returns optimized partial asset data for enhanced performance.

HTML

GET https://hostname/v2/catalog/search

Request

Query parameters

Key Required Type Description
filter No string

Filter the results by specifying a filter expression. This API allows filtering the result set by specifying a filter expression. Use the format:

filter=field1:op(value1)

Filter operators (op)

  • 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 true/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.

field:operator(value):index

Filters in the same group (sharing the same index value) are combined using AND while different groups are combined using OR. Filter expressions with no index specified are combined using the AND operator.

Example: The following expression returns results where the name is either Bob or Alice.
filter=name:eq(Bob):0&filter=name:eq(Alice):1

Filter expressions are case-insensitive by default, but can be made case-sensitive by adding the search=true query parameter (if supported) to the query string. The search=true query parameter (where applicable) will also improve performance with complex filter expressions such as those that use the ct (contains) operator.
sort No string

Sort the results by a field in ascending or descending order.

This method allows sorting the results by a field in ascending or descending order. Use the format sort=asc(field1) or sort=desc(field1). Specify multiple sort fields by adding multiple sort parameters and sorting will be applied in the order specified.

Example: This query string sorts first by field1 in ascending order, then by field2 in descending order:

&sort=asc(field1)&sort=desc(field2)
offset No number The number of records to skip before returning results.
limit No number The number of records to return per page.
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.

When not search=true, the total count may be limited to 10,000 results with `totalOverflow: true` set to indicate that the total count is an estimate and may exceed the returned total. When using `search=true` in combination with `includeTotal=true`, the search engine will always return the total number of records that match the specified filter expression.

</details>
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.
searchTerm No string Specifies a search term to filter assets using Atlas Search. Applies full-text matching across displayValue, displayPath, assetTypeName, and properties. Supports exact phrase matching when enclosed in quotes (for example, "exact phrase"). Minimum 3 characters for optimal search performance and result relevance.
permissions No string Permission filter to restrict results based on user permissions. Service accounts bypass this check. Common values: catalog::view, data::read.

Response

Response body properties

Ancestors Property Required Type Description
  data   array(object) Array of partial asset objects matching the search criteria.
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
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

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

data keyPath No string  
data level No number  
data displayPath No string  
data isLeaf No boolean

This property may be set to true or false.

Response examples

Example status code responses for this method are shown here.

Examples

"data": [
  {
    "id": "69086b655f600913a4eaa7c9",
    "assetTypeId": "690868cc506a441bb5979403",
    "xref": ["6a6cddb3ee8b"]
    "class": "Technical",
    "tags": [],
    "displayValue": "custom-datasource",
    "assetTypeName": "General",
    "path": [],
    "createdBy": "00u2361yjy5A2EYDq0h8",
    "createdAt": "2025-11-03T08:44:21.646Z",
    "updatedBy": "00u2361yjy5A2EYDq0h8",
    "updatedAt": "2025-11-03T08:44:21.646Z",
    "level": 1,
    "displayPath": "custom-datasource",
    "isLeaf": false
  }
],
"links":{
  "self": "https://api.cloud.precisely.com/search"
}
400 Bad request
"value": {
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Bad Request"
}
"value": {
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required"
}
 
"value":{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Resource not found"
}
 
"value": {
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Rate limit exceeded"
}
 
"value": {
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred"
}
 
"value":{
  "statusCode": 503,
  "error": "Service Unavailable",
  "message": "Service temporarily unavailable"
}
 
"value":{
  "statusCode": 504,
  "error": "Gateway Timeout",
  "message": "Request timeout"
}