Add query parameters

Adding query parameters to an adapter call previously required a code change, because query parameters were not exposed as method parameters. Adding them was treated as a breaking change, so the Adapter Team would add a new call instead.

With iapMetadata, no new call or code change is required.

Pass query parameters via iapMetadata

If the adapter method has an iapMetadata parameter, pass query parameters inside a uriQuery object on that parameter. You can construct the iapMetadata object usingItential Platform workflow capabilities such as query and merge.

Structure:

1
{
2
  "uriQuery": {
3
    "<key1>": "<value1>"
4
  }
5
}

Example:

1
{
2
  "uriQuery": {
3
    "size": 20,
4
    "offset": 60
5
  }
6
}

If the adapter method does not have an iapMetadata parameter, you can request that the Adapter Team add it. Note that adding iapMetadata requires creating new methods — Itential does not modify existing method signatures to avoid breaking changes.