Skip to content
English - United Kingdom
  • There are no suggestions because the search field is empty.

Data/v2/DeleteRelationship

This endpoint has been deprecated. There is no newer version.

Removes a Relationship between two organisation records.

URL: /data/v2/deleteRelationship

Method: POST

Method Parameters

Name

Type

Required

Description


apiKey


string


Yes


The API key for your organisation.



model



object



Yes


The object detailing the specified values.

See Model Object Properties.

Model Object Properties

Name

Type

Required

Description


uniqueKey


string


Yes


The unique key of a record.


layerKey


string


Yes


The API key matching the Layer in which the record is stored.


relationship

object

Yes

See Relationship Object Properties.

Relationship Object Properties

Name

Type

Required

Description


uniqueKey


string


Yes


The unique key of another record to create a relationship with.



layerKey



string



Yes



The API key matching the Layer in which the record specified by this objects uniqueKey property value is stored.

Response

The following responses may be returned in addition to the standard ones specified under Common Information.

Code

Error Message

Description


400


The relationship parameter object must be provided.


The relationship parameter was null.

Example call

URL: https://api.vision-mapping.com/data/v2/deleteRelationship?apiKey=INSERT_YOUR_KEY_HERE

Body:

{
uniqueKey: "abc",
layerKey: "abc",
relationship: {
uniqueKey: "abc",
layerKey: "abc"
}
}