Applications
Method |
Path<br>h5. Parameters are case-sensitive |
Return Model |
Summary |
|---|
GET |
List all applications. |
||
GET |
Get details of an application. |
||
POST |
Subscribe an application to a event source. |
||
DELETE |
Unsubscribe an application from an event source. |
list: GET /applications
List all applications.
get: GET /applications/{applicationName}
Get details of an application.
Path parameters
Parameters are case-sensitive.
- applicationName: string - Application's name
Error Responses
- 404 - Application does not exist.
subscribe: POST /applications/{applicationName}/subscription
Subscribe an application to a event source. Returns the state of the application after the subscriptions have changed
Path parameters
Parameters are case-sensitive.
- applicationName: string - Application's name
Query parameters
- eventSource: string - (required) URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}
- Allows comma separated values.
Error Responses
- 400 - Missing parameter.
- 404 - Application does not exist.
- 422 - Event source does not exist.
unsubscribe: DELETE /applications/{applicationName}/subscription
Unsubscribe an application from an event source. Returns the state of the application after the subscriptions have changed
Path parameters
Parameters are case-sensitive.
- applicationName: string - Application's name
Query parameters
- eventSource: string - (required) URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}
- Allows comma separated values.
Error Responses
- 400 - Missing parameter; event source scheme not recognized.
- 404 - Application does not exist.
- 409 - Application not subscribed to event source.
- 422 - Event source does not exist.