Retrieve relation types - 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

Returns a list of relation types for the specified filter criteria.

HTTP

GET https://hostname/v2/catalog/relation-types

Request

Query parameters

Key Required Type Value Description
filter No string field:operator(value):index

Filter the results by specifying one or more filters.

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 by default.

sort No string

asc(field)

or

desc(field)

Sort the results by a field in ascending or descending order

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 number of records

The number of records to skip before returning results. The minimum is 0. The default is none (0).
limit No number number of records

The number of records to return per page. The minimum is 1.
includeTotal No boolean true | false

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 method.
search No boolean true | false

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. This indicates that the total count is an estimate that may exceed the actual total number of records returned by the method.
Note: In rare cases, the search=true parameter setting may not return recently created or updated records.
includeTotalLimit No number limit

Response

The response returns the collection of Relations that match the filter criteria.

Response body

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": "68ca9d565ae39f6b24b87282",
      "overridability": "All",
      "subjectCardinality": "One",
      "objectCardinality": "Many",
      "class": "Simple",
      "subjectId": "6853c744e223c4e03ea5872b",
      "objectId": "68c2ac62bb0f260fe2a52597",
      "state": "Active",
      "createdBy": "00u17r5rbf45iXfQp0h8",
      "createdAt": "2025-09-17T11:36:54.423Z",
      "updatedAt": "2025-09-17T11:39:54.566Z",
      "updatedBy": "00u17r5rbf45iXfQp0h8",
      "predicateId": "68ca9adf9a68cae1704d4222",
      "subjectName": "QA-AT-1706-A",
      "objectName": "QA_TECH_SAMPLE_11",
      "predicateName": "NameUpdated",
      "xref": [
        "cc3c545a3fcc"
      ],
      "properties": [
        {
          "name": "Link",
          "label": "Link",
          "type": "Link",
          "definition": {
            "link": {
              "defaultLabel": "Example",
              "defaultUrl": "https://www.example.com"
            }
          },
          "requirement": "Optional",
          "category": "General",
          "display": {
            "show": true,
            "showIfEmpty": true,
            "showInColumn": true
          },
          "editableOnUi": false
        }
      ]
    }
  ],
  "links": {
    "self": "https://api.cloud.precisely.com/relation-types"
  }
}
 
{
  "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"
}