GET /scheduled-calls/{id}/
Returns an Scheduled Call.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
<span class="warning"><span class="glyphicon glyphicon-warning-sign" aria-hidden="true"> Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
The $expand system query option specifies the related resources to be included in line with retrieved resources.
The value passed in the parameter can be:
The $expand system query option can be used with the $levels query option, to expand recursively.
Object Name: ScheduledCall
| Property Name | Type | Description | Method |
|---|---|---|---|
| Method (optional) |
String | Allowed values: POST, GET, PUT, DELETE Default value: POST |
GET POST |
| Path (required) |
String | The path of the request. Query Parameters are supported. |
GET POST |
| Headers (optional) |
Object | This is the header in json format used for the request: | GET POST |
| Id (required) |
String | This property is used to uniquely identify the Scheduled Call. | GET POST |
| Trigger (required) |
Object | A trigger object to launch the execution of the call. | GET POST |
| Destinations (required) |
Array Array <Destination> | List of destinations where the response of the executed call is sent | GET POST |
| Status | Object | GET | |
| Body (optional) |
String | For POST requests, it contains the payload in json string or xml string according to the Content-Type header. The strings need to be escaped. | GET POST |
"headers\": {
"accept\":\"application/xml\"
"content-Type\":\"application/xml\"
}
Object Name: Trigger
| Property Name | Type | Description | Method |
|---|---|---|---|
| Type | String | Defined the type of the trigger. Supported values: - cronExpression - bacnetCov - networkValue |
GET POST |
| CronExpression | String | A CRON expression to schedule the execution of the call. Required when the type of the trigger is cronExpression | GET POST |
| BacnetObject | Object | This object is a BACnet object. A BACnet object is composed of an object type, an object instance. Required when the type of the trigger is bacnetCov | GET POST |
| Index | Integer | This is the unique identifier of the network value. Required when the type of the trigger is networkValue | GET POST |
Object Name: Destination
| Property Name | Type | Description | Method |
|---|---|---|---|
| Initiator (optional) |
String | Free text used to identify easily the initial call from its response. | GET POST |
| Type (required) |
String | Determines the type of the recipient for the response. List of supported types: - iotHub |
GET POST |
| Result | String | GET | |
| Message | String | GET |
Object Name: Destinations
| Property Name | Type | Description | Method |
|---|---|---|---|
| Destinations (required) |
Array Array <Destination> | List of destinations where the response of the executed call is sent | GET POST |
Object Name: Status
| Property Name | Type | Description | Method |
|---|---|---|---|
| LastExecutionTime | String | GET | |
| NextExecutionTime | String | GET | |
| ResponseCode | Integer | GET | |
| DestinationResults | Array <Destination> | GET |
Object Name: DestinationResults
| Property Name | Type | Description | Method |
|---|---|---|---|
| DestinationResults | Array <Destination> |
GET |
Object Name: BacnetObject
| Property Name | Type | Description | Method |
|---|---|---|---|
| ObjectType | String | This is the type name of the BACnet object. | GET |
| ObjectInstance | Integer | This property is the instance of the BACnet object. | GET |
URL Example: https://0.0.0.0/api/rest/v1/scheduled-calls/analog-values-rpm
{
"path": "/protocols/bacnet/local/objects/read-property-multiple",
"id": "analog-values-rpm",
"destinations": [
{
"type": "iotHub",
"initiator": "CF"
}
],
"body": "{\"encode\": \"text\",\"propertyReferences\": [{\"type\": \"analogValue\",\"instance\": 1,\"property\":\"objectName\"},{\"type\":\"analogValue\",\"instance\": 2,\"property\":\"presentValue\"}]}",
"method": "post",
"trigger": {
"type": "cronExpression",
"cronExpression": "* * * * *"
},
"status": {
"responseCode": 200,
"lastExecutionTime": "2020-02-13T21:00:00.148+00:00",
"destinationResults": [
{
"type": "iotHub",
"result": "SUCCESS"
}
],
"nextExecutionTime": "2020-02-13T21:01:00+00:00"
}
}
URL Example: https://0.0.0.0/api/rest/v1/scheduled-calls/analog-values-rpm
<?xml version="1.0" encoding="utf-8"?>
<ScheduledCall>
<Id>analog-values-rpm</Id>
<Body>{"encode": "text","propertyReferences": [{"type": "analogValue","instance": 1,"property":"objectName"},{"type":"analogValue","instance": 2,"property":"presentValue"}]}</Body>
<Trigger>
<Type>cronExpression</Type>
<CronExpression>* * * * *</CronExpression>
</Trigger>
<Destinations>
<Destination>
<Initiator>CF</Initiator>
<Type>iotHub</Type>
</Destination>
</Destinations>
<Path>/protocols/bacnet/local/objects/read-property-multiple</Path>
<Method>post</Method>
<Status>
<LastExecutionTime>2020-02-13T16:02:00.116-05:00</LastExecutionTime>
<NextExecutionTime>2020-02-13T16:03:00.000-05:00</NextExecutionTime>
<ResponseCode>200</ResponseCode>
<DestinationResults>
<Destination>
<Type>iotHub</Type>
<Result>SUCCESS</Result>
</Destination>
</DestinationResults>
</Status>
</ScheduledCall>