# REST connector

The REST connector is a implementation used for connecting to remote systems that are using the REST protocol.

## Configuration <a href="#configuration" id="configuration"></a>

Below are all the parameters you can specify on this connector.

| name               | description                                |
| ------------------ | ------------------------------------------ |
| connectTimeout     | the connection timeout in milliseconds     |
| requestTimeout     | the request timeout in milliseconds        |
| url                | the URL of the remote system               |
| authenticationType | the authentication type (BASIC/OAUTH/NONE) |
| username           | the username for BASIC authentication      |
| password           | the password for basic authentication      |

## Supported functions <a href="#supported-functions" id="supported-functions"></a>

Below are the implemented operations on this connector.

| name                   | supported | description                                         |
| ---------------------- | --------- | --------------------------------------------------- |
| create                 | yes       | implemented with POST                               |
| find                   | yes       | implemented with GET on id                          |
| search                 | yes       | implemented with GET on /search with searchcriteria |
| update                 | yes       | implemented with PUT                                |
| delete                 | yes       | DELETE on id                                        |
| disable                | no        |                                                     |
| archive                | no        |                                                     |
| unarchive              | no        |                                                     |
| ping                   | yes       | pings the connection : OPTIONS request              |
| validate configuration | yes       | validates the configuration on init                 |

## Open issues <a href="#open-issues" id="open-issues"></a>

* sorting
* paging