View Categories

REST API – Entity Relationships

< 1 minutes

Add Related — Add a relationship #

This operation adds an item to an entity's related lists. The related list must be of type get_related_list (not get_dependents_list, since these are added automatically when the linked entity is created).

POST https://apps.kafinea.com/{instance}/webservice.php

Setting Type Required Description
operation string yes Must be add_related
sessionName string yes Session ID
sourceRecordId string yes Web service ID of the source entity
relatedLabel string yes Name of the linked module
relatedRecordId string yes Web service ID of the entity to be linked

Curl example:

curl -X POST https://apps.kafinea.com/YourKafinea/webservice.php \
  -d "operation=add_related" \
  -d "sessionName=YOUR_SESSION_ID" \
  -d "sourceRecordId=21x3456" \
  -d "relatedLabel=Documents" \
  -d "relatedRecordId=15x7890"

Related references 🔗 #