Create relations - 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 new relations.

HTTP

POST https://hostname/v2/catalog/relations

Request

Request headers

Key	Required	Type	Value	Description
x-batch	No	boolean	`true\|false`	Required only for batch processing.

Request body properties

Property	Required	Type	Description
relationTypeId	Yes	string	Specifies the relationship type for the new relationship.
subjectId	No	string	The specific column ID that serves as a unique identifier for linking.
objectId	No	string	The unique identifier assigned to a specific data asset or item. This provides a unique reference for a data object.
subjectXref	No	string	The cross reference that links to releated data resources.
objectXref	No	string	Links different data objects.
properties	No	array	Property values for the new relation.
triggersWorkflow	No	boolean	This property may be set to `true` to trigger a workflow.

Request body example

Example

[
  {
    "relationTypeId": "6842a7d2f67022d431abe843",
    "subjectId": "687d2fe6fbe6c3e93b24125e",
    "objectId": "687d2fbcb32dfcd3ac047474",
    "properties": [
      {
        "name": "Owner",
        "value": "Owner1"
      },
      {
        "name": "Model",
        "value": "Model1"
      }
    ]
  }
]

Response

The successful response returns the collection of new relations.

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	relationTypeId	No	string	Format: `objectId` Pattern: `^[a-fA-F\d]{24}$`
data	subjectId	No	string	Format: `objectId` Pattern: `^[a-fA-F\d]{24}$`
data	objectId	No	string	Format: `objectId` Pattern: `^[a-fA-F\d]{24}$`
data	class	No	string	This property is an enumerated string type (enum) set to one of these values: `Lineage` `Evaluation` `Hierarchy` `Browse` `Simple` `SeeAlso` `Semantic` `Diagram` `DiagramUse` `DiagramRef`
data	subjectDisplayPath	No	string
data	objectDisplayPath	No	string
data	properties	No	array	Properties for a new relation.
data	overridability	No	string	This property is an enumerated string type (enum) set to one of these values: `None` `Definition` `Items` `All`
data	createdBy	No	string
data	createdAt	No	string	Format: `date-time`
data	updatedBy	No	string
data	updatedAt	No	string	Format: `date-time`

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": "Dde989e6251aFEf0dfEabf19",
      "relationTypeId": "9e8c6Fe968bCAabeFDaf4D7e",
      "subjectId": "7CfCB2fB15e487B6e8FEEdC0",
      "objectId": "FEacFf168bB03EEC000a20a5",
      "class": "Diagram",
      "createdBy": "Sample User",
      "createdAt": "2012-12-05T20:45:01.459Z",
      "updatedBy": "id",
      "updatedAt": "2018-05-13T02:47:27.339Z",
      "properties": [
        {
          "name": "Sample Property Name",
          "value": {}
        }
      ]
    }
  ],
  "links": {
    "self": "https://api.cloud.precisely.com/relations"
  }
}

{
  "links": {
    "self": "https://example.com/",
    "next": "https://example.com/",
    "prev": "https://example.com/"
  },
  "errors": [
    {
      "id": "string",
      "status": 0,
      "code": "string",
      "detail": "string",
      "source": {
        "additionalProp1": {}
      }
    }
  ],
  "data": {}
}

{
  "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"
}