FindManagedObject

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.5.4.1

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.cumulocity
Event FindManagedObject

Find ManagedObject (that is, devices).

By default will return all ManagedObjects which match the criteria. You can set params to select which ManagedObjects to receive.

EPL sends to the SEND_CHANNEL, and transport will respond with 0+ FindManagedObjectResponse and then 1 FindManagedObjectResponseAck on FindManagedObjectResponse.SUBSCRIBE_CHANNEL channel.

See Also:: com.apama.cumulocity.FindManagedObjectResponse -; com.apama.cumulocity.FindManagedObjectResponseAck -

Constant summary
`string`	`CHANNEL := "CumulocityIoTGenericChain"` Channel to send these events to. Deprecated: [This channel constant has been deprecated. Use SEND_CHANNEL instead.]
`string`	`SEND_CHANNEL := "CumulocityIoTGenericChain"` Channel to send these events to.

Member summary
`integer`	`reqId` Identifier for this request; must be generated using com.apama.cumulocity.Util.generateReqId().
`string`	`deviceId` The unique identifier for this specific Device.
`dictionary<string, string>`	`params` Additional request params. 'fragmentType', 'type', 'owner', 'text', 'childAssetId', 'childDeviceId', 'childAdditionId', 'ids' (comma separated list of id's), 'pageSize', 'currentPage' can be provided.

Constant detail

CHANNEL

string CHANNEL := "CumulocityIoTGenericChain"

Deprecated:: [This channel constant has been deprecated. Use SEND_CHANNEL instead.]

Channel to send these events to.

SEND_CHANNEL

string SEND_CHANNEL := "CumulocityIoTGenericChain"

Channel to send these events to.

Since:: 10.5.2.0

Member detail

deviceId

string deviceId

The unique identifier for this specific Device.

params

dictionary<string, string> params

Additional request params. 'fragmentType', 'type', 'owner', 'text', 'childAssetId', 'childDeviceId', 'childAdditionId', 'ids' (comma separated list of id's), 'pageSize', 'currentPage' can be provided.

ids, fragmentType, type, owner, text, childAssetId, childDeviceId and childAdditionId restrict which managed objects will match
pageSize represents a batching parameter for getting multiple responses from Cumulocity. A larger pageSize will do fewer requests to Cumulocity to retrieve all the managed objects, but each will be larger
currentPage can be set to retrieve a specific page of results for the given pageSize. If you set current page then only a single page will be requested, rather than all of them

reqId

integer reqId

Identifier for this request; must be generated using com.apama.cumulocity.Util.generateReqId().