Create 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

Creates a new relation type.

HTTP

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

Request

Request body

The request body encapsulates an object that specifies properties and values for a single new relation type. An example request body is shown here. To view the request body schema, you can download the Data Catalog APIs Open API Specification from the Precisely Developer Portal.

Example
{
  "predicateId": "68ca933af8375d9ffb2eeb44",
  "subjectId": "68ca92b97ae9bcef4bb12649",
  "subjectCardinality": "One",
  "objectId": "68ca92e250212e5df6b27e94",
  "objectCardinality": "Many",
  "properties": []
}

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": "68ca933af8375d9ffb2eeb44",
    "overridability": "All",
    "subjectCardinality": "One",
    "objectCardinality": "Many",
    "class": "Simple",
    "subjectId": "68ca92b97ae9bcef4bb12649",
    "objectId": "68ca92e250212e5df6b27e94",
    "state": "Active",
    "createdBy": "00u1wp2ej7pODrOk70h8",
    "createdAt": "2025-09-17T10:53:46.706Z",
    "updatedAt": "2025-09-17T10:53:46.706Z",
    "updatedBy": "00u1wp2ej7pODrOk70h8",
    "predicateId": "68ca5f380edbc22000f6b11a",
    "subjectName": "QA_BUS_EXM_1",
    "objectName": "QA_BUS_EXM_2",
    "predicateName": "Sample_Predicate_29",
    "xref": [
      "5116c2cef0b9"
    ],
    "properties": []
  },
  "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"
}