Using an Export Endpoint

Browser

To get to the Export Endpoint Browser got to the Endpoint Table list and click on the Globe icon in the last column of an Export Endpoint which has the Data Collection referenced you want to retrieve.

This will bring you to the Export Endpoint Browser. On the left side are all Access Points for the selected Export Endpoint. On the right side you can see the Browser where you can configure your Payload.
You can change the Access Point by either using the accordion on the left side or the Endpoint Filter select box in the Browser.

Keep in mind that the search result will always consider the Filter and the Formatting of the selected Access Point.
For more information about the Browser read the Browser article.

Programming

To get the URL of your Export Endpoint, go to the Wizard of your Endpoint and go to the Endpoint step.

With the selected URL you can make a POST request.

Headers

In the headers you have to provide an API Key as Authorization.
You have to use the API Key of one of the Access Points of the Export Endpoint.
You can omit the Authorization header if you use the Public (Owl) Access Point of the Export Endpoint. (The public Access Point must be defined in the Export Endpoint)
The Access Point defines the used Filter and Formatting.
You can get the API Key from the API Key editor in the API Key field. The status of the selected API Key must be active.

The content type is always application/json.

{
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}

Body

The body represents the query of your request where you can send a stringified object with a filter object, a changes object and a limit string.

{
  "filter": {},
  "changes": {},
  "limit": "0,10"
}

The filter and changes object are the same as explained in the Browser article. The limit are two numbers which are comma separated. The first number is the offset which is the index it starts accumulating the response. This value is equivalent to the “start” value of the Browser. The second number is the maximum number of records it should respond with. This is equivalent to the “limit” value of the Browser.

In JavaScript a fetch would look like this:

fetch(
  'https://api.saws.de/sawsdeveloper/my-export-endpoint',
  { 
    method: 'POST',
    headers: {
      Authorization: '<api-key>',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ limit: '0,1' })
  }
)

Response

The response will always use the shape of the configured Document Format of the selected Access Point. Individual Records will have the shape of the referenced Record Format in the Document Format of the Access Point.