Delete 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

Delete existing relations specified by ID.

HTTP

DELETE 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

An array of objects specify the relations to delete.

Property Required Type Description
id Yes string
  • Format: objectId
  • Pattern: ^[a-fA-F\d]{24}$
relationTypeId No string
  • Format: objectId
  • Pattern: ^[a-fA-F\d]{24}$
relationTypeXref No string  
subjectId No string
  • Format: objectId
  • Pattern: ^[a-fA-F\d]{24}$
subjectXref No string  
objectId No string
  • Format: objectId
  • Pattern: ^[a-fA-F\d]{24}$
objectXref No string  
triggersWorkflow No boolean

This property may be set to true or false.
Example
[
  {
    "id": "Cc25FCCcc91E4E87A5A09694"
  }
]

Response

Response body properties

Ancestors Property Required Type Description
  data Yes array(object) Data envelope for response.
data id Yes string
  • Format: objectId
  • Pattern: ^[a-fA-F\d]{24}$
  links No object  
links self No string

Specifies the id value for the asset. This is omitted if the xref value is specified.
links next Nio string Specifies the xref value for the asset. This is omitted if the id value is specified.
links prev No string Specifies the id value for the asset. This is omitted if the xref value is specified.
  errors No array<object>  
Examples
{
  "data": [
    {
      "id": "aB01FDebB6De022fc41F4b59"
    }
  ],
  "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"
}