Add relationship via Agile PLM SDK

I’m developing an scala application (it’s more or less the same like a java application for Agile PLM) using Agile PLM API. Everything works so far, adding attachments, adding BOM items, creating items and so on. But when creating Relationships in the Relationship Table, I always get this error:
com.agile.api.APIException: Invalid parameter.
at com.agile.api.pc.Session.createError(
at com.agile.api.pc.APIObject.createError(
at com.agile.api.pc.TableRelationships.convertCreateParamMapToVOCells(
at com.agile.api.pc.TablePC.doCreateServerRowWithParam(
at com.agile.api.pc.Table.createTableRow(
at com.agile.api.pc.Table.createRow(

The Agile API requires a hashmap with attributes and values as parameter to create the relationship. So this is my code:

val cells: java.utils.Map[_, _] = Map(
    Attrs.Items.Relationships.CriteriaMet -> null,
    Attrs.Items.Relationships.TypeImage -> 666, // id of item type as Integer
    Attrs.Items.Relationships.Name -> 'foo', // name as String
    Attrs.Items.Relationships.Description -> 'bar', // the description as String
    Attrs.Items.Relationships.CurrentStatus -> 'Production', // lifecyclephase 'Production' as a String
    Attrs.Items.Relationships.Rule -> null,
    Attrs.Items.Relationships.Type -> 600 // id of item type as Integer


The relationshipTable instance is of type ITable and this kind of Map is working for adding BOM items and attachments, so I think this is not the issue here. I simply queried the cells of existing relationships manually and compared their key with my constants used in this map and they are the same. I really don’t know what the invalid parameter is. Is there an attribute missing? Is the type of an parameter wrong? There is no indication what’s wrong.

Add Comment
1 Answer(s)

Ok, the answer was quite simple, despite it works different than for the BOM and it is not documented.

The solution is simply passing the iitem you want to add as a relationship: relationshipTable.createRow(iitem)

Agile User Answered on April 7, 2021.
Add Comment

Your Answer

By posting your answer, you agree to the privacy policy and terms of service.