IOT - CoAP - send message
Search form
Description - Send a Constrained Application Protocol message
Runtime Class - com.ibi.agents.XDCoapEmitAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description
Method: string The method of the request. Both POST and PUT send the current document as payload.
Select from one of the following options:
- GET
- POST
- PUT
- DELETE
Content Type: string The content type of the request to be sent. Select a format name or enter a numeric value between 0 and 65535 inclusive. Ignored for GET or DELETE.
Select from one of the following options:
- text/plain
- text/csv
- text/html
- application/link-format
- application/xml
- application/octet-stream
- application/rdf+xml
- application/soap+xml
- application/atom+xml
- application/xmpp+xml
- application/exi
- application/fastinfoset
- application/soap+fastinfoset
- application/json
- application/x-obix-binary
- image/gif
- image/jpeg
- application/vnd.oma.lwm2m+tlv
- image/png
- application/vnd.oma.lwm2m+json
- image/tiff
- application/cbor
Confirmable: boolean Whether this request needs to be confirmed with an acknowledgment. Ignored for reliable protocols.
* - denotes required
Parameter Type Description
Content Type: string Restrict the type of message being sent in via a POST or PUT. Leave blank, select a format name or enter a numeric value between 0 and 65535 inclusive.
Select from one of the following options:
- text/plain
- text/csv
- text/html
- application/link-format
- application/xml
- application/octet-stream
- application/rdf+xml
- application/soap+xml
- application/atom+xml
- application/xmpp+xml
- application/exi
- application/fastinfoset
- application/soap+fastinfoset
- application/json
- application/x-obix-binary
- image/gif
- image/jpeg
- application/vnd.oma.lwm2m+tlv
- image/png
- application/vnd.oma.lwm2m+json
- image/tiff
- application/cbor
* - denotes required
Parameter Type Description
Namespace: string The special register namespace from which HTTP headers for the outgoing request will be taken.
Select from one of the following options:
- Default Namespace {default}
- None {none}
* - denotes required
Parameter Type Description
Namespace: string The special register namespace into which HTTP headers from the incoming response will be saved.
Select from one of the following options:
- Default Namespace {default}
* - denotes required
Parameter Type Description
Return Document: string Whether the output document will be the response, a status document or the input document.
Select from one of the following options:
- Response {response} - response will be the out document.
- Status {status} - status document will be the out document.
- Input {input} - input document will be the out document
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDCoapEmitAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description
Method: string The method of the request. Both POST and PUT send the current document as payload.
Select from one of the following options:
- GET
- POST
- PUT
- DELETE
Content Type: string The content type of the request to be sent. Select a format name or enter a numeric value between 0 and 65535 inclusive. Ignored for GET or DELETE.
Select from one of the following options:
- text/plain
- text/csv
- text/html
- application/link-format
- application/xml
- application/octet-stream
- application/rdf+xml
- application/soap+xml
- application/atom+xml
- application/xmpp+xml
- application/exi
- application/fastinfoset
- application/soap+fastinfoset
- application/json
- application/x-obix-binary
- image/gif
- image/jpeg
- application/vnd.oma.lwm2m+tlv
- image/png
- application/vnd.oma.lwm2m+json
- image/tiff
- application/cbor
Confirmable: boolean Whether this request needs to be confirmed with an acknowledgment. Ignored for reliable protocols.
* - denotes required
Parameter Type Description
Content Type: string Restrict the type of message being sent in via a POST or PUT. Leave blank, select a format name or enter a numeric value between 0 and 65535 inclusive.
Select from one of the following options:
- text/plain
- text/csv
- text/html
- application/link-format
- application/xml
- application/octet-stream
- application/rdf+xml
- application/soap+xml
- application/atom+xml
- application/xmpp+xml
- application/exi
- application/fastinfoset
- application/soap+fastinfoset
- application/json
- application/x-obix-binary
- image/gif
- image/jpeg
- application/vnd.oma.lwm2m+tlv
- image/png
- application/vnd.oma.lwm2m+json
- image/tiff
- application/cbor
* - denotes required
Parameter Type Description
Namespace: string The special register namespace from which HTTP headers for the outgoing request will be taken.
Select from one of the following options:
- Default Namespace {default}
- None {none}
* - denotes required
Parameter Type Description
Namespace: string The special register namespace into which HTTP headers from the incoming response will be saved.
Select from one of the following options:
- Default Namespace {default}
* - denotes required
Parameter Type Description
Return Document: string Whether the output document will be the response, a status document or the input document.
Select from one of the following options:
- Response {response} - response will be the out document.
- Status {status} - status document will be the out document.
- Input {input} - input document will be the out document
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
Parameter | Type | Description | |
---|---|---|---|
Method: | string | The method of the request. Both POST and PUT send the current document as payload.
Select from one of the following options:
|
Content Type: | string | The content type of the request to be sent. Select a format name or enter a numeric value between 0 and 65535 inclusive. Ignored for GET or DELETE.
Select from one of the following options:
|
Confirmable: | boolean | Whether this request needs to be confirmed with an acknowledgment. Ignored for reliable protocols. |
* - denotes required
Parameter | Type | Description | |
---|---|---|---|
Content Type: | string | Restrict the type of message being sent in via a POST or PUT. Leave blank, select a format name or enter a numeric value between 0 and 65535 inclusive.
Select from one of the following options:
|
* - denotes required
Parameter | Type | Description | |
---|---|---|---|
Namespace: | string | The special register namespace from which HTTP headers for the outgoing request will be taken.
Select from one of the following options:
|
* - denotes required
Parameter | Type | Description | |
---|---|---|---|
Namespace: | string | The special register namespace into which HTTP headers from the incoming response will be saved.
Select from one of the following options:
|
* - denotes required
Parameter | Type | Description | |
---|---|---|---|
Return Document: | string | Whether the output document will be the response, a status document or the input document.
Select from one of the following options:
|
* - denotes required
Output Events
Name | Description |
---|---|
onFailParse | Could not parse a document. |
onFailOperation | Could not perform the operation requested. |
onFailTimeout | The operation timed out. |
onFailClient | Client error status code between 400 and 499. |
onFailServer | Server error status code between 500 and 599. |