Using Special Functions

Data in the integrated system's REST API may be shaped so that it cannot be matched directly to the ALM REST API. For example, the integrated system may store a value in a list, while ALM needs a scalar value. In that case you can use special functions.

Filter collection items
"ChangeRequest": {
      "ExternalId": "relations:(rel=System\\.LinkTypes\\.Hierarchy-Reverse).url"
}

In this example, the ExternalId attribute of the ChangeRequest entity is set to the url field of the object in the relations collection whose rel attribute equals "System.LinkTypes.Hierarchy-Reverse".

Take a specific collection item
"ChangeRequest": {
      "ExternalId": "relations:first.url"
}

In this example, the ExternalId attribute of the ChangeRequest entity is set to the url field of the first object in the relations collection. Instead of the keyword first, you can use a number that explicitly specifies the item's position in the collection.

Convert a collection to a string
"GitlabLabels": "join(labels)"

In this example, the GitlabLabels attribute is set to a string that lists the Gitlab task labels, separated by commas.