com.apama.cumulocity
Event Operation
An operation to send to a device.
Examples: Create an operation, send Operation("","deviceId", "PENDING", {"c8y_Message":{"text":"Hello Cumulocity device"}}) to Operation.SEND_CHANNEL;
You can update the status field. send Operation("12345","deviceId", "EXECUTING", {}}) to Operation.SEND_CHANNEL;
Constant summary |
string | CHANNEL := "CumulocityIoTGenericChain"
Channel to send the events to.
-
Deprecated:
-
[This channel constant has been deprecated. Use SEND_CHANNEL for sending and SUBSCRIBE_CHANNEL for receiving events.]
|
string | SEND_CHANNEL := "CumulocityIoTGenericChain"
Channel for sending Operations. |
string | SUBSCRIBE_CHANNEL := "cumulocity.measurements"
Channel for receiving Operations. |
Member summary |
string | id
Unique identifier for this Operation. |
string | source
Identifier of the ManagedObject to send the operation to. |
string | status
Status of the operation : one of SUCCESSFUL, FAILED, EXECUTING or PENDING. |
dictionary<string, any> | params
Any extra parameters available on the Operation. |
Action summary |
com.apama.cumulocity.ResponseWrapper |
withResponse(integer reqId, dictionary<string, string> headers)
Create or update an Operation in Cumulocity and receive a response event confirming the change. |
CHANNEL
string CHANNEL := "CumulocityIoTGenericChain"
-
Deprecated:
-
[This channel constant has been deprecated. Use SEND_CHANNEL for sending and SUBSCRIBE_CHANNEL for receiving events.]
Channel to send the events to.
SEND_CHANNEL
string SEND_CHANNEL := "CumulocityIoTGenericChain"
Channel for sending Operations.
-
Since:
- 10.5.2.0
SUBSCRIBE_CHANNEL
string SUBSCRIBE_CHANNEL := "cumulocity.measurements"
Channel for receiving Operations.
-
Since:
- 10.5.2.0
id
string id
Unique identifier for this Operation.
Supply as empty if creating a new Operation
params
dictionary<string, any> params
Any extra parameters available on the Operation.
source
string source
Identifier of the ManagedObject to send the operation to.
status
string status
Status of the operation : one of SUCCESSFUL, FAILED, EXECUTING or PENDING.
withResponse
com.apama.cumulocity.ResponseWrapper withResponse(integer reqId, dictionary<string, string> headers)
Create or update an Operation in Cumulocity and receive a response event confirming the change.
Just sending an Operation is fire and forget. If your application requires an acknowledgement or the ID of the Operation created or updated, then use the withResponse API. This API will create an event that can be sent as normal and get a response from Cumulocity for the newly created or updated Operation. The responses are either an ObjectCommitted event or an ObjectCommitFailed event. The withResponse API also allows you to provide headers to the create or update request. For example: Operation o := new Operation;
// set fields in o
integer reqId := com.apama.cumulocity.Util.generateReqId();
send o.withResponse(reqId, {"X-Cumulocity-Processing-Mode": "PERSISTENT"}) to Operation.SEND_CHANNEL;
on ObjectCommitted(reqId=reqId) as commit and not ObjectCommitFailed(reqId=reqId) {
// do something
}
on ObjectCommitFailed(reqId=reqId) as failure and not ObjectCommitted(reqId=reqId) {
// do something
}
-
Parameters:
-
reqId - A request identifier generated from Util.generateReqId(). The response from Cumulocity will have the matching request identifier.
-
headers - Set headers of the create/update request. This can be used to explicitly control the processing mode of the create/update request.
-
See Also:
-
com.apama.cumulocity.ObjectCommitted - Successfully created or updated an Operation.
-
com.apama.cumulocity.ObjectCommitFailed - Failed to create or update an Operation.