{"id":441539,"date":"2026-04-03T02:43:15","date_gmt":"2026-04-03T00:43:15","guid":{"rendered":"https:\/\/www.kafinea.com\/documentation\/uncategorized\/api-rest-operations-liees\/"},"modified":"2026-09-21T02:04:12","modified_gmt":"2026-09-21T00:04:12","password":"","slug":"api-rest-operations-liees","status":"publish","type":"docs","link":"https:\/\/www.kafinea.com\/fr\/documentation\/api\/api-rest-operations-liees\/","title":{"rendered":"API REST – Relations entre entit\u00e9s"},"content":{"rendered":"

Kafinea distingue trois concepts qui ne sont pas interchangeables :<\/p>\n

\n\n\n\n\n\n\n\n
Besoin<\/th>\nM\u00e9canisme \u00e0 utiliser<\/th>\n<\/tr>\n<\/thead>\n
Parcourir ou compl\u00e9ter une liste connexe affich\u00e9e sur une fiche<\/td>\nOp\u00e9rations de listes connexes<\/td>\n<\/tr>\n
Cr\u00e9er un lien qualifi\u00e9, par exemple \u00ab bloque \u00bb ou \u00ab duplique \u00bb<\/td>\nOp\u00e9rations CRUD sur l’entit\u00e9 de lien qualifi\u00e9<\/td>\n<\/tr>\n
G\u00e9rer les composants et quantit\u00e9s d’un kit<\/td>\nOp\u00e9rations d\u00e9di\u00e9es aux kits de produits<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

Toutes ces op\u00e9rations s’ex\u00e9cutent avec les droits de l’utilisateur de la session. Une source non lisible, une source non modifiable ou une cible non lisible produit une erreur explicite.<\/p>\n

D\u00e9couvrir les listes connexes<\/h2>\n

L’op\u00e9ration relatedtypes<\/code> retourne les listes connexes disponibles pour un module et leur libell\u00e9 technique. Utilisez toujours ce libell\u00e9 dans relatedLabel<\/code> pour la lecture et dans relationIdLabel<\/code> pour l’ajout.<\/p>\n

\n

GET<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n

operation=relatedtypes\nsessionName=YOUR_SESSION_ID\nelementType=Accounts\n<\/code><\/pre>\n
Interroger une liste connexe<\/h2>\n
L’op\u00e9ration query_related<\/code> retourne les \u00e9l\u00e9ments d’une liste connexe. Le module indiqu\u00e9 dans la requ\u00eate doit correspondre \u00e0 celui annonc\u00e9 par relatedtypes<\/code> pour le libell\u00e9 choisi.<\/p>\n
curl "https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php?operation=query_related&sessionName=YOUR_SESSION_ID&id=21x3456&relatedLabel=Documents&query=SELECT%20*%20FROM%20Documents%20WHERE%20filesize%20%3E%2010000"\n<\/code><\/pre>\n
retrieve_related<\/code> permet \u00e9galement de lire une liste connexe selon la pagination standard de l’API.<\/p>\n
Ajouter un \u00e9l\u00e9ment \u00e0 une liste connexe<\/h2>\n
L’op\u00e9ration add_related<\/code> compl\u00e8te une liste connexe existante. Elle ne convient pas aux kits, car une composition de kit porte une quantit\u00e9 et des r\u00e8gles m\u00e9tier suppl\u00e9mentaires.<\/p>\n
\n
POST<\/strong> https:\/\/apps.kafinea.com\/{instance}\/webservice.php<\/code><\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n\n\n
Param\u00e8tre<\/th>\nType<\/th>\nRequis<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
operation<\/code><\/td>\nstring<\/td>\noui<\/td>\nDoit \u00eatre add_related<\/code><\/td>\n<\/tr>\n
sessionName<\/code><\/td>\nstring<\/td>\noui<\/td>\nIdentifiant de session<\/td>\n<\/tr>\n
sourceRecordId<\/code><\/td>\nstring<\/td>\noui<\/td>\nID Webservice de l’\u00e9l\u00e9ment source<\/td>\n<\/tr>\n
relationIdLabel<\/code><\/td>\nstring<\/td>\noui<\/td>\nLibell\u00e9 technique retourn\u00e9 par relatedtypes<\/code><\/td>\n<\/tr>\n
relatedRecordId<\/code><\/td>\nstring ou tableau<\/td>\noui<\/td>\nUn ou plusieurs ID Webservice du m\u00eame module<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d "operation=add_related" \\\n  -d "sessionName=YOUR_SESSION_ID" \\\n  -d "sourceRecordId=21x3456" \\\n  -d "relationIdLabel=Documents" \\\n  -d "relatedRecordId=15x7890"\n<\/code><\/pre>\n
Si le libell\u00e9 ne d\u00e9signe aucune liste connexe compatible, l’API renvoie une erreur au lieu de signaler un succ\u00e8s sans modification.<\/p>\n
La liste des produits sp\u00e9cifiques constitue un cas de relation d\u00e9pendante : ajouter un produit \u00e0 cette liste met \u00e0 jour sa fiche pour lui affecter le produit g\u00e9n\u00e9rique comme parent. L’utilisateur doit donc pouvoir modifier les deux produits. Les validations m\u00e9tier et le recalcul tarifaire sont identiques \u00e0 ceux de l’\u00e9cran Kafinea. Consultez Produits g\u00e9n\u00e9riques et sp\u00e9cifiques<\/a> pour les exemples complets.<\/p>\n
Manipuler les liens qualifi\u00e9s<\/h2>\n
Les liens qualifi\u00e9s sont des entit\u00e9s \u00e0 part enti\u00e8re. Ils se cr\u00e9ent, se lisent, se modifient et se suppriment donc avec les op\u00e9rations CRUD<\/a>, comme les autres donn\u00e9es Kafinea. Aucun endpoint sp\u00e9cialis\u00e9 n’est n\u00e9cessaire.<\/p>\n
Le nom de module \u00e0 utiliser est :<\/p>\n
MdsEntityLink\n<\/code><\/pre>\n
Exemple de cr\u00e9ation :<\/p>\n
curl -X POST https:\/\/apps.kafinea.com\/YourKafinea\/webservice.php \\\n  -d "operation=create" \\\n  -d "sessionName=YOUR_SESSION_ID" \\\n  -d "elementType=MdsEntityLink" \\\n  --data-urlencode 'element={"source_id":"46x101","target_id":"46x102","link_type":"blocks"}'\n<\/code><\/pre>\n
Champs utiles :<\/p>\n
\n\n\n\n\n\n\n\n
Champ<\/th>\nR\u00f4le<\/th>\n<\/tr>\n<\/thead>\n
source_id<\/code><\/td>\n\u00c9l\u00e9ment \u00e0 l’origine du lien<\/td>\n<\/tr>\n
target_id<\/code><\/td>\n\u00c9l\u00e9ment cibl\u00e9<\/td>\n<\/tr>\n
link_type<\/code><\/td>\nQualification : relates_to<\/code>, blocks<\/code>, duplicates<\/code> ou parent_of<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
La cr\u00e9ation refuse les auto-liens, les doublons, les cycles hi\u00e9rarchiques et toute r\u00e9f\u00e9rence que l’utilisateur ne peut pas lire. Pour retrouver ou supprimer un lien, utilisez respectivement query<\/code> ou retrieve<\/code>, puis delete<\/code> avec l’ID Webservice retourn\u00e9.<\/p>\n
R\u00e9f\u00e9rences associ\u00e9es<\/h2>\n