Skip to main content
GET
/
v3
/
mapping_data_sources
/
{identifier}
/
values
List values for a data source
curl --request GET \
  --url https://{region}.affinda.com/v3/mapping_data_sources/{identifier}/values \
  --header 'Authorization: Bearer <token>'
{
  "count": 10,
  "results": [
    {}
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

​
identifier
string
required

Data source's identifier Uniquely identify a mapping data source.

Example:

"mEFayXdO"

Query Parameters

​
limit
integer

The numbers of results to return.

Required range: 1 <= x <= 100
Example:

20

​
offset
integer

The number of documents to skip before starting to collect the result set.

Required range: x >= 0
Example:

0

​
search
string

Search for specific values

Example:

"Supplier XYZ"

​
annotation
integer

Filter based on annotation ID

Example:

124

​
document
string

Identifier of the document to apply filter lookups on if available

Example:

"stXkrhIY"

Response

Will return matching data source values

​
count
integer
required

Number of items in results.

Required range: x >= 0
Example:

10

​
results
object[]
required
​
next
string | null

URL to request next page of results.

​
previous
string | null

URL to request previous page of results.