Update 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

Updates an existing relation type.

HTTP

PATCH https://hostname/v2/catalog/relation-types/{id}

Request

Path parameters

Key Required Type Value Description
id Yes string objectId

Object ID for the relation type to be updated.

Request body

The request body contains an array of contains an array of one or more objects that update one or more relation types.

array<object> ≥ 1 items Details
array items  

object

One or more relation types to be updated.
  path

string

Identifies a property to be updated.
  op

string

Designates the update operation.
  value

Any of

  • #0 = string
  • #1 = string
  • #2 = string
  • #3 = string
  • #4 = string
  • #5 = string
  from

string
Example
[
  {
    "op": "add",
    "path": "/properties/0",
    "value": {
      "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
      }
    }
  }
]

Response

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/:id"
  }
}
 
{
  "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"
}