REST Endpoint

It is possible to set up and export definition that will serve as a GET endpoint, to be used by external systems.

The external party will have to do a GET call to https://connectitapi.idyn.nl/api/v2/WebServices, using the following headers:

Key	Value

Key	Value
Tenant (4)	See image below
Environment (3)	See image below
Company	See image below
Id	Definition No. of the export definition
Content-Type (1)	application/json
Base-URL (2)	The Base URL for webservices
Accept	application/json or application/xml or text/xml

It is only possible to post a JSON body. XML input is not supported.
Base-URL should not be provided for Microsoft SAAS tenants.
Should not be provided for OnPrem installations.
Should only be provided for multi-tenant installations.

Additionally it is possible to configure fields to use as Query Parameters. This configuration determines which query parameters are available, and against which table field this is filtered.

This does not mean that all query parameters configured on the definition is required, it only determines which parameters are checked to filter data.

Selecting a field number to include as query parameter will automatically set the parameter key to the field name, however you can change the key name that is expected for the query parameter.

When setting this example up in Postman to test the output, the following is expected in the Headers:

On the Params tab we can optionally add the query parameters that are configured on the Export Definition. For the filter text, the same filter options can be used as in the filters in the Export Definitions.

The example below includes using numeric values for enums/options, use a wildcard in text and use a range between 2 values.

For more information on how to authenticate to the service, please check the authentication chapter.