|
Service
|
Description
|
|---|---|
|
EvaluateReporting
|
This service evaluates the Thing's Reporting status based on its strategy.
The following are the input parameters for the service:
• eventName: Name of the event
• eventTime: Time when the event is triggered
• source: Name of the Thing that triggered events
• sourceProperty: Source Property eventData
No output is received after executing this service.
|
|
GetEventSubscriptions
|
Get the events that are bound to the remote Thing.
No input is required for this service.
Executing this service returns the subscribed events for the Remote Thing in the form of an Infotable.
The following parameters are received after executing this service:
• Data Shape: EdgeThingEventNotification
• Infotable Type: Just Infotable
|
|
GetPropertySubscriptions
|
Get the properties plus data change type and data change threshold for the edge Thing.
The following are the input parameters for the service:
• options: Binding options supported by the calling SDK
Executing this service returns the subscribed properties for the Remote Thing in the form of an Infotable.
The following parameters are received after executing this service:
• Data Shape: EdgeThingEventNotification
• Infotable Type: Just Infotable
|
|
GetQueuedTasks
|
Retrieve any tasks for this connected Thing.
No input is required for this service.
Executing this service returns the Edge things in the form of an Infotable.
The following parameters are received after executing this service:
• Data Shape: MessageStoreList
• Infotable Type: Just Infotable
|
|
GetRemoteMetadata
|
Returns the metadata for the connected thing.
No input is required for this service.
Executing this service returns the Connected Thing metadata in JSON format.
|
|
GetReportingStrategy
|
Retrieves this Thing's reporting strategy.
No input is required for this service.
Executing this service returns the Connected Thing metadata in STRING format.
|
|
Invoke
|
The following are the input parameters for the service:
• endpointUri
• paramsTable
• headerParams
• resultType
Executing this service returns the output in the form of an Infotable.
|
|
ProcessRemoteEvents
|
Process remote events.
The following are the input parameters for the service:
• values
No output is received after executing this service.
|
|
ReceiveRouteLifecycleEvent
|
The following are the input parameters for the service:
• eventPayload
No output is received after executing this service.
|
|
RegisterRoute
|
The following are the input parameters for the service:
• routeXml
No output is received after executing this service.
|
|
SendMaxQueuedTasks
|
Sends up to a specific maximum number of queued tasks to the connected thing.
The following are the input parameters for the service:
• maxCount: The maximum number of messages desired by the edge device.
Executing this service returns the number of queued tasks sent, up to maxCount, in INTEGER format.
|
|
SendQueuedTasks
|
Sends any queued tasks to the connected thing.
No input is required for this service.
No output is received after executing this service.
|
|
SetReportingStrategy
|
Set this Thing's reporting strategy.
The following are the input parameters for the service:
• strategyThing: Name of the Strategy Thing.
No output is received after executing this service.
|
|
UpdateSubscribedPropertyValues
|
Write subscribed property values for a connected Thing.
The following is the input parameters for the service:
• values
No output is received after executing this service.
The values parameter is an InfoTable consisting of multiple rows, where each row contains the property name, value, and quality accompanied by the update timestamp. Property values cannot be set to null.
By default, the value updates are performed for each property separately. To have the values sorted and grouped by timestamp rather than by property, the GroupPropertyValuesByTime setting should be set to true in the BasicSettings section of platform-settings.json.
When the above setting is set to true, the data-triggered events and alerts for all properties updated with the same timestamp are fired together. As the result, multi-event subscriptions registered for some or all these events will execute only once per timestamp, having the matching events passed in the events parameter.
|
|
UpdateSubscribedPropertyValuesBatched
|
Write subscribed property values in batches for a connected Thing.
The following is the input parameters for the service:
• batches
No output is received after executing this service.
The batches parameter is an InfoTable consisting of multiple rows. Each row contains a batch of properties' values and the update timestamp.
The batch field value is an InfoTable consisting of multiple rows. Each row contains the property name, value, and quality. Property values cannot be set to null.
The properties' values are sorted and grouped by batches' timestamps, meaning that the data-triggered events and alerts for all properties updated with the same timestamp are fired together. As the result, multi-event subscriptions registered for some or all these events will execute only once per timestamp, having all matching events passed in the events parameter.
|