IoT Application Integration REST Endpoints

Sort by

Task Path Method

IoT Application Integration

An integration is an entity that an IoT Application utilizes to connect with an external enterprise application or cloud service (e.g. vertical business applications like BICS or JD Edwards etc.) An integration defines a set of streams to send data to an external application. A stream is essentially composed of a set of formats and optionally configuration & annotations. The type of integration defines the restriction on the number of streams that may be associated with an integration instance as well as specific restrictions on the composition of the streams themselves.

Create New Integration

Method: post

Path: /iot/api/v2/apps/{app-id}/integrations/

Create or Update an Integration Root Certificate, For the given Integration ID

Method: put

Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}/certificate

Delete Integration, Specified by ID

Method: delete

Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}

Delete the Root Certificate of an Integration, specified by ID

Method: delete

Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}/certificate

Invoke Synchronization

Method: post

Path: /iot/api/v2/apps/{app-id}/integrations/{id}/sync/now

Retrieve Integration Count

Method: get

Path: /iot/api/v2/apps/{app-id}/integrations/count

Retrieve Integration Details

Method: get

Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}

Retrieve Integration Root Certificate

Method: get

Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}/certificate

Retrieve messages of a specified Integration in an Application specified by ID

Method: get

Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}/messages

Retrieve the Last Synchronization Details

Method: get

Path: /iot/api/v2/apps/{app-id}/integrations/{id}/sync/

Retrieve the List of Integrations

Method: get

Path: /iot/api/v2/apps/{app-id}/integrations/

Update Integration Specified by ID

Method: put

Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}

Update Integration, specified by ID

Method: post

Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}