The following REST fields are available on the import definition card:
|URL||Specifies the URL for the REST request. Can be used in combination with temporary values to create a dynamic request URL.|
|Authorization Type|| Specifies the authorization used for the REST request. The following options are available:
On the REST tab of the import definition, select the correct authorization type. Under Request Information provide the URL.
In the URL you may want to add parameter values like page no. or for example the ID of an item you want to get details for.
In this case you will have to add %i (where i is an integer value) in the URL.
For example, in the below URL, %1 is added for the page no. value:
For more information on working with variable parameters in the URL, other than paging related parameters, check the Import Table Monitor section.
|Use Paging||Specifies if paging should be used for this definition. If enabled, the import will check if additional requests are needed to get the import data for all pages.|
|Paging Method|| Specifies the method that is used for paging. The following options are available:
|Page No. Element Name||Specifies the element name in the response content where the page number can be found. This is used to determine the next page number.|
|Position of ‘Page No.’ in URL (%1)||Specifies where in the REST request URL the page number should be placed. Use %1 as substitute variable in the URL.|
|Total Pages Element Name||Specifies the element name in the response content where the total page count can be found. This is used to determine if there is a next page.|
|Next Link Element Name||Specifies the element name in the response content where the next URL can be found. Is used with Paging Method Link where the complete next URL is expected in the response.|
Paging is avaliable for REST calls with data format JSON or XML. Currently there are two paging methods implemented, being:
- Page No., where you will have to provide the element names of the Current Page No. and Total Pages.
- Link, where you will have to provide the element name of the next URL.
|User Name (or Client-ID)||Specifies the username or client-id. This is used for authorization type Basic Authorization|
|Password (or Secret)||Specifies the password or secret. This is used for authorization type Basic Authorization|
|Bearer Token||Specifies the bearer token. This is used for authorization type Bearer Token. If a bearer token should be used, but should also automatically refresh using OAuth 2.0, use one of the OAuth2 authorization types instead.|
|OAuth2 Authorization Code||Specifies the OAuth2 authorization code where the OAuth 2.0 grant flow is configured. This is used for authorization type OAuth 2.0 Client Credential Grant, OAuth 2.0 Authorization Code Grant and OAuth 2.0 Custom Grant Flow.|
|Auth. Key Name||Specify the key name that will be used for authorization. This key will be added to the request headers. This is used for authorization type Custom.|
|Auth. Value||Specify the value for the key name that will be used for authorization. This is used for authorization type Custom.|
|Key||Key name to include as request header in the REST request.|
|Value||The value to assign to the request header key.|
If applicable, add lines in the request headers part to include additional headers to the REST request.
Need more help with this?