GET /protocols/bacnet/local/objects/schedule/{objectInstance}/properties/exception-schedule
FROM API REVISION 6.0
This resource is used to initialize the Exception Schedule of a BACnet Schedule object.
This resource will represent a BacnetProperty object.
The value property of this object is an Array of SpecialEvent.
There is four types of special event that can be created:
The example below contains a SpecialEvent array with all the type above.
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.
WARNING: 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:
*"(star): This will show all child elements.," (comma).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.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
This is the instance of a specific BACnet object type.
The Content-Length entity-header field indicates the size of the entity-body.
Object Name: BacnetProperty
| Property Name | Type | Description | Method |
|---|---|---|---|
| Name | String | This property is the name of the BACnet property. | GET |
| IsArray | Boolean | This property indicates if the BACnet property is an array or not. | GET |
| Implementation | String | GET | |
| AsnValue | String | This property is the ASN value of a BACnet property encoded in Base64. | GET |
| Value required |
String | This property is the readable value of a BACnet property. According the BACnet property, it's possible the type of this property vary. (See the description of the resource for more details) |
GET POST |
Object Name: TimeValue
| Property Name | Type | Description | Method |
|---|---|---|---|
| Value required |
Integer | This is the value of the TimeValue object. The type of this property will depend of the Type property value. If the type property is : - Enumerated or Numeric : The type will be Integer. - Boolean : The type will be Boolean. - Null : The type will be Null (empty in XML and null in JSON : See example). |
GET POST |
| Type required |
String | Possible values: - Enumerated - Boolean - Numeric - Null |
GET POST |
| Time required |
String | This is the time value. It can follow two formats: - 08:00 - 08:00:00.00 |
GET POST |
Object Name: SpecialEvent
| Property Name | Type | Description | Method |
|---|---|---|---|
| Type required |
String | This property needs to contain the type of the object send with it. It can be : - SimpleDate - WeekAndDay - DateRange - Reference |
GET POST |
| SimpleDate required |
Object | This object contains a Date, a DayOfWeek and the TimeValues (the last one is optional : It depends of the use case). | GET POST |
| WeekAndDay | Object | GET POST |
|
| DateRange | Object | GET POST |
|
| Reference | Object | GET POST |
Object Name: SimpleDate
| Property Name | Type | Description | Method |
|---|---|---|---|
| Date required |
String | This can be : - 2018-08-01 - 2018-08-* - 2018-*-* - *-*-* |
GET POST |
| DayOfWeek required |
String | This is the day of the week: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday \* (The number of star doesn’t matter) If a bad day is entered, the star(\*) will be set. |
GET POST |
| TimeValues optional |
Array <TimeValue> |
An array of TimeValue object. | GET POST |
Object Name: WeekAndDay
| Property Name | Type | Description | Method |
|---|---|---|---|
| DayOfWeek required |
String | This is the day of the week: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday \* (The number of star doesn’t matter) If a bad day is entered, the star(\*) will be set. |
GET POST |
| TimeValues optional |
Array <TimeValue> |
An array of TimeValue object. | GET POST |
| Week required |
Integer | These are the numbers allowed: - 1 → days1to7 - 2 → days8to14 - 3 → days15to21 - 4 → days22to28 - 5 → days29to31 - 6 → last7days - 255 → any |
GET POST |
| Month required |
String | This can be: - January - February - March - April - May - June - July - August - September - October - November - December \* (The number of star doesn’t matter) If a bad Month is entered, the star(*) will be set. |
GET POST |
Object Name: DateRange
| Property Name | Type | Description | Method |
|---|---|---|---|
| TimeValues optional |
Array <TimeValue> |
An array of TimeValue object. | GET POST |
| StartDate required |
String | This can be : - 2018-08-01 - 2018-08-* - 2018-*-* - *-*-* |
GET POST |
| EndDate required |
String | This can be : - 2018-08-01 - 2018-08-* - 2018-*-* - *-*-* |
GET POST |
Object Name: Reference
| Property Name | Type | Description | Method |
|---|---|---|---|
| TimeValues optional |
Array <TimeValue> |
An array of TimeValue object. | GET POST |
| ObjectType required |
String | The name of the object. Usually a calendar. | GET POST |
| ObjectInstance required |
Integer | The number of the instance. | GET POST |
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/schedule/1/properties/exception-schedule
{
"value": [
{
"type": "dateRange",
"dateRange": {
"timeValues": [
{
"value": 2,
"type": "enumerated",
"time": "09:00:00.00"
},
{
"value": null,
"type": "null",
"time": "13:00:00.00"
}
],
"startDate": "*-*-*",
"endDate": "*-*-*"
}
},
{
"type": "weekAndDay",
"weekAndDay": {
"timeValues": [
{
"value": 4,
"type": "enumerated",
"time": "12:00:00.00"
},
{
"value": null,
"type": "null",
"time": "14:00:00.00"
}
],
"month": "***",
"dayOfWeek": "***",
"week": 255
}
},
{
"type": "simpleDate",
"simpleDate": {
"timeValues": [
{
"value": 1,
"type": "enumerated",
"time": "07:00:00.00"
},
{
"value": null,
"type": "null",
"time": "10:00:00.00"
}
],
"date": "*-*-1",
"dayOfWeek": "***"
}
},
{
"type": "reference",
"reference": {
"timeValues": [
{
"value": 3,
"type": "enumerated",
"time": "08:00:00.00"
},
{
"value": null,
"type": "null",
"time": "16:00:00.00"
}
],
"objectInstance": 1,
"objectType": "calendar"
}
}
],
"asnValue": "Dh6k/////6T/////Hw8utAkAAACRArQNAAAAAC85EA4r////Dy60DAAAAJEEtA4AAAAALzkQDgz//wH/Dy60BwAAAJEBtAoAAAAALzkQHAGAAAEutAgAAACRA7QQAAAAAC85EA==",
"isArray": false,
"implementation": "",
"name": "exceptionSchedule"
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/schedule/1/properties/exception-schedule
<?xml version="1.0" encoding="utf-8"?>
<BacnetProperty>
<Name>exceptionSchedule</Name>
<IsArray>false</IsArray>
<Implementation />
<AsnValue>
Dh6k/////6T/////Hw8utAkAAACRArQNAAAAAC85EA4r////Dy60DAAAAJEEtA4AAAAALzkQDgz//wH/Dy60BwAAAJEBtAoAAAAALzkQHAGAAAEutAgAAACRA7QQAAAAAC85EA==
</AsnValue>
<Value>
<SpecialEvent>
<Type>dateRange</Type>
<DateRange>
<StartDate>*-*-*</StartDate>
<EndDate>*-*-*</EndDate>
<TimeValues>
<TimeValue>
<Time>09:00:00.00</Time>
<Type>enumerated</Type>
<Value>2</Value>
</TimeValue>
<TimeValue>
<Time>13:00:00.00</Time>
<Type>null</Type>
<Value />
</TimeValue>
</TimeValues>
</DateRange>
</SpecialEvent>
<SpecialEvent>
<Type>weekAndDay</Type>
<WeekAndDay>
<DayOfWeek>***</DayOfWeek>
<Week>255</Week>
<Month>***</Month>
<TimeValues>
<TimeValue>
<Time>12:00:00.00</Time>
<Type>enumerated</Type>
<Value>4</Value>
</TimeValue>
<TimeValue>
<Time>14:00:00.00</Time>
<Type>null</Type>
<Value />
</TimeValue>
</TimeValues>
</WeekAndDay>
</SpecialEvent>
<SpecialEvent>
<Type>simpleDate</Type>
<SimpleDate>
<Date>*-*-1</Date>
<DayOfWeek>***</DayOfWeek>
<TimeValues>
<TimeValue>
<Time>07:00:00.00</Time>
<Type>enumerated</Type>
<Value>1</Value>
</TimeValue>
<TimeValue>
<Time>10:00:00.00</Time>
<Type>null</Type>
<Value />
</TimeValue>
</TimeValues>
</SimpleDate>
</SpecialEvent>
<SpecialEvent>
<Type>reference</Type>
<Reference>
<ObjectType>calendar</ObjectType>
<ObjectInstance>1</ObjectInstance>
<TimeValues>
<TimeValue>
<Time>08:00:00.00</Time>
<Type>enumerated</Type>
<Value>3</Value>
</TimeValue>
<TimeValue>
<Time>16:00:00.00</Time>
<Type>null</Type>
<Value />
</TimeValue>
</TimeValues>
</Reference>
</SpecialEvent>
</Value>
</BacnetProperty>