This endpoint is deprecated. Please see the latest version.
Removes a Relationship between two private records.
URL: /data/v1/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 |
|
recordKey |
string |
Yes |
The key of a record. |
|
dataFieldKey |
string |
Yes |
The ClientKey matching the DataField in which the recordKey value is stored. The specified DataField should be of SystemLink type. |
| relationship | object | Yes | See Relationship Object Properties. |
Relationship Object Properties
|
Name |
Type |
Required |
Description |
|
recordKey |
string |
Yes |
The key of another record to create a relationship with. |
|
dataFieldKey |
string |
Yes |
The ClientKey matching the DataField in which the recordKey parameter value is stored. The specified DataField should be of SystemLink type. |
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/v1/deleteRelationship?apiKey=INSERT_YOUR_KEY_HERE
Body:
{"recordKey":"abc","dataFieldKey":"abc","relationship":{"recordKey":"abc","dataFieldKey":"abc"}}
Comments
0 comments
Article is closed for comments.