Look up configured conversion-table rows from an external application. The API returns matching rows and their cells; it does not create or modify tables.
Base path: /api/rest/conversions. Required permission: API_ConversionTable_Lookup, included in API ConversionTable View. See API Conventions for shared setup.
.NET clients
For .NET clients, we recommend using the Bizbrains.Link.Api.Proxy NuGet package. See .NET client library for the public NuGet feed, supported APIs, and shared guidance.
Select rows
Use POST /row-lookup/{conversionTableName} for global rows, or append /{partnerIdentification} for a partner-specific lookup. Despite the parameter name, this value is the partner's Link key/EdiPortalId, not a GLN or other arbitrary identification value.
The body contains cellValues, each with columnName and value. Comparisons of column names and values are case-insensitive. Multiple columns form an AND condition. A column may occur only once in a lookup.
For a partner lookup:
-
Search rows belonging to that partner and global rows.
-
If matching partner rows exist, return those in preference to matching global rows.
-
If there are no matches, use the partner's default row, otherwise the global default row, if available.
Without a partner, only global rows and the global default are considered. An empty cellValues array returns the applicable unfiltered rows, still applying partner-row precedence. An unknown column produces zero rows rather than default fallback. Selecting a different partner than a table's owning partner also produces zero rows.
Partner selection determines the lookup's data; this REST flow does not bind the selected partner to the authenticated user's partner.
Example
Assume a configured table CountryCodes with columns SourceCode and TargetCode, containing a global mapping from DK to the receiving system's country code:
LINK_API_BASE='https://<your-link-api-host>'
LINK_PAT='<your-personal-access-token>'
curl --silent --show-error --fail-with-body \
--user ":${LINK_PAT}" \
--header 'Content-Type: application/json' \
--data '{"cellValues":[{"columnName":"SourceCode","value":"DK"}]}' \
"${LINK_API_BASE}/api/rest/conversions/row-lookup/CountryCodes"
The 200 response contains rows and numberOfRows. Each row has a cells collection, isDefault, and partnerIdentification. Locate the cell by its columnName; do not depend on a particular array position. Check isDefault if an explicit match is required by your integration, and handle zero or multiple rows.
For a partner lookup, append the percent-encoded partner key to the URL. The same request body applies.
Multiple lookups
POST /row-lookup accepts lookupRequests, each containing conversionTableName, optional partnerIdentification, cellValues, and a client-supplied requestLookupId. The response contains lookupResults with the identifiers repeated. Use those identifiers to associate results with requests.
Each lookup is evaluated independently; the request is not a consistent snapshot of several tables. In the multi-lookup operation, a lookup failure handled by the single-lookup controller can appear as a result without rows, rather than a failed overall HTTP status. Check every result before using it.
Lookup errors
A single lookup with an unknown partner key returns 404. An unknown table name currently throws an exception handled as 500; duplicate column conditions also fail. Unknown columns return an empty result. Correct the table, partner, or column names rather than repeatedly retrying an unchanged request.