Read an effective Link setting or resolve a value using a document's associated configuration. This API provides values for an integration; it does not edit settings, partners, or distributions.
Base path: /api/rest/configuration. Shared setup is in API Conventions .
.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.
Access
Both permissions are included in API Configuration View:
|
Operation |
Permission |
|---|---|
|
Read a setting |
|
|
Read a document-related value |
|
Document-related reads follow the selected document's relations. This flow does not apply an additional current-user partner filter.
Effective settings
GET /setting/{key} returns {"value":"..."}. An environment-specific value takes precedence over the setting's common value. An unknown key or a setting without a value returns an empty string, not 404.
Document-related values
GET /document/{documentId}/{actionName}?actionKey=<key>
Use the numeric document ID and the exact action name. Important groups are:
|
Value needed |
Actions |
|
|---|---|---|
|
Document identifiers |
|
Not used |
|
Incoming transmission |
|
Not used |
|
Sender/receiver name or main identification |
|
Not used |
|
Partner configuration value |
|
Configuration key name |
|
Partner identification value |
|
Identification type name |
|
Distribution configuration value |
|
Configuration key name |
LookupPartnerOutIdByKey returns the partner's identification value, not its numeric Link ID. InterchangeInFileName resolves the stored incoming payload's filename. A missing document, missing relation/value, or unrecognized action normally returns 200 with value: null, so 200 alone does not establish that a value was found.
LookupTestIndicator is listed in the controller's action descriptions but is not implemented in this version. If reached for a document with a distribution, it fails with 500. Use another agreed source for that value.
Example
Assume ExternalSystemUrl is an agreed setting and CustomerAccount is a configured key on the receiving partner:
LINK_API_BASE='https://<your-link-api-host>'
LINK_PAT='<your-personal-access-token>'
DOCUMENT_ID='<numeric-document-id>'
curl --silent --show-error --fail-with-body \
--user ":${LINK_PAT}" \
"${LINK_API_BASE}/api/rest/configuration/setting/ExternalSystemUrl"
curl --silent --show-error --fail-with-body \
--user ":${LINK_PAT}" \
"${LINK_API_BASE}/api/rest/configuration/document/${DOCUMENT_ID}/LookupPartnerOutConfigurationKey?actionKey=CustomerAccount"
Check whether value is null or empty before using it. A missing value is not a transient HTTP error, and repeating the lookup will only help after the relevant configuration or document relation changes.