REST Client Endpoint Definition

The REST Client Endpoint Definition page allows you to configure how the target REST API implements its create, update and delete operations.

Available Toolbar Commands

	Click the Done icon in the toolbar and return to the REST Export Client Specification.
	Click the Cancel icon in the toolbar to close this window without saving any changes.
	Click the Help balloon to open the help for this page.

Fields

Option Name

Description - Usage - Notes

Cross Reference Name

Select the cross-reference file associated with this REST API from the list of cross-reference files. To create a cross-reference file, use the Define | Cross-Reference Files page.

Create

Option	Usage
HTTP Verb	Indicates which HTTP verb to use when creating a record using the REST API. In most cases you will choose the “POST” HTTP verb. If the REST API does not support a create operation, set this field to (none).
Endpoint	If an HTTP verb has been specified, the value in this field will be appended to the base URL in the DSN referenced in the service used to run this export. Otherwise, leave this field blank.
Remote ID XPath	If an HTTP verb has been specified, enter a valid XPath expression that will be used to find the remote system’s identifier (XID) in the response generated from the REST API. If the REST API does not return an XID use the literal "{%u2id}".

Update

Option	Usage
HTTP Verb	Indicates which HTTP verb to use when updating a record using the REST API. In most cases you will choose the “PUT” HTTP verb. If the REST API does not support an update operation, set this field to (none).
Endpoint	If an HTTP verb has been specified, the value in this field will be appended to the base URL in the DSN referenced in the service used to run this export. Otherwise, leave this field blank.

Delete

Option	Usage
HTTP Verb	Indicates which HTTP verb to use when deleting a record using the REST API. In most cases you will choose the “DELETE” HTTP verb. If the REST API does not support a delete operation, set this field to (none).
Endpoint	If an HTTP verb has been specified, the value in this field will be appended to the base URL in the DSN referenced in the service used to run this export. Otherwise, leave this field blank.

Asynchronous Message Queue

Some API’s use a integration model referred to the “fire-and-forget”. The DSN specified in this field is used to request status updates for each request sent to the API so that the request status can be logged in the integration timeline.