API Url

The URL required to query the external Rest API.

Details of the URL need to be provided by the third party.

Example:
http://hrdata.com.au/rest/api/v1.1/contents

You can also define the URL as/with a constant (Designer Constants) and specify the constant ID over here.

Example:
|.HRDATA_URL| will substitute the constant with the URL mentioned in the Constants.

The below example will get the latest Incident date and substitute the constant with the actual date.

https://myserver/ehss/odata/incident?$filter=date(incident_date) gt |.LATEST_INCIDENT|

The URL must be formatted so that 3rd party system returns an Array, and not just a single record.

Token Configuration

Optional field, only required if the external API requires OAuth-style access token authentication

If the external system uses OAuth access tokens for authentication, you can setup the External API Token and select it here.

Array Selector

The Array Selector should return the array which needs to be processed for the import.

Example: $.value

You should use "$" if the JSON root element is an array itself.

Total Number of Pages Selector

For paginated APIs, enter the name of the selector which returns number of pages available from the Rest API, so the app can automatically make calls to request for subsequent pages and can determine when the last page has been reached.

For a JSON array like below, enter results.num_pages in the Total Number of Pages Selector field.

{

"results": {
"num_pages": 5,
"page": 1
}
}

Maximum Number of Pages

If the Total Number of Pages is not entered, the system defaults to this setting - the import will continue requesting pages until this limit is reached.

Defaulted to 100

Page Parameters

For paginated APIs, enter the name of the parameter that will be included in the Rest call URL to indicate which page number is to be retrieved.

Timeout

Time (in seconds) until the web application will time out the call.

Response Type

The format used by the external system to return its data.

Currently, the only supported format is JSON.

Directory Location

The location where the generated logs will be placed.

Header Configuration

Add all the required Key/Value pairs needed for the API Header.

Examples:

• Accept: */*
• APIKey: 12324567

Please contact the external system administrator for all the necessary details.