/rest/api/linkage

Service to handle linkage related operations.

POST v1/link

Links entries.

Response
application/json; charset=UTF-8

LinkageResultDTO - The result of a linkage operation.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
FORM
LinkageDTO  
linkageDTO
Configuration for a linkage of entries.
false
 
QUERY
Boolean  
checkLinkable
true to check linkable attribute for relation.
true
true
QUERY
Boolean  
checkDuplicates
true to check for duplicates to abort link operation.
true
false
QUERY
Boolean  
checkRequiredFields
true to check if all required fields are filled, unless a default value is configured.
true
true
QUERY
Boolean  
validateLookupValues
true to validate lookup values for relation fields.
Note: Enabling this option causes performance losses.
true
true
QUERY
Boolean  
checkLinkEntriesExists
true to check if link entries exists after operation.
Note: Enabling this option causes severe performance losses.
true
false

Status Codes

Status Code
Description
732
Given attribute could not be found.
733
Relation for given master not found.
740
General error during linkage.
741
Link operation is not allowed on relation.
742
Link operation is not allowed due to duplicate.
743
Master entry is missing for link operation.
744
Entries for link operation could not be found.
745
Maximum link count exceeded.
746
Expected link count mismatch.
747
The attribute for link operation is not allowed.
748
An attribute is required for the link operation.

POST v1/unlink

Unlinks entries.

Response
application/json; charset=UTF-8

LinkageResultDTO - The result of a linkage operation.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
FORM
LinkageDTO  
linkageDTO
Configuration for un-linkage of entries.
false
 

Status Codes

Status Code
Description
733
Relation for given master not found.
740
General error during linkage.
741
Link operation is not allowed on relation.
743
Master entry is missing for link operation.
744
Entries for link operation could not be found.
746
Expected link count mismatch.