Altair SmartEdge API
(Altair SmartEdge)[https://www.altairsmartworks.com/smartedge-overview] makes edge communication, device provisioning, and data qualification fast and easy. It is the intersection between the edge devices and the cloud, aggregating and normalizing data streams from varied protocols and securely communicating this data to the cloud.
ABOUT Altair
Altair Vision: Altair transforms design and decision making by applying simulation, machine learning and optimization throughout product lifecycles.
SmartWorks Platform Goal:
Provide a simple but powerful framework for combining real-time data with simulation, machine learning and optimization to accelerate innovation and improve operational efficiency.
Altair, Inc. provides an IoT edge to cloud software framework which integrates networked devices over the web for control, monitoring and data acquisition in commercial and industrial buildings and sites. Altair’s framework unifies the myriad of protocols and designs utilized by millions of incompatible connected devices, enabling them to interoperate with each other regardless of make or model, via open web standards.
By simplifying connectivity across devices and protocols, Altair allows businesses to create web portals and software apps significantly faster, at lower cost. Universal, flexible and branded applications for control, monitoring and data acquisition can be operational in days, and require far less overhead and maintenance over time. Applications are built with industry standard tools and can operate on computers, smart phones and mobile tablets.
Altair’s enterprise and application software is used today to empower energy management and control applications for systems integrators, manufacturers and utilities. Altair-powered systems have been deployed in the United States, Canada, Australia, Europe and the United Kingdom.
For more information including use cases, compatibilities and example applications, please contact
Altair, Inc.
428 13th Street, 3rd Floor
Oakland, CA 94612
office: (510) 433-0900
fax: (510) 433-0333
email: (support-smartworks@altair.com)
(last updated 2020-11-30:10:54:23)
About This Document
This manual accompanies distributions of Altair’s Internet of Things Protocol (IOTP™) and IoT Server™. Altair’s IoT Server is software that runs on a variety of consumer and commercial embedded gateways, modems and other computing devices. Along with this manual, you have received Altair’s IoT Server either as a software distribution or embedded on a target hardware platform.
IoTP is an HTTPS-based “RESTful” API interface. It can be accessed from most current programming languages and operating systems or platforms. All responses from the RESTful API are formatted as JSON objects. Ancillary Altair supplied subsystems (e.g. PowerTools) make use of this interface as well.
This document presumes the reader is:
-
A programmer
-
Comfortable with JavaScript development language
-
Familiar with REST and JSON conventions
-
Familiar with IP networking conventions
Things this document does not cover:
-
Other Altair APIs
-
How to write code
-
JSON - www.json.org/
-
REST - REST architectural style
-
Google Cloud Pub/Sub - https://cloud.google.com/pubsub/
-
Microsoft Azure IoT Hub and Suite - https://azure.microsoft.com
-
Individual products or devices, their capabilities, or which products Altair supports
JSON Response Types
-
string: a collection of characters
-
numeric: a collection of digits
-
array: A collection of variables that can be strings, numbers, or even objects
-
oneOf: an array of options where there can be only one selected
-
anyOf: an array options where there can be 0 to all selected
-
onePlusOf: an array of options where there can be 1 to all selected
-
object: a place holder that groups the definitions of a subattribute (defined in
fieldName) of the device. It has anobjectproperty with many field definitions (which can have the same pair view, type as stated here) -
array: a place holder that groups the definitions of the items of an array. This array is a sub-attribute of the device (defined in
fieldName). It has alistproperty with an array of field definitions (which can have the same pair view,type as stated here) -
boolean: true or false
-
date: a date value always YYYY-MM-DD
-
time: a time value always HH:MM:SS
-
dateTime: a date/time value YYYY-MM-DDTHH:MM:SS, YYYY-MM-DD HH:MM:SS or ISO 8601 datetime with timezone format (E8601DZw.d) YYYY-MM-DDTHH:MM:SS+|-HH:MM
- Inbound commands that require a dateTime must use the ISO 8601 datetime with timezone format
Simple Example Application
A simple application using Altair’s IoTP™ API follows this basic outline:
-
Use PowerTools at altairsmartedge.com/api/v3.1/ for your commands.
-
Send a LOGIN request with the Users login and password and validate the response.
-
Get the current Device list for a Site to which you have access (GET_DEVICE_LIST).
-
Get the current status of each Device (GET_STATUS).
-
Use your Application to affect Actions (e.g. POWER_ON).
-
Constantly poll PowerTools with DEVICE_CHANGE and update your Devices that return a change, or
-
Use the associated Google Pub/Sub subscription for monitoring device changes
Object Model
-
Company
- Central entity for billing, Users, Sites, etc…
- Companies can have hierarchy in the form of child Sub-Companies. A Sub-Company has all the same capabilities as its Parent Company. Users, Sites, etc… can all be assigned to a Sub-Company.
- Many things are inherited to a child Sub-Company from the Parent, such as:
- User - A Users Role/Rights assigned to a Parent are inherited down to all child Sub-Companies
-
User
- Users belong to a single Company
- Types
- Primary User - The User is assigned as the Primary User to a Site, meaning that Site is associated to the Users Company, and that User is responsible for that Site
- Associated User - A User that is associated with a Site means that User can get to that Site, even if they don’t have direct Rights to get to it.
- A single User can be Primary User on, or associated with, multiple Sites.
- Users are assigned Roles. Roles are a collection of Rights. Rights are a tag representing an ability to access, use, create, or delete something in the system.
- EX: Rights allow Users to do things like
- Create/Read/Update/Delete objects in the system (Sites, Users, Devices, …)
- EX: Rights allow Users to do things like
-
Site - Element that represents a set of Devices that are connected to a single Altair-enabled gateway at a physical location (address) - (home, building, closet, etc…)
- Sites are assigned to a single Primary User. And by inheritance, Sites belong to that Primary Users Company.
- Sites can have only 1 gateway
-
Product - an object definition of a unique piece of smart hardware which Altair software can communicate and/or control
- Product types include: gateways (IoT Server), end Devices (e.g. thermostat, controller, meter, dimmer), bridges
- Some elements of the definition are specific to all Devices of the same Product
- Product Specific: Name, Company (Manufacturer), Model, Description, Protocol, Driver, Product Type, Actions, Image, …
- Some elements define place holders for instantiation specific information
- IP, username, password, Z-Wave node, BACnet device instance,
-
Device - Products are instantiated as Devices when added (provisioned) to a Site
- Devices are assigned to a single Site.
- An instantiated Device has a collection of Actions that it can perform and data that can be retrieved (POWER_ON, GET_STATUS).
Getting Changes from a Device
There are multiple ways to get notifications of changes that have occurred at the Device.
GET_STATUS
The GET_STATUS inbound Action will return the current status of a particular Device. This inbound request returns all points that are available for this Device. See Action
deviceChanges
Changes to a Device can also be seen by polling the cloud and watching for deviceChanges to show up. deviceChanges is a section of responses from the IoT Server that contains any change to any Device that is supported on this IoT Server. It is an array, and will have the same format as a GET_STATUS request response (but only with the parts that have changed).
Notice, any inbound command may contain a deviceChanges list, so every response must be looked at for deviceChanges, even if the last request was to an entirely different Device. Once a change has been returned in a deviceChanges response, it will no longer be sent in the next deviceChanges, so watch them all.
These can also be polled for via this API (/api/v3.1/sites/{siteCd}/actions/getChanges)
Device Events
These can either be polled via this API (/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/getEventData), or as supported with the Unity product where Device Events and Meter usage data are pushed to a 3rd party. See Unity below.
Google Pub/Sub
Devices can publish data to Google Pub/Sub through the use of an Application Partner. The associated subscription can be used to further process this data.
Sockets
A Socket is a data container. Sockets are a logical construct which ensure that the dataset for a specific application (like the kWh readings on a mains power line) persists over time, even if the Device (the mains power line meter) is replaced with a different Device.
Various data can be associated with a particular Device. Some examples include:
-
Meters can generate consumption data (KWH, KV, GPH)
-
Thermostats can store temperatures, set-points and modes.
-
Switches can report On/Off status
Each of these data feeds is automatically stored in a “Socket” associated with the Device. If the Device is later replaced, the Socket allows the archived data from the old Device to be contiguous with the new data from the new Device. All queries still use the DeviceCd regardless of which Devices put data into a specific Device’s Socket over time.
Socket Types – The IoT API currently only supports the “Revenue Meter Socket” Type. This Socket Type is intended to be used to archive and identify the primary meter data feed for a given Site, such as the electric mains kWh readings over time. Other Socket Type API commands are in development.
Miscellaneous Important Notes
-
Security is session based – Because security is session based, cookies must be kept and returned with each subsequent request after login.
-
Update Site – This command pushes new configuration information about Devices, Users, Rules, etc. from the SmartEdge Cloud to the Sites SmartEdge Server. The Cloud is the master and the Gateway is the slave of all configurations for the system. So configuration can be done across multiple Devices at the same time. But this configuration is not available on the Gateway until an Update Site is performed.
-
Product vs. Device – A Product is a unique make and model of a communicating sensor, switch, meter or piece of equipment that can be purchased and installed. A Device is a Product that has been installed and provisioned at a Site.
-
Gateway-based local IoT Server only supports v2 of the API. A copy of this is located here.
-
In the examples below, the {IOTP_ServerAddress} is either the local IP address of the local IoT Server, or the URL of the PowerTools Cloud.
-
Example: {IOTP_ServerAddress}/api/v{VersionNumber}/sites
- PowerTools Cloud: https://iot.altairsmartedge.com/api/v3.1/sites
- Local IoT Server: http://192.168.1.101/api/v2/CandiServer.php
-
PowerTools and Altair IoT Server must be in sync Commands expect that the Cloud and the IoT Server are in sync with an Update Site. Otherwise, commands (like get_device_list) may return different information since things may have changed in the Cloud that the IoT Server does not know about until Update Site is run.
-
CD = Unique Identifier Code Each core element is identified by a CD. Every CD in the system is a string that is between 30 and 50 characters long, and is only alpha-numeric characters (no special characters). CDs always start with an alpha character. A CD can be used within or as a variable name, or in command lines without problems.
- Example CDs include: UserCd, DeviceCd, SiteCd
LCD = Lookup Code LCDs are system variables used as alpha strings representing things like: Information Types, Usage Data Types, Increments, Date Formats, Country Codes, etc.
Response Parameters. The order of the Response Parameters is not set and may be different between commands, and may change.
IP Addresses may change The Altair IoT Server may reboot periodically, or get restarted. Since it is often a DHCP client on the Site network, the IoT Server may not have a consistent IP address over time.
Temperatures in Celsius – All inbound and outbound temperatures are done in Celsius, unless otherwise specified.
Online State information (DL_ONLINE_STATE) There are 6 descriptions of a Device’s online availability
- unknown (0) - Device is currently not supplying online information. This may change shortly.
- online (1) - Device is performing as expected
- offline (2) - Device is offline, and was previously working.
- This can apply to any Device, including Gateways, and Bridges
- never online (3) - Device has not responded to polls from the Gateway
- offline gateway (4) - This Devices’ Gateway that it is connected to, is currently reporting as offline
- offline bridge (5) - This Devices’ bridge that is it connected to, is currently reporting as offline
Status information (DL_STATUS)
- Ok - The device does not report any errors
- Any error message - Error messages reported by the device
Online Last information (DL_ONLINE_LAST)
- Date/Time the Device was last determined to be online
Combo Devices - TBD
Usage Data Types - Usage data type variables (UD_DTYPE_xxx) are used associated with meters. They represent the elements you can track with a particular device /meter. Some types include ODM as part of their descriptor. This stands for Odometer. On many meters, like the meter on a building, the meter just provides a rolling number, usually going forward. This reading is a kWh reading and is similar to the odometer on your car that reads the miles driven. If there is no ODM identifier, then this reading is for the whole amount that occurred in the provided time frame.
- UD_DTYPE_KWH_ODM - Running amount of kWh used on this meter
- UD_DTYPE_KWH -and- UD_INC_15MIN (or DL_KWH_15MIN) - The amount of kWh used in this 15 minutes
CDs automatically assigned - CDs associated with objects (Site, User, Device, …) are automatically assigned by the system, so therefore are not needed to be sent in when using the API at creation (POST) of the object.
Release Notes Mar 2018 ¶
The xxInfo records for User, Site, Product, Device, Company are no longer exposed through the API. The records are now available as properties directly on the object and can be grouped logically. See the various sections of this documentation for details.
Global Failures ¶
These failures can be returned on just about any inbound request.
Bad Request 400 ¶
Bad Request 400POST/
User is trying to push something into the system that is not allowed, wrong format, etc…
Example URI
POST https://altairsmartedge.com/
Response
400Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 34005,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 400,
"messages": [
{
"id": "responseBadRequest",
"text": "Request denied. Inbound data was invalid (wrong type, bad format, ..."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"enum": [
34005
],
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"responseBadRequest"
],
"description": "id string"
},
"text": {
"type": "string",
"enum": [
"Request denied. Inbound data was invalid (wrong type, bad format, ..."
]
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Forbidden 403 ¶
Forbidden 403GET/
User is asking for something they are not allowed to retrieve. This can be:
-
User not allowed access to this object
-
The object does not exist
Example URI
GET https://altairsmartedge.com/
Response
403Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 34005,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 403,
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"enum": [
34005
],
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Miscellaneous Schema ¶
FieldDetails Schema
If editParameters=true is sent in, then a full definition and options available for each field that is returned is included in the editParameters section. Each of these fieldDetails definitions may be embedded inside an object, or an array - so follow the structure of the response to find the appropriate field definition.
This FieldDetails section is required so that Users of the API know how fields returned in the API can/should be used - limits, types, field labels, required or not, etc…
Definitions and uses of this include:
-
fieldName: This identifies the field that is being defined
-
view: Says whether this field should be shown to a User or not
-
type: Defines the variable type of the field. See “JSON Response Types”.
-
required: Shows whether the field is required when doing updates or not
-
label: Returns the language specific (currently only English is supported) text that could be displayed to a User.
-
labelPlural: Returns the plural of the label. (EX: label=site, labelPlural=sites)
-
help: Returns a short textual help string
-
options: (OptionDetails Schema) Array of potential options for this field. See the type to determine how many options are selectable. See below.
-
validation: If applicable, a regular expression used to validate the field value.
{
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field this detail is for",
"required": true
},
"view": {
"type": "string",
"description": "How to view. write, read, hidden, password",
"required": true
},
"type": {
"type": "string",
"description": "Specifies the type of details this is. (string, number, oneOf, anyOf, onePlusOf)",
"required": true
},
"required": {
"type": "boolean",
"description": "Specifies whether this field is required or not. true or false",
"required": true
},
"label": {
"type": "string",
"description": "The label this field could display in a UI",
"required": true
},
"labelPlural": {
"type": "string",
"description": "The label that is plural for this field that could display in a UI",
"required": true
},
"help": {
"type": "string",
"description": "A potential help string. May be blank.",
"required": true
},
"options": {
"type": "array",
"description": "Array of OptionDetails for this FieldDetailOption. (Optional)",
"required": false
},
"validation": {
"type": "string",
"description": "Regular expression used to validate the field value. (Optional)",
"required": false
}
}
}OptionDetails Schema
This is the definition of the “options” section of a FieldDetails Schema.
Each option has 2 attributes:
-
text: Text to display for a User (like the label field)
-
value: What is to be returned for the API
{
"type": "object",
"properties":{
"text":{
"type":"string",
"description":"Text of this list option"
},
"value":{
"type":"string",
"description":"The Value to be returned with this choice"
}
},
"description":"List of options for a select"
}Company ¶
Company refers to a corporate structure that is associated with Users, Devices, and other entities in the system.
Companies List ¶
Get Companies ListGET/api/v3.1/companies{?editParameters,limit,page,orderBy,direction,filter,filterOr,filterAnd,type}
Get the Companies list.
The list can be filtered using one of three different types of filters:
-
filter (filters on the ‘name’ and ‘address’ fields using ‘or’)
-
filterOr (filters on specified fields using ‘or’)
-
filterAnd (filters on specified fields using ‘and’)
The filterOr and filterAnd query parameters filter on the specified fields; currently available fields are: name, address, parentCompany.companyCd and customFields.propertyName (replace with the actual property name of the custom field). A filter needs to be given as field and value separated by a colon, for example: “name:text”. Multiple filters need to be separated by a semi-colon, for example: “name:text;address:text”. A full example: filterAnd=name:text;address:text
There are currently two types of Companies in the system; manufacturers and non-manufacturers. The former have Products associated to them; the latter have Users, Sites, etc. By default the Companies list is filtered to return only non-manufacturers. The ‘type’ query parameter can be used to change that filter. The following options are available: non-manufacture, manufacture, all.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Companies
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies?editParameters=false&limit=100&page=1&orderBy=name&direction=asc&filter=text&filterOr=name:text;parentCompany.companyCd:text&filterAnd=address:text;customFields.propertyName:text&type=non-manufacture
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: name Example: nameField to order results by
Choices:
nameaddress- direction
string(optional) Default: asc Example: ascSort direction for the results list
Choices:
ascdesc- filter
string(optional) Example: textFilters results by matching text in fields: Name, Address
- filterOr
string(optional) Example: name:text;parentCompany.companyCd:textFilters results by matching text in specified fields using ‘or’
- filterAnd
string(optional) Example: address:text;customFields.propertyName:textFilters results by matching text in specified fields using ‘and’
- type
string(optional) Default: non-manufacture Example: non-manufactureType of Company
Choices:
non-manufacturemanufactureall
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"companyCd": "H6Z5Ea1psSe449Kg3968",
"parentCompany": {
"companyCd": "Se449Kg39H6Z5Ea1ps68",
"name": "Parent Company"
},
"name": "Altair",
"address": "428 13th St., 3rd Floor, Oakland, CA 94612",
"tree": {},
"zuulPollTimeSecs": 15,
"requireGatewayAuthorization": "inherit",
"requireGatewayAuthorizationInherited": false,
"applicationPartnerDefault": "6ZSe449Kg39H5Ea1ps68",
"editParameters": {
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"parentCompany": {
"companyCd": {
"fieldName": "companyCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Parent Company CD",
"labelPlural": "Parent Company CDs",
"help": "Unique identifier for the Company."
}
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": false,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique"
},
"address": {
"fieldName": "address",
"view": "read",
"type": "string",
"required": false,
"label": "Address",
"labelPlural": "Addresses",
"help": "Address of the Company"
},
"zuulPollTimeSecs": {
"fieldName": "zuulPollTimeSecs",
"view": "write",
"type": "number",
"required": false,
"label": "Default Gateway Poll Time (seconds)",
"labelPlural": "Default Gateway Poll Time (seconds)",
"help": "``"
},
"requireGatewayAuthorization": {
"fieldName": "requireGatewayAuthorization",
"view": "write",
"type": "oneOf",
"required": false,
"label": "Require Gateway Authorization at Company and Sub-Companies",
"labelPlural": "Require Gateway Authorization at Company and Sub-Companies",
"help": "``"
},
"applicationPartnerDefault": {
"fieldName": "applicationPartnerDefault",
"view": "write",
"type": "oneOf",
"required": false,
"label": "Default Application Partner",
"labelPlural": "Default Application Partner",
"help": "``"
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_COMPANY",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Company ¶
Get CompanyGET/api/v3.1/companies/{companyCd}{?editParameters}
- Types of Responses
- Response 200 - If Company is retrieved
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/H6Z5Ea1psSe449Kg3968?editParameters=false
URI Parameters
- companyCd
string(required) Example: H6Z5Ea1psSe449Kg3968The unique identifier of the Company
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"parentCompany": {
"companyCd": "Se449Kg39H6Z5Ea1ps68",
"name": "Parent Company"
},
"name": "Altair",
"address": "428 13th St., 3rd Floor, Oakland, CA 94612",
"tree": {},
"zuulPollTimeSecs": 15,
"requireGatewayAuthorization": "inherit",
"requireGatewayAuthorizationInherited": false,
"applicationPartnerDefault": "6ZSe449Kg39H5Ea1ps68",
"editParameters": {
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"parentCompany": {
"companyCd": {
"fieldName": "companyCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Parent Company CD",
"labelPlural": "Parent Company CDs",
"help": "Unique identifier for the Company."
}
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": false,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique"
},
"address": {
"fieldName": "address",
"view": "read",
"type": "string",
"required": false,
"label": "Address",
"labelPlural": "Addresses",
"help": "Address of the Company"
},
"zuulPollTimeSecs": {
"fieldName": "zuulPollTimeSecs",
"view": "write",
"type": "number",
"required": false,
"label": "Default Gateway Poll Time (seconds)",
"labelPlural": "Default Gateway Poll Time (seconds)",
"help": "``"
},
"requireGatewayAuthorization": {
"fieldName": "requireGatewayAuthorization",
"view": "write",
"type": "oneOf",
"required": false,
"label": "Require Gateway Authorization at Company and Sub-Companies",
"labelPlural": "Require Gateway Authorization at Company and Sub-Companies",
"help": "``"
},
"applicationPartnerDefault": {
"fieldName": "applicationPartnerDefault",
"view": "write",
"type": "oneOf",
"required": false,
"label": "Default Application Partner",
"labelPlural": "Default Application Partner",
"help": "``"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_COMPANY",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"parentCompany": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
]
},
"name": {
"type": "string",
"description": "Name of the Company"
},
"address": {
"type": "string",
"description": "Address of the Company"
},
"tree": {
"type": "object",
"properties": {},
"description": "Hierarchy of company tree"
},
"zuulPollTimeSecs": {
"type": "number",
"description": "Default Poll Interval in Seconds for this Company's Gateways"
},
"requireGatewayAuthorization": {
"anyOf": [
{
"type": "string",
"enum": [
"inherit"
]
},
{
"type": "boolean",
"enum": [
true,
false
]
}
],
"default": "inherit",
"description": "Require Gateway Authorization at Company and Sub-companies"
},
"requireGatewayAuthorizationInherited": {
"type": "boolean",
"description": "Inherited Gateway Authorization setting"
},
"applicationPartnerDefault": {
"type": "string",
"description": "Unique identifier for the Default Application Partner"
},
"editParameters": {
"type": "object",
"properties": {
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"parentCompany": {
"type": "object",
"properties": {
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"companyCd"
]
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"address": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"zuulPollTimeSecs": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"requireGatewayAuthorization": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"number",
"string",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"applicationPartnerDefault": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"number",
"string",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"companyCd",
"name"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"companyCd",
"name"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Create a new CompanyPOST/api/v3.1/companies/{companyCd}
- Types of Responses
- Response 200 - Update successful - companyCd returned in body
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr
Request
Body
{
"name": "New Company",
"parentCompany": {
"companyCd": "Se449Kg39H6Z5Ea1ps68"
},
"address": "Optional Address",
"applicationPartnerDefault": "6ZSe449Kg39H5Ea1ps68"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Company"
},
"parentCompany": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
}
},
"required": [
"companyCd"
]
},
"address": {
"type": "string",
"description": "Address of the Company"
},
"applicationPartnerDefault": {
"type": "string",
"description": "Unique identifier for the Default Application Partner"
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"companyCd": "aCe1Tx8GVmN8E7o6JLNG"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_COMPANY",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "The Company CD"
}
},
"required": [
"companyCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_COMPANY",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Update a CompanyPUT/api/v3.1/companies/{companyCd}{?editParameters}
Only send in data that is changed
When requesting editParameters in the return the complete company object will be returned.
- Types of Responses
- Response 200 - Update successful - companyCd returned in body
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/companies/aCe1Tx8GVmN8E7o6JLNG?editParameters=false
URI Parameters
- companyCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Company CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"name": "New Company",
"parentCompany": {
"companyCd": "Se449Kg39H6Z5Ea1ps68"
},
"address": "Optional Address",
"zuulPollTimeSecs": 15,
"applicationPartnerDefault": "6ZSe449Kg39H5Ea1ps68"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Company"
},
"parentCompany": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
}
}
},
"address": {
"type": "string",
"description": "Address of the Company"
},
"zuulPollTimeSecs": {
"type": "number",
"description": "Default Poll Interval in Seconds for this Company's Gateways"
},
"applicationPartnerDefault": {
"type": "string",
"description": "Unique identifier for the Default Application Partner"
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"companyCd": "aCe1Tx8GVmN8E7o6JLNG"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_COMPANY",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "The Company CD"
}
},
"required": [
"companyCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_COMPANY",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Delete a CompanyDELETE/api/v3.1/companies/{companyCd}{?delete,sites,users}
A Company can not be deleted if there are sub-companies, sites or users. Sub-companies would need to be moved to another parent first, or deleted first. Sites and/or users can be deleted if optional query parameters are passed in. The ‘delete’ option needs to be specified and the number of sites and/or users passed in as query parameters needs to match the number of sites and/or users on the company itself.
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/companies/aCe1Tx8GVmN8E7o6JLNG?delete=sites&sites=1&users=1
URI Parameters
- companyCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Company CD
- delete
string(optional) Example: sitesObjects to also delete
Choices:
sitesuserssitesAndUsers- sites
number(optional) Example: 1The total number of sites on the Company, for deletion
- users
number(optional) Example: 1The total number of users on the Company, for deletion
Response
204Headers
Content-Type: application/jsonSub Companies ¶
Get Sub Companies ListGET/api/v3.1/company/{companyCd}/subCompanies{?editParameters}
Get the Sub Companies list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Companies
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/company/cK4Uae73unb72TYuDJDr/subCompanies?editParameters=false
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"companyCd": "H6Z5Ea1psSe449Kg3968",
"parentCompany": {
"companyCd": "Se449Kg39H6Z5Ea1ps68",
"name": "Parent Company"
},
"name": "Altair",
"address": "428 13th St., 3rd Floor, Oakland, CA 94612",
"tree": {},
"zuulPollTimeSecs": 15,
"requireGatewayAuthorization": "inherit",
"requireGatewayAuthorizationInherited": false,
"applicationPartnerDefault": "6ZSe449Kg39H5Ea1ps68",
"editParameters": {
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"parentCompany": {
"companyCd": {
"fieldName": "companyCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Parent Company CD",
"labelPlural": "Parent Company CDs",
"help": "Unique identifier for the Company."
}
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": false,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique"
},
"address": {
"fieldName": "address",
"view": "read",
"type": "string",
"required": false,
"label": "Address",
"labelPlural": "Addresses",
"help": "Address of the Company"
},
"zuulPollTimeSecs": {
"fieldName": "zuulPollTimeSecs",
"view": "write",
"type": "number",
"required": false,
"label": "Default Gateway Poll Time (seconds)",
"labelPlural": "Default Gateway Poll Time (seconds)",
"help": "``"
},
"requireGatewayAuthorization": {
"fieldName": "requireGatewayAuthorization",
"view": "write",
"type": "oneOf",
"required": false,
"label": "Require Gateway Authorization at Company and Sub-Companies",
"labelPlural": "Require Gateway Authorization at Company and Sub-Companies",
"help": "``"
},
"applicationPartnerDefault": {
"fieldName": "applicationPartnerDefault",
"view": "write",
"type": "oneOf",
"required": false,
"label": "Default Application Partner",
"labelPlural": "Default Application Partner",
"help": "``"
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_COMPANY",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Company Sites List ¶
Get Sites ListGET/api/v3.1/company/{companyCd}/sites{?editParameters}
Get the sites that are part of this Company, and all it’s Sub Companies.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Sites
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/company/cK4Uae73unb72TYuDJDr/sites?editParameters=false
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"siteCd": "cK4Uae73unb72TYuDJDr",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "Test Site",
"address1": "123 main st",
"address2": "``",
"city": "Los Angeles",
"state": "CA",
"countryLcd": "COUNTRY_US",
"longitude": -118.243893,
"latitude": 34.051908,
"imageLink": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg",
"primaryUser": "primarUser",
"siteImage": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg",
"operationsStatus": "OPERATIONS_STATUS_ACTIVE",
"applicationPartnerDefault": "applicationPartnerDefaultCd",
"siteOverview": {
"deviceCount": 12,
"ruleCount": 1,
"lastPoll": "2016-04-02 12:33:14",
"lastUpdated": "2016-04-01 10:13:45"
},
"users": [
{
"userCd": "W8JNPoPg7rAh7B45HZMA",
"firstName": "First",
"lastName": "Last",
"fullName": "First Last"
}
],
"programs": [
{
"programCd": "Pg7rAh7B45W8JNPoHZMA",
"name": "Program"
}
],
"applicationPartners": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Application Partner Name"
}
],
"tags": [],
"editParameters": {
"siteCd": {
"fieldName": "siteCd",
"view": "read",
"type": "string",
"required": true,
"label": "SiteCd",
"labelPlural": "SiteCds",
"help": "Unique identifier for the Site."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"address1": {
"fieldName": "address1",
"view": "write",
"type": "string",
"required": false,
"label": "Address1",
"labelPlural": "Address1s",
"help": "Address1 is optional"
},
"address2": {
"fieldName": "address2",
"view": "write",
"type": "string",
"required": false,
"label": "Address2",
"labelPlural": "Address2s",
"help": "Address2 is optional"
},
"city": {
"fieldName": "city",
"view": "write",
"type": "string",
"required": false,
"label": "City",
"labelPlural": "Citys",
"help": "City is optional"
},
"state": {
"fieldName": "state",
"view": "write",
"type": "string",
"required": false,
"label": "State",
"labelPlural": "States",
"help": "State is optional"
},
"countryLcd": {
"fieldName": "countryLcd",
"view": "write",
"type": "string",
"required": false,
"label": "Country",
"labelPlural": "Countries",
"help": "Country is optional"
},
"longitude": {
"fieldName": "longitude",
"view": "write",
"type": "number",
"required": false,
"label": "Longitude",
"labelPlural": "Longitudes",
"help": "Longitude is optional"
},
"latitude": {
"fieldName": "latitude",
"view": "write",
"type": "number",
"required": false,
"label": "Latitude",
"labelPlural": "Latitudes",
"help": "Latitude is optional"
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "string",
"required": true,
"label": "Image",
"labelPlural": "Images",
"help": "A picture of the Device or Site."
},
"primaryUser": {
"fieldName": "primaryUser",
"view": "write",
"type": "number",
"required": false,
"label": "Primary User",
"labelPlural": "Primary Users",
"help": "Primary User is required"
},
"siteImage": {
"fieldName": "siteImage",
"view": "write",
"type": "number",
"required": false,
"label": "Site Image",
"labelPlural": "Site Images",
"help": "Site image is optional"
},
"operationsStatus": {
"fieldName": "operationsStatus",
"view": "write",
"type": "string",
"required": false,
"label": "Operation Status",
"labelPlural": "Operation Statuses",
"help": "Operation Status is optional"
},
"applicationPartnerDefault": {
"fieldName": "applicationPartnerDefault",
"view": "write",
"type": "number",
"required": false,
"label": "Application Partner Default",
"labelPlural": "Application Partner Defaults",
"help": "Application Partner Default is optional"
},
"users": {
"fieldName": "users",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Users",
"labelPlural": "Users",
"help": "List of associated users"
},
"programs": {
"fieldName": "programs",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Program",
"labelPlural": "Programs",
"help": "List of associated programs"
},
"applicationPartners": {
"fieldName": "applicationPartners",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Application Partner",
"labelPlural": "Application Partners",
"help": "List of associated application partners"
},
"tags": {
"fieldName": "tags",
"view": "write",
"type": "array",
"required": false,
"label": "Tag",
"labelPlural": "Tags",
"help": "List of custom tags"
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_SITE",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this site is assigned to"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "The unique name of the Site"
},
"address1": {
"type": "string",
"enum": [
"123 main st"
],
"description": "The first address for the Site"
},
"address2": {
"type": "string",
"enum": [
"``"
],
"description": "Second address field if required"
},
"city": {
"type": "string",
"enum": [
"Los Angeles"
],
"description": "City of the site"
},
"state": {
"type": "string",
"enum": [
"CA"
],
"description": "State"
},
"countryLcd": {
"type": "string",
"enum": [
"COUNTRY_US"
],
"description": "Country code"
},
"longitude": {
"type": "number",
"enum": [
-118.243893
],
"description": "Longitude of the address and city info"
},
"latitude": {
"type": "number",
"enum": [
34.051908
],
"description": "Latitude"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg"
],
"description": "URI to image of the Users uploaded image of the Site"
},
"primaryUser": {
"type": "string",
"enum": [
"primarUser"
],
"description": "the primary users userCd"
},
"siteImage": {
"type": "string",
"enum": [
"/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg"
],
"description": "sites image"
},
"operationsStatus": {
"type": "string",
"enum": [
"OPERATIONS_STATUS_ACTIVE"
],
"description": "current site operation status"
},
"applicationPartnerDefault": {
"type": "string",
"enum": [
"applicationPartnerDefaultCd"
],
"description": "default application partner for this site"
},
"siteOverview": {
"type": "object",
"properties": {
"deviceCount": {
"type": "number",
"enum": [
12
],
"description": "Number of Devices associated with this Site"
},
"ruleCount": {
"type": "number",
"enum": [
1
],
"description": "Number of Rules associated with this Site"
},
"lastPoll": {
"type": "string",
"enum": [
"2016-04-02 12:33:14"
],
"description": "Last poll date"
},
"lastUpdated": {
"type": "string",
"enum": [
"2016-04-01 10:13:45"
],
"description": "Last poll date"
}
},
"required": [
"deviceCount",
"ruleCount",
"lastPoll",
"lastUpdated"
],
"additionalProperties": false,
"description": "An over of some information regarding the Site"
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"W8JNPoPg7rAh7B45HZMA"
]
},
"firstName": {
"type": "string",
"enum": [
"First"
]
},
"lastName": {
"type": "string",
"enum": [
"Last"
]
},
"fullName": {
"type": "string",
"enum": [
"First Last"
]
}
},
"required": [
"userCd",
"firstName",
"lastName",
"fullName"
],
"additionalProperties": false
},
"description": "Array of Users associated with this Site"
},
"programs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"programCd": {
"type": "string",
"enum": [
"Pg7rAh7B45W8JNPoHZMA"
]
},
"name": {
"type": "string",
"enum": [
"Program"
]
}
},
"required": [
"programCd",
"name"
],
"additionalProperties": false
},
"description": "Array of Programs associated with this Site"
},
"applicationPartners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
}
},
"required": [
"partnerCd",
"name"
],
"additionalProperties": false
},
"description": "List of ApplicationPartners"
},
"tags": {
"description": "Custom tags added by the user"
},
"editParameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"siteCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"SiteCd"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"SiteCds"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Site."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"companyCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Company CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Company CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Company."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name is required, and must be unique within a Site"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"address1": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"address1"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Address1"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Address1s"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Address1 is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"address2": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"address2"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Address2"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Address2s"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Address2 is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"city": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"city"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"City"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Citys"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"City is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"state": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"state"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"State"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"States"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"State is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"countryLcd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"countryLcd"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Country"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Countries"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Country is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"longitude": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"longitude"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Longitude"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Longitudes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Longitude is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"latitude": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"latitude"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Latitude"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Latitudes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Latitude is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"imageLink": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"imageLink"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Image"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Images"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"A picture of the Device or Site."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"primaryUser": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"primaryUser"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Primary User"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Primary Users"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Primary User is required"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"siteImage": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"siteImage"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Site Image"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Site Images"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Site image is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"operationsStatus": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"operationsStatus"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Operation Status"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Operation Statuses"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Operation Status is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"applicationPartnerDefault": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"applicationPartnerDefault"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Application Partner Default"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Application Partner Defaults"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Application Partner Default is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"users": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"users"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Users"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Users"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of associated users"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"programs": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"programs"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Program"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Programs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of associated programs"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"applicationPartners": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"applicationPartners"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Application Partner"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Application Partners"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of associated application partners"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"tags": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"tags"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"object",
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf"
],
"default": [
"array"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Tag"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Tags"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of custom tags"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"siteCd",
"companyCd",
"name",
"imageLink",
"primaryUser"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"siteCd",
"company",
"name",
"primaryUser",
"siteOverview",
"users",
"programs",
"applicationPartners",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": [
"JSON"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Company Custom Label List ¶
Get Company Custom Label ListGET/api/v3.1/company/{companyCd}/customLabels{?page,limit,orderBy,direction}
Get the Company Custom Label list. Returns array of Custom Labels (Custom Fields) available at this Company. This includes labels inherited from parent companies.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of custom fields
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/company/cK4Uae73unb72TYuDJDr/customLabels?page=1&limit=100&orderBy=date&direction=desc
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: date Example: dateField to order results by
Choices:
datelabelpropertyName- direction
string(optional) Default: desc Example: descSort direction for the results list
Choices:
descasc
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"dataLabel": "DL_CUSTOM_LABEL_1",
"customFieldCd": "a1psH6Z5g3968ESe449K",
"companyCd": "H6Z5Ea1psSe449Kg3968",
"type": "CFT_CUSTOM_LABEL",
"dataType": "STRING",
"dataTypeOption": [],
"help": "This field is for...",
"label": "My Field Label",
"labelPlural": "My Field Labels",
"required": false
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Company Global Label List ¶
Get Company Global Label ListGET/api/v3.1/company/{companyCd}/globalLabels{?page,limit,orderBy,direction}
Get the Company Global Label list. Returns array of Global Labels (Custom Fields) available at this Company.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of custom fields
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/company/cK4Uae73unb72TYuDJDr/globalLabels?page=1&limit=100&orderBy=date&direction=desc
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: date Example: dateField to order results by
Choices:
datelabelpropertyName- direction
string(optional) Default: desc Example: descSort direction for the results list
Choices:
descasc
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"dataLabel": "DL_CUSTOM_LABEL_1",
"customFieldCd": "a68ESe449K1psH6Z5g39",
"companyCd": "!__GLOBAL_CO__!",
"type": "CFT_CUSTOM_LABEL",
"dataType": "STRING",
"dataTypeOption": [],
"help": "This field is for...",
"label": "My Field Label",
"labelPlural": "My Field Labels",
"required": false
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Company Tag List ¶
Get Company Tag ListGET/api/v3.1/company/{companyCd}/tags
Get the Company Tag list. Returns array of tags used on sites and devices associated with this Company.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of tags
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/company/cK4Uae73unb72TYuDJDr/tags
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
"tag1",
"tag2"
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_TAG",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Company Actions ¶
Add Application Partner Mapping ¶
Add Application Partner MappingGET/api/v3.1/companies/{companyCd}/actions/addApplicationPartnerMapping{?applicationPartnerCds,deviceCds}
Add Application Partner to Device mapping for the specified Application Partner(s) and Device(s). If no Device(s) are specified then all Devices the user has access to for this Company will be mapped. Sub-companies are not affected.
- Types of Responses
- Response 200 - Request successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/nb72TYuDJDrcK4Uae73u/actions/addApplicationPartnerMapping?applicationPartnerCds=JDrcK4Uae7nb72TYuD3u&deviceCds=nb72TYuD3uJDrcK4Uae7
URI Parameters
- companyCd
string(required) Example: nb72TYuDJDrcK4Uae73uCD of the Company
- applicationPartnerCds
string(required) Example: JDrcK4Uae7nb72TYuD3uComma separated list of Application Partner CDs
- deviceCds
string(optional) Example: nb72TYuD3uJDrcK4Uae7Comma separated list of Device CDs
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"applicationPartnerCd": "JDrcK4Uae7nb72TYuD3u",
"deviceCd": "nb72TYuD3uJDrcK4Uae7"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_APPLICATION_PARTNER_MAPPING_ADD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"applicationPartnerCd": {
"type": "string",
"enum": [
"JDrcK4Uae7nb72TYuD3u"
],
"description": "Application Partner CD"
},
"deviceCd": {
"type": "string",
"enum": [
"nb72TYuD3uJDrcK4Uae7"
],
"description": "Device CD"
}
},
"required": [
"applicationPartnerCd",
"deviceCd"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Remove Application Partner Mapping ¶
Remove Application Partner MappingGET/api/v3.1/companies/{companyCd}/actions/removeApplicationPartnerMapping{?applicationPartnerCds,deviceCds}
Remove Application Partner to Device mapping for the specified Application Partner(s) and Device(s). If no Device(s) are specified then all Devices the user has access to for this Company will be used. Sub-companies are not affected.
- Types of Responses
- Response 200 - Request successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/nb72TYuDJDrcK4Uae73u/actions/removeApplicationPartnerMapping?applicationPartnerCds=JDrcK4Uae7nb72TYuD3u&deviceCds=nb72TYuD3uJDrcK4Uae7
URI Parameters
- companyCd
string(required) Example: nb72TYuDJDrcK4Uae73uCD of the Company
- applicationPartnerCds
string(required) Example: JDrcK4Uae7nb72TYuD3uComma separated list of Application Partner CDs
- deviceCds
string(optional) Example: nb72TYuD3uJDrcK4Uae7Comma separated list of Device CDs
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"applicationPartnerCd": "JDrcK4Uae7nb72TYuD3u",
"deviceCd": "nb72TYuD3uJDrcK4Uae7"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_APPLICATION_PARTNER_MAPPING_REMOVE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"applicationPartnerCd": {
"type": "string",
"enum": [
"JDrcK4Uae7nb72TYuD3u"
],
"description": "Application Partner CD"
},
"deviceCd": {
"type": "string",
"enum": [
"nb72TYuD3uJDrcK4Uae7"
],
"description": "Device CD"
}
},
"required": [
"applicationPartnerCd",
"deviceCd"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Request Account ¶
Request AccountPOST/api/v3.1/companies/{companyCd}/actions/requestAccount
Request account at Company
- Types of Responses
- Response 200 - Request successful
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/companies/nb72TYuDJDrcK4Uae73u/actions/requestAccount
URI Parameters
- companyCd
string(required) Example: nb72TYuDJDrcK4Uae73uCD of the Company
Request
Body
{
"email": "user@request.com",
"firstName": "First Name",
"lastName": "Last Name"
}Schema
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email for the New Account"
},
"firstName": {
"type": "string",
"description": "First Name of User"
},
"lastName": {
"type": "string",
"description": "Lasst Name of User"
}
},
"required": [
"email"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_REQUEST_ACCOUNT",
"messages": {
"id": "accountRequest",
"text": "Account request email has been sent."
},
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Message ID"
},
"text": {
"type": "string",
"description": "Message Text"
}
},
"required": [
"id",
"text"
]
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Total Event Types ¶
Total Event TypesGET/api/v3.1/companies/{companyCd}/actions/getTotalEventTypes{?returnUnique}
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/nb72TYuDJDrcK4Uae73u/actions/getTotalEventTypes?returnUnique=true
URI Parameters
- companyCd
string(required) Example: nb72TYuDJDrcK4Uae73uCD of the Company
- returnUnique
boolean(optional) Example: trueReturn unique results per site (count labels for each device)? Default: true.
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"totalEventTypes": 11,
"sites": [
{
"siteCd": "cK4Uae73unb72TYuDJDr",
"totalEventTypes": 11
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_EVENT_TYPE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"totalEventTypes": {
"type": "number",
"description": "Total number of event types found"
},
"sites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
]
},
"totalEventTypes": {
"type": "number",
"enum": [
11
],
"description": "Total number of event types found"
}
},
"required": [
"siteCd",
"totalEventTypes"
],
"additionalProperties": false
}
}
},
"required": [
"totalEventTypes",
"sites"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Company Activity Data ¶
We track activity data for a Company’s Users and Application Partners in bucketized intervals. The following data is tracked:
-
the number of API requests for the logged in User
-
the number of usage data points (meter) returned for the logged in User
-
the number of usage data points published to Google PubSub for the Application Partner
The data is stored in UTC time.
Get Company Activity Data ¶
Get Company Activity DataGET/api/v3.1/companies/{companyCd}/actions/getActivityData{?activityType,increment,startDateTime,endDateTime}
Activity data for all the Company’s Users and Application Partners is combined in the output.
See also: Global Failures
- activityType - as per table below
| Activity Type LCD | Description |
|---|---|
| BDC_API_REQUEST | API Request Count |
| BDC_DATA_POINTS | API Data Points Returned Count |
| BDC_GPUBSUB_DATA_POINTS | Google PubSub Data Points Published Count |
- incrementType - as per table below
| Increment LCD | Description |
|---|---|
| UD_INC_15MIN | 15 Minutes |
| UD_INC_HOUR | Hourly |
| UD_INC_DAY | Daily |
| UD_INC_MONTH | Monthly |
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/nb72TYuDJDrcK4Uae73u/actions/getActivityData?activityType=BDC_API_REQUEST&increment=UD_INC_15MIN&startDateTime=2017-09-01T00:00:00-00:00&endDateTime=2017-09-02T00:00:00-00:00
URI Parameters
- companyCd
string(required) Example: nb72TYuDJDrcK4Uae73uCD of the Company
- activityType
string(required) Example: BDC_API_REQUESTThe LCD of the activity type being sought
- increment
string(required) Example: UD_INC_15MINThe LCD of the increment desired
- startDateTime
string(required) Example: 2017-09-01T00:00:00-00:00The Start Date and Time of the Events being sought
- endDateTime
string(optional) Example: 2017-09-02T00:00:00-00:00The End Date and Time of the Events being sought. If not provided, presumes now.
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"companyCd": "nb72TYuDJDrcK4Uae73u",
"name": "Company Name",
"values": [
{
"startDateTime": "2017-09-01T10:15:00-07:00",
"value": 221
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_COMPANY_ACTIVITY_DATA",
"httpStatus": 200,
"timeStamp": "2017-09-03T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "The Company CD"
},
"name": {
"type": "string",
"description": "The full name of the Company"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startDateTime": {
"type": "string",
"enum": [
"2017-09-01T10:15:00-07:00"
],
"description": "The start dateTime of this value."
},
"value": {
"type": "number",
"enum": [
221
],
"description": "The value for this dateTime"
}
},
"required": [
"startDateTime",
"value"
],
"additionalProperties": false
},
"description": "Array of Activity Data"
}
},
"required": [
"companyCd",
"name",
"values"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Product ¶
Get Product List ¶
Get Product ListGET/api/v3.1/products{?productCategoryCd,siteCd,limit,page,orderBy,direction,filter}
Retrieve Product details by Category.
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/products?productCategoryCd=ZSOqdczWF2OLW2KLqNQw&siteCd=cK4Uae73unb72TYuDJDr&limit=100&page=1&orderBy=name&direction=asc&filter=text
URI Parameters
- productCategoryCd
string(required) Example: ZSOqdczWF2OLW2KLqNQwThe Product Category filter
- siteCd
string(optional) Example: cK4Uae73unb72TYuDJDrSite specific Products
- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: name Example: nameField to order results by
Choices:
namemodel- direction
string(optional) Default: asc Example: ascSort direction for the results list
Choices:
ascdesc- filter
string(optional) Example: textFilters results by matching text in fields: Name, Model, Manufacturer Name
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"productCd": "r1LneacYS2P8en818LS7",
"name": "GE Jasco Appliance Switch Module 45603",
"manufacturerName": "General Electric",
"model": "45603",
"make": "GE Jasco",
"imageLink": "/Factory/images/products/r1LneacYS2P8en818LS7.jpg",
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "Z-Wave Switch",
"protocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
]
},
{
"productCd": "u1lq0isN3tv70HIy6L4G",
"name": "BACnet AHU",
"manufacturerName": "Altair",
"model": "Generic BACnet AHU",
"make": "BACnet AHU",
"imageLink": "/Factory/images/products/u1lq0isN3tv70HIy6L4G.jpg",
"labels": [
{
"labelCd": "PQ7arhw9LznXsyVGUtmy",
"inputType": 1,
"inputIndex": "5",
"label": "Outside"
}
],
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "BACnet",
"protocols": [
{
"protocolCd": "I37YifZSqBC1NPSa7g3T",
"name": "BACnet IP - AHU",
"version": "1.0"
}
]
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_PRODUCT",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"productCd": {
"type": "string",
"enum": [
"r1LneacYS2P8en818LS7"
],
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch Module 45603"
],
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"enum": [
"General Electric"
],
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"enum": [
"45603"
],
"description": "Model name of the Product"
},
"make": {
"type": "string",
"enum": [
"GE Jasco"
],
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/images/products/r1LneacYS2P8en818LS7.jpg"
],
"description": "URI to image of the Product"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"qa54NXq0DKgyywN1HpWy"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"name",
"manufacturerName",
"model",
"make",
"imageLink",
"productTypes",
"baseProtocol",
"protocols"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"productCd": {
"type": "string",
"enum": [
"u1lq0isN3tv70HIy6L4G"
],
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"enum": [
"BACnet AHU"
],
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"enum": [
"Generic BACnet AHU"
],
"description": "Model name of the Product"
},
"make": {
"type": "string",
"enum": [
"BACnet AHU"
],
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/images/products/u1lq0isN3tv70HIy6L4G.jpg"
],
"description": "URI to image of the Product"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"labelCd": {
"type": "string",
"enum": [
"PQ7arhw9LznXsyVGUtmy"
],
"description": "The unique Label ID"
},
"inputType": {
"type": "number",
"enum": [
1
],
"description": "BACnet Input Type"
},
"inputIndex": {
"type": "string",
"enum": [
"5"
],
"description": "BACnet Input Index"
},
"label": {
"type": "string",
"enum": [
"Outside"
],
"description": "Label Text"
}
},
"required": [
"labelCd",
"inputType",
"inputIndex",
"label"
],
"additionalProperties": false
},
"description": "Array of Product Labels (BACnet)"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"enum": [
"BACnet"
],
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"I37YifZSqBC1NPSa7g3T"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"BACnet IP - AHU"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"name",
"manufacturerName",
"model",
"make",
"imageLink",
"labels",
"productTypes",
"baseProtocol",
"protocols"
],
"additionalProperties": false
}
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The Date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Get Product ¶
Get ProductGET/api/v3.1/products/{productCd}
Retrieves information about a particular Product.
Returned information includes:
-
Product
-
Product Type(s)
-
Product Protocol(s)
For BACnet products the “labels” will also be returned.
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/products/r1LneacYS2P8en818LS7
URI Parameters
- productCd
string(required) Example: r1LneacYS2P8en818LS7The unique CD of the product
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"productCd": "r1LneacYS2P8en818LS7",
"name": "GE Jasco Appliance Switch Module 45603",
"manufacturerName": "General Electric",
"model": "45603",
"make": "GE Jasco",
"imageLink": "/Factory/images/products/r1LneacYS2P8en818LS7.jpg",
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "Z-Wave Switch",
"protocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_PRODUCT",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"description": "Model name of the Product"
},
"make": {
"type": "string",
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Product"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"qa54NXq0DKgyywN1HpWy"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"productTypes",
"baseProtocol",
"protocols"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The Date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Request
BACnetResponse
200Headers
Content-Type: application/jsonBody
{
"data": {
"productCd": "u1lq0isN3tv70HIy6L4G",
"name": "BACnet AHU",
"manufacturerName": "Altair",
"model": "Generic BACnet AHU",
"make": "BACnet AHU",
"imageLink": "/Factory/images/products/u1lq0isN3tv70HIy6L4G.jpg",
"labels": [
{
"labelCd": "PQ7arhw9LznXsyVGUtmy",
"inputType": 1,
"inputIndex": "5",
"label": "Outside"
}
],
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "BACnet",
"protocols": [
{
"protocolCd": "I37YifZSqBC1NPSa7g3T",
"name": "BACnet IP - AHU",
"version": "1.0"
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_PRODUCT",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"description": "Model name of the Product"
},
"make": {
"type": "string",
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Product"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"labelCd": {
"type": "string",
"enum": [
"PQ7arhw9LznXsyVGUtmy"
],
"description": "The unique Label ID"
},
"inputType": {
"type": "number",
"enum": [
1
],
"description": "BACnet Input Type"
},
"inputIndex": {
"type": "string",
"enum": [
"5"
],
"description": "BACnet Input Index"
},
"label": {
"type": "string",
"enum": [
"Outside"
],
"description": "Label Text"
}
},
"required": [
"labelCd",
"inputType",
"inputIndex",
"label"
],
"additionalProperties": false
},
"description": "Array of Product Labels (BACnet)"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"I37YifZSqBC1NPSa7g3T"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"BACnet IP - AHU"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"labels",
"productTypes",
"baseProtocol",
"protocols"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The Date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Get Product Categories ¶
Get Product CategoriesGET/api/v3.1/products/categories
Retrieve all Product Categories
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/products/categories
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"productCategoryCd": "ZSOqdczWF2OLW2KLqNQw",
"name": "Light",
"description": "General Electric",
"productTypes": [
{
"name": "AHU"
}
]
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_PRODUCT_CATEGORY",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productCategoryCd": {
"type": "string",
"enum": [
"ZSOqdczWF2OLW2KLqNQw"
],
"description": "Unique identifier for a Product Category"
},
"name": {
"type": "string",
"enum": [
"Light"
],
"description": "Name of the Category"
},
"description": {
"type": "string",
"enum": [
"General Electric"
],
"description": "Name of the Manufacturer"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
},
"required": [
"productCategoryCd",
"name",
"description",
"productTypes"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Get Product Category ¶
Get Product CategoryGET/api/v3.1/products/categories/{productCategoryCd}
Retrieve Product Category details.
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/products/categories/ZSOqdczWF2OLW2KLqNQw
URI Parameters
- productCategoryCd
string(required) Example: ZSOqdczWF2OLW2KLqNQwThe unique CD of the Product Category
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"productCategoryCd": "ZSOqdczWF2OLW2KLqNQw",
"name": "Light",
"description": "General Electric",
"productTypes": [
{
"name": "AHU"
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_PRODUCT_CATEGORY",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"productCategoryCd": {
"type": "string",
"description": "Unique identifier for a Product Category"
},
"name": {
"type": "string",
"description": "Name of the Category"
},
"description": {
"type": "string",
"description": "Name of the Manufacturer"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
},
"required": [
"productCategoryCd",
"productTypes"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Get Bridges for Product ¶
Get Bridges for ProductGET/api/v3.1/products/{productCd}/actions/getBridges{?siteCd}
Retrieve Bridge list for Product. If the optional siteCd is specified then the returned bridge product list will include additional bridge requirements for the products.
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/products/r1LneacYS2P8en818LS7/actions/getBridges?siteCd=2P8en818r1LneacYSLS7
URI Parameters
- productCd
string(required) Example: r1LneacYS2P8en818LS7The unique CD of the product
- siteCd
string(optional) Example: 2P8en818r1LneacYSLS7The unique CD of the site
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"productCd": "r1LneacYS2P8en818LS7",
"name": "GE Jasco Appliance Switch Module 45603",
"manufacturerName": "General Electric",
"model": "45603",
"make": "GE Jasco",
"imageLink": "/Factory/images/products/r1LneacYS2P8en818LS7.jpg",
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "Z-Wave Switch",
"protocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
]
},
{
"productCd": "u1lq0isN3tv70HIy6L4G",
"name": "BACnet AHU",
"manufacturerName": "Altair",
"model": "Generic BACnet AHU",
"make": "BACnet AHU",
"imageLink": "/Factory/images/products/u1lq0isN3tv70HIy6L4G.jpg",
"labels": [
{
"labelCd": "PQ7arhw9LznXsyVGUtmy",
"inputType": 1,
"inputIndex": "5",
"label": "Outside"
}
],
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "BACnet",
"protocols": [
{
"protocolCd": "I37YifZSqBC1NPSa7g3T",
"name": "BACnet IP - AHU",
"version": "1.0"
}
]
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_PRODUCT",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"productCd": {
"type": "string",
"enum": [
"r1LneacYS2P8en818LS7"
],
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch Module 45603"
],
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"enum": [
"General Electric"
],
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"enum": [
"45603"
],
"description": "Model name of the Product"
},
"make": {
"type": "string",
"enum": [
"GE Jasco"
],
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/images/products/r1LneacYS2P8en818LS7.jpg"
],
"description": "URI to image of the Product"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"qa54NXq0DKgyywN1HpWy"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"name",
"manufacturerName",
"model",
"make",
"imageLink",
"productTypes",
"baseProtocol",
"protocols"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"productCd": {
"type": "string",
"enum": [
"u1lq0isN3tv70HIy6L4G"
],
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"enum": [
"BACnet AHU"
],
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"enum": [
"Generic BACnet AHU"
],
"description": "Model name of the Product"
},
"make": {
"type": "string",
"enum": [
"BACnet AHU"
],
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/images/products/u1lq0isN3tv70HIy6L4G.jpg"
],
"description": "URI to image of the Product"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"labelCd": {
"type": "string",
"enum": [
"PQ7arhw9LznXsyVGUtmy"
],
"description": "The unique Label ID"
},
"inputType": {
"type": "number",
"enum": [
1
],
"description": "BACnet Input Type"
},
"inputIndex": {
"type": "string",
"enum": [
"5"
],
"description": "BACnet Input Index"
},
"label": {
"type": "string",
"enum": [
"Outside"
],
"description": "Label Text"
}
},
"required": [
"labelCd",
"inputType",
"inputIndex",
"label"
],
"additionalProperties": false
},
"description": "Array of Product Labels (BACnet)"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"enum": [
"BACnet"
],
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"I37YifZSqBC1NPSa7g3T"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"BACnet IP - AHU"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"name",
"manufacturerName",
"model",
"make",
"imageLink",
"labels",
"productTypes",
"baseProtocol",
"protocols"
],
"additionalProperties": false
}
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The Date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Product Driver ¶
Get Product Driver List ¶
Get Product Driver ListGET/api/v3.1/productDrivers{?protocolCd,implementerCd,name,page,limit}
Retrieve Product Driver list.
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/productDrivers?protocolCd=ZSOqdczWF2OLW2KLqNQw&implementerCd=2KLqNQwZSOqdczWF2OLW&name=BACnet&page=1&limit=100
URI Parameters
- protocolCd
string(optional) Example: ZSOqdczWF2OLW2KLqNQwThe Protocol filter
- implementerCd
string(optional) Example: 2KLqNQwZSOqdczWF2OLWThe Implementer filter
- name
string(optional) Example: BACnetFilter by (part of) name
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- limit
number(optional) Default: 10 Example: 100Number of items to return
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"productDriverCd": "0s83IPCL18SOy0FFwQ2a",
"name": "Product Driver 1",
"protocol": {
"protocolCd": "0Oy0FFwQ2s83IPCL18Sa",
"name": "Protocol 1"
},
"implementer": {
"implementerCd": "IPCL180Oy0FFwQ2s83Sa",
"name": "Implementer 1"
},
"actions": [
{
"name": "POWER_ON",
"description": "Turns the Power ON",
"controllable": true,
"requiresParam": true
}
],
"labels": [
"ProductDriverLabel"
]
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_PRODUCT_DRIVER",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productDriverCd": {
"type": "string",
"enum": [
"0s83IPCL18SOy0FFwQ2a"
],
"description": "Unique identifier of the Product Driver"
},
"name": {
"type": "string",
"enum": [
"Product Driver 1"
],
"description": "Name of the Product Driver"
},
"protocol": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"0Oy0FFwQ2s83IPCL18Sa"
],
"description": "Unique identifier of the Protocol"
},
"name": {
"type": "string",
"enum": [
"Protocol 1"
],
"description": "Name of the Protocol"
}
},
"required": [
"protocolCd",
"name"
],
"additionalProperties": false
},
"implementer": {
"type": "object",
"properties": {
"implementerCd": {
"type": "string",
"enum": [
"IPCL180Oy0FFwQ2s83Sa"
],
"description": "Unique identifier of the Implementer"
},
"name": {
"type": "string",
"enum": [
"Implementer 1"
],
"description": "Name of the Implementer"
}
},
"required": [
"implementerCd",
"name"
],
"additionalProperties": false
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"POWER_ON"
]
},
"description": {
"type": "string",
"enum": [
"Turns the Power ON"
]
},
"controllable": {
"type": "boolean",
"enum": [
true
]
},
"requiresParam": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"name",
"description",
"controllable",
"requiresParam"
],
"additionalProperties": false
},
"description": "List of Actions"
},
"labels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ProductDriverLabel"
]
},
"description": "List of labels for the Product Driver"
}
},
"required": [
"productDriverCd",
"name",
"protocol",
"implementer",
"actions",
"labels"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The Date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Get Product Driver ¶
Get Product DriverGET/api/v3.1/productDrivers/{productDriverCd}
Retrieves information about a particular Product Driver.
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/productDrivers/0s83IPCL18SOy0FFwQ2a
URI Parameters
- productDriverCd
string(required) Example: 0s83IPCL18SOy0FFwQ2aUnique identifier of the Product Driver
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"productDriverCd": "0s83IPCL18SOy0FFwQ2a",
"name": "Product Driver 1",
"protocol": {
"protocolCd": "0Oy0FFwQ2s83IPCL18Sa",
"name": "Protocol 1"
},
"implementer": {
"implementerCd": "IPCL180Oy0FFwQ2s83Sa",
"name": "Implementer 1"
},
"actions": [
{
"name": "POWER_ON",
"description": "Turns the Power ON",
"controllable": true,
"requiresParam": true
}
],
"labels": [
"ProductDriverLabel"
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_PRODUCT_DRIVER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"productDriverCd": {
"type": "string",
"description": "Unique identifier of the Product Driver"
},
"name": {
"type": "string",
"description": "Name of the Product Driver"
},
"protocol": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"description": "Unique identifier of the Protocol"
},
"name": {
"type": "string",
"description": "Name of the Protocol"
}
},
"required": [
"protocolCd",
"name"
]
},
"implementer": {
"type": "object",
"properties": {
"implementerCd": {
"type": "string",
"description": "Unique identifier of the Implementer"
},
"name": {
"type": "string",
"description": "Name of the Implementer"
}
},
"required": [
"implementerCd",
"name"
]
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"POWER_ON"
]
},
"description": {
"type": "string",
"enum": [
"Turns the Power ON"
]
},
"controllable": {
"type": "boolean",
"enum": [
true
]
},
"requiresParam": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"name",
"description",
"controllable",
"requiresParam"
],
"additionalProperties": false
},
"description": "List of Actions"
},
"labels": {
"type": "array",
"description": "List of labels for the Product Driver"
}
},
"required": [
"productDriverCd",
"name",
"actions",
"labels"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The Date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Product Types ¶
Product Types List ¶
Get Product Types ListGET/api/v3.1/productTypes{?editParameters,limit,page}
Get the Product Typess list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Product Types
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/productTypes?editParameters=false&limit=100&page=1
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"productTypeCd": "mN8E7o6JLaCe1Tx8GVNG",
"name": "My Product Type",
"description": "Description of Product Type",
"productCategory": {
"productCategoryCd": "5Ea1ps68Se449Kg39H6Z",
"name": "Product Category"
},
"editParameters": {
"productTypeCd": {
"fieldName": "productTypeCd",
"view": "read",
"type": "string",
"required": false,
"label": "Product Type CD",
"labelPlural": "Product Type CDs",
"help": "Unique identifier for the Product Type."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique"
},
"description": {
"fieldName": "description",
"view": "write",
"type": "string",
"required": false,
"label": "Description",
"labelPlural": "Descriptions",
"help": "Product Type Description"
},
"productCategory": {
"productCategoryCd": {
"fieldName": "productCategoryCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Product Category CD",
"labelPlural": "Product Category CDs",
"help": "Unique identifier for the Product Category."
}
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_PRODUCT_TYPE",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Product Type ¶
Get Product TypeGET/api/v3.1/productType/{productTypeCd}{?editParameters}
- Types of Responses
- Response 200 - If Product Type is retrieved
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/productType/mN8E7o6JLaCe1Tx8GVNG?editParameters=false
URI Parameters
- productTypeCd
string(required) Example: mN8E7o6JLaCe1Tx8GVNGThe unique identifier of the Product Type
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"productTypeCd": "mN8E7o6JLaCe1Tx8GVNG",
"name": "My Product Type",
"description": "Description of Product Type",
"productCategory": {
"productCategoryCd": "5Ea1ps68Se449Kg39H6Z",
"name": "Product Category"
},
"editParameters": {
"productTypeCd": {
"fieldName": "productTypeCd",
"view": "read",
"type": "string",
"required": false,
"label": "Product Type CD",
"labelPlural": "Product Type CDs",
"help": "Unique identifier for the Product Type."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique"
},
"description": {
"fieldName": "description",
"view": "write",
"type": "string",
"required": false,
"label": "Description",
"labelPlural": "Descriptions",
"help": "Product Type Description"
},
"productCategory": {
"productCategoryCd": {
"fieldName": "productCategoryCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Product Category CD",
"labelPlural": "Product Category CDs",
"help": "Unique identifier for the Product Category."
}
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_PRODUCT_TYPE",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"productTypeCd": {
"type": "string",
"description": "Unique identifier assigned for a Product Type"
},
"name": {
"type": "string",
"description": "Name of the Product Type"
},
"description": {
"type": "string",
"description": "Description of the Product Type"
},
"productCategory": {
"type": "object",
"properties": {
"productCategoryCd": {
"type": "string",
"description": "Unique identifier assigned for a Product Category"
},
"name": {
"type": "string",
"description": "Name of the Product Category"
}
},
"required": [
"productCategoryCd",
"name"
]
},
"editParameters": {
"type": "object",
"properties": {
"productTypeCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"description": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"productCategory": {
"type": "object",
"properties": {
"productCategoryCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"productCategoryCd"
]
}
},
"required": [
"productTypeCd",
"name",
"description"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"productTypeCd",
"name"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Create a new Product TypePOST/api/v3.1/productType/
- Types of Responses
- Response 200 - Update successful - productTypeCd returned in body
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/productType/
Request
Body
{
"name": "My Product Type",
"description": "Description of Product Type",
"productCategory": {
"productCategoryCd": "5Ea1ps68Se449Kg39H6Z"
}
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Product Type"
},
"description": {
"type": "string",
"description": "Description of the Product Type"
},
"productCategory": {
"type": "object",
"properties": {
"productCategoryCd": {
"type": "string",
"description": "Unique identifier assigned for a Product Category"
}
},
"required": [
"productCategoryCd"
]
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"productTypeCd": "mN8E7o6JLaCe1Tx8GVNG"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_PRODUCT_TYPE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"productTypeCd": {
"type": "string",
"description": "Unique identifier assigned for a Product Type"
}
},
"required": [
"productTypeCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_PRODUCT_TYPE",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Update a Product TypePUT/api/v3.1/productType/{productTypeCd}
Only send in data that is changed
- Types of Responses
- Response 204 - Update successful - no body returned
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/productType/mN8E7o6JLaCe1Tx8GVNG
URI Parameters
- productTypeCd
string(required) Example: mN8E7o6JLaCe1Tx8GVNGThe Product Type CD
Request
Body
{
"name": "New Product Type Name"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Headers
Content-Type: application/jsonResponse
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_PRODUCT_TYPE",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Delete a Product TypeDELETE/api/v3.1/productType/{productTypeCd}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/productType/mN8E7o6JLaCe1Tx8GVNG
URI Parameters
- productTypeCd
string(required) Example: mN8E7o6JLaCe1Tx8GVNGThe Product Type CD
Response
204Headers
Content-Type: application/jsonProduct Details ¶
Devices - shared information
BACnet devices
Main section describing the discovered equipment/device
"997": {
"display-name": "Altair997Demo_997",
"device-identifier": "997",
"address": "10:38:0:235 0xBAC",
"saddress": "0",
"system-status": "operational",
"vendor-name": "Tridium",
"vendor-identifier": "36",
"model-name": "NiagaraAX Station",
"standard-version": "3.8.38.6",
"software-version": "Tridium 3.8.38.9",
"bacnet-network": 0,
"multiread": 1,
"router": 0,
"max-master": 0,
"max-info-frames": 0,
"objects": {..}Fields of interest (rest are useless or used by the IoT Server, but are not use by the API)
- device-identifier - The BACnet identifier for this equipment, unique on the BACnet network
The following fields are of special interest because they can quickly identify some equipment that is from a particular manufacturer. Seeing equipment that is from a vendor can be very useful in quickly identifying equipment of interest, and knowing exactly how to configure it.
-
vendor-name
-
model-name
-
standard-version
-
software-version
Discovery JSON - Objects
"997:0:0": {
"object-type": "analog-input",
"object-identifier": 0,
"object-name": "Logic.VAV.BoxFlow",
"value": 1192.02,
"units": "cubic-feet-per-minute",
"description": "Box Flow",
"cov": 0
}-
object-type - describes the type of data that is being stored in this data point
- Enum options:
- analog-input
- analog-value
- multi-state-value
- Enum options:
-
object-identifier - identifies the data point on the equipment
-
object-name - Name given by either the Product manufacturer, or an installer at commissioning
-
value - current value of this data point
-
units - the units of this data
- Examples:
- degrees-fahrenheit
- degrees-celsius
- cubic-feet-per-minute
- percent
- killowatt-hours
- volts
- hertz
- Examples:
-
description - Description of the data point
-
cov - whether this particular data point supports Change of Value
Custom Data Labels and Custom Product Templates ¶
Overview
Altair SmartEdge provides base Products pre-configured with suggestions to use for the Devices’ Data Labels. But these Data Labels may not meet the Customers requirements.
Customers may need a way to customize Devices and the Data Labels they need, allowing them to use familiar terms to describe the data they are extracting from equipment/Devices.
SmartEdge provides this functionality through Custom Data Labels, and Custom Product Templates.
To allow customization, Altair SmartEdge provides the following functionality:
-
Managing Data Labels associated with a Device. A User can choose a SmartEdge Product, and then manage the Data Labels associated with the new Device. This allows the User to decide the exact Data Labels (Generic or Custom) that are associated with the Device. A User can:
- add additional existing Generic Data Labels, or add Custom Data Labels (created by a User)
- not use recommended Generic Data Labels that were associated with the original Product
- remove any Data Labels (Generic or Custom) that were assigned to a Device
-
Creating Custom Product Templates with the Data Labels that the User desires. This allows the User to reuse a Device configuration over and over again without having to reset the recommended Data Labels.
-
Custom Product Templates are treated just like any other existing Product
-
Contain only the Data Labels the User chooses
Note: this section has several JSON structures describing how the system works. Some of these have comments embedded in the JSON. It is recognized that JSON does not support comments, but for documentation purposes, we added them.
Data Labels
Sometimes Data Labels are referred to as “Labels”, and Custom Data Labels may be referred to as Custom Labels.
A Device’s list of recommended Data Labels is available in the API editParameters section, on the property called streamingLabels.
Create a Custom Data Label
Custom Data Labels can be created via SmartEdge API. The custom labels added to the template are custom fields of the Custom Label Type, see this type’s request on Create a new Custom Field.
The inbound endpoint is: POST https://altairsmartedge.com/api/v3.1/companies/{companyCd}/customFields/?editParameters=false with a body like this:
{
"dataLabel": "DL_CUSTOM_LABEL_1", // User chosen Data Label. Must be Unique w/in the Company structure
"type": "CFT_CUSTOM_LABEL", // tells the system what kind of Custom Field to create - use CFT_CUSTOM_LABEL for Custom Data Labels
"dataType": "FAHRENHEIT", // This identifies the data type of the values - is helpful when assigning Data Labels to BACnet set points. Data Types: STRING,FLOAT,INTEGER,BOOLEAN,PERCENT,CELSIUS,FAHRENHEIT,ENUM
"dataTypeOption": [], // not used at this time
"help": "This field is for...", // Help text describing this Data Label
"label": "My Field Label", // Text that is used in a form describing the Data Label. ex: dataLabel: "my_custom_label", and label: "My Custom Label"
"labelPlural": "My Field Labels" // plural of the label
}Retrieve List of Custom Data Labels
All available Custom Data Labels can be seen in the Custom Label List for a Company. This list of Custom Data Labels includes labels inherited from parent Companies, but does not include the Generic Data Labels.
Custom Data Labels are an implementation of Custom Fields, so the fields returned are not necessarily all applicable to a Custom Data Label.
Request endpoint: GET https://iot.altairsmartedge.com/api/v3.1/company/{companyCd}/customLabels{?page,limit,orderBy,direction}
{
"data": [
{
"customFieldCd": "a1psH6Z5g3968ESe449K", // notice this is a CustomFieldCD, but it is the office Custom Data Label identifier
"dataLabel": "DL_CUSTOM_LABEL_1", // the actual Data Label that will be used to tag the data
"companyCd": "H6Z5Ea1psSe449Kg3968", // the Company this Custom Data Label belongs to
"type": "CFT_CUSTOM_LABEL", // identifies it as a Custom Data Label request
"dataType": "STRING", // Data Types can be: STRING, FLOAT, INTEGER, BOOLEAN, PERCENT, CELSIUS, FAHRENHEIT, ENUM
"dataTypeOption": [], // if the dataType = ENUM, then this field is used to hold the ENUM values as comma delimited list
"validation": "/^[A-Z]{0,3}$/", // not used for Custom Data labels
"readOnly": false, // not used for Custom Data labels
"help": "This field is for...", // help text
"label": "My Field Label", // text that is shown to a User, like in a form
"labelPlural": "My Field Labels", // plural of the text
"required": false // not used for Custom Data labels
},
{ ... } // etc...
],
"meta": {
...
}
}The Generic Data Labels can be retrieved using the similar Global Label List endpoint (https://iot.altairsmartedge.com/api/v3.1/company/{companyCd}/GenericLabels).
Custom Product Templates
A Custom Product Template is used by Users to create Devices. The Custom Product Template is available within the Company it was created, and inherited down Sub-Companies.
They are actually a version of Custom Fields, so Custom Product Templates have a Custom Field CD as their unique key identifier.
There are 2 ways to create a Custom Product Template:
-
Create from scratch (from an existing Product) - as described in the in this section.
-
Create from an existing Device - After a Device has been configured a User can create a Custom Product Template from this configuration and use it as a Product (see Translate Into Custom Product Template).
Deleting a Custom Product Template is complex
-
Not in use - If no Devices exist using the Custom Product Template, then the Custom Product Template can be deleted.
-
In use - If Device(s) exists in the system that is using a Custom Product Template, then deleting the Template would strand the Device(s) and make it unusable.
- Therefor a Custom Product Template is instead hidden from being used ever again thereby allowing existing Devices to continue to be accessible but no new devices created. This is a 2-step process which requires that the User knows how many Devices are affected, and they confirm they want to continue with it anyway.
Notes:
-
Custom Product Templates are currently only available on BACnet products.
-
A new Custom Product Template can be created from a Device that was created from an existing Custom Product Template. The original Product references will be maintained (manufacturer, version, image, …).
-
Custom Product Templates do not have to use Custom Data Labels, but can.
-
Custom Product Templates are sometimes referred to as Custom Products.
Create a Custom Product Template
Custom Product Templates can be created on a Company Level. The Custom Product Template can add custom labels and/or global labels . See the Custom Product Templates Type request on Create a new Custom Field.
Creating a New Device Using a Custom Product Template
Once a Custom Product Template has been created, a User can send in the Custom Product Template’s unique field (Custom Field CD) just like a Product CD to the Create Device API endpoint.
The following API call creates a new Device using the Custom Product Template that was created in the above example.
API endpoint: POST https://altairsmartedge.com/api/v3.1/sites/{siteCd}/devices/?editParameters=false
{
"name": "Electric Whole House Meter",
"location": "Back yard fence",
"product": {
"productCd": "sD76fgAkdfuxdf" // this field is the Custom Product Template Custom Field CD
}
}Definitions
Data Label
Data Labels are used to identify data on a Device. They provide a type of tag so that the telemetry data that is collected from a Device is recognized as a particular type of data that is measuring (or controlling, etc…) a particular thing. Examples of use:
-
An example of a Generic Data Label is DL_AIR_COOL_STAGE1_STATUS_BOOLEAN which would be used to identify measurements of the “cooling air stage 1 system operating status”. This Data Label specifies that the data is the type of boolean.
-
An example of an implementation: a piece of BACnet equipment has a data-point that is tracking the “stage 1 air status”. When we configure the new Device to talk to this BACnet equipment, we would assign the Data Label DL_AIR_COOL_STAGE1_STATUS_BOOLEAN to that Data Point. Then, when we want to extract the values (0/1) for when this is running, we would use that same Data Label for the API request (see details here).
There are 2 types of Data Labels, Generic and Custom Data Labels. Generic Data Labels are created by Altair Smart Edge and are assigned to Products. Custom Data Labels are created by Customers and can be used on any BACnet Device.
Sometimes Data Labels are referred to as Event Types. A specific Data Label can only be used once on a particular Device. i.e. a meter Device can only have 1 DL_ELECTRIC_KWH_ODM, otherwise, it is impossible to tell what is being metered.
Generic Data Label
Generic Data Labels are created by Altair and used for the base Products that exist. They attempt to be very specific to equipment parts so that they are clear about what they are measuring/identifying.
Examples:
-
DL_ELECTRIC_KWH_ODM - Electric, kilowatt hour (kWh odm)
-
DL_PUMP_SPEED_HERTZ - Pump speed (Hz)
-
DL_AIR_DAMPER_OPEN_PERCENT - Air damper open (%)
-
DL_AIR_ZONE1_MAXIMUM_SETPOINT_TEMPERATURE_CELSIUS - Air zone 1 maximum setpoint temperature ©
Part of Altairs goal with these predefined Products and Generic Data Labels is to provide some consistency across Products and Protocols - normalization. If the recommended Data Labels are accepted for a Device, then that Device will match others of the same product Type
Custom Data Label
Users can create their own Data Labels called Custom Data Labels. They can be used on any Device for identifying what the Device is measuring for a particular data-point and value. This allows Users to use their familiar terms for recording data and getting it into their system.
Custom Product Template
Custom Product Templates allow Users to create a new Product that matches their interests - with their chosen original Product and Data Labels. Once this is created, they can use it like any other Product in the system, but it will have the Data Labels they want to be used for the Device.
Sites ¶
Individual companies can add tag elements in the system (Sites, Devices, Users, Partners) with meta data that is specific to their needs. These are generic fields that will appear as regular properties on those objects. They are grouped under a property called customFields, if present on the object. See the Custom Fields section for help on defining these element.
Sites List ¶
Get Site ListGET/api/v3.1/sites{?editParameters,limit,page,orderBy,direction,filter}
Get the Site List.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Sites
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites?editParameters=false&limit=100&page=1&orderBy=name&direction=asc&filter=text
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: name Example: nameField to order results by
Choices:
nameaddresscitystate- direction
string(optional) Default: asc Example: ascSort direction for the results list
Choices:
ascdesc- filter
string(optional) Example: textFilters results by matching text in fields: Name, City, Address
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"siteCd": "cK4Uae73unb72TYuDJDr",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "Test Site",
"address1": "123 main st",
"address2": "``",
"city": "Los Angeles",
"state": "CA",
"countryLcd": "COUNTRY_US",
"longitude": -118.243893,
"latitude": 34.051908,
"imageLink": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg",
"primaryUser": "primarUser",
"siteImage": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg",
"operationsStatus": "OPERATIONS_STATUS_ACTIVE",
"applicationPartnerDefault": "applicationPartnerDefaultCd",
"siteOverview": {
"deviceCount": 12,
"ruleCount": 1,
"lastPoll": "2016-04-02 12:33:14",
"lastUpdated": "2016-04-01 10:13:45"
},
"users": [
{
"userCd": "W8JNPoPg7rAh7B45HZMA",
"firstName": "First",
"lastName": "Last",
"fullName": "First Last"
}
],
"programs": [
{
"programCd": "Pg7rAh7B45W8JNPoHZMA",
"name": "Program"
}
],
"applicationPartners": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Application Partner Name"
}
],
"tags": [],
"editParameters": {
"siteCd": {
"fieldName": "siteCd",
"view": "read",
"type": "string",
"required": true,
"label": "SiteCd",
"labelPlural": "SiteCds",
"help": "Unique identifier for the Site."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"address1": {
"fieldName": "address1",
"view": "write",
"type": "string",
"required": false,
"label": "Address1",
"labelPlural": "Address1s",
"help": "Address1 is optional"
},
"address2": {
"fieldName": "address2",
"view": "write",
"type": "string",
"required": false,
"label": "Address2",
"labelPlural": "Address2s",
"help": "Address2 is optional"
},
"city": {
"fieldName": "city",
"view": "write",
"type": "string",
"required": false,
"label": "City",
"labelPlural": "Citys",
"help": "City is optional"
},
"state": {
"fieldName": "state",
"view": "write",
"type": "string",
"required": false,
"label": "State",
"labelPlural": "States",
"help": "State is optional"
},
"countryLcd": {
"fieldName": "countryLcd",
"view": "write",
"type": "string",
"required": false,
"label": "Country",
"labelPlural": "Countries",
"help": "Country is optional"
},
"longitude": {
"fieldName": "longitude",
"view": "write",
"type": "number",
"required": false,
"label": "Longitude",
"labelPlural": "Longitudes",
"help": "Longitude is optional"
},
"latitude": {
"fieldName": "latitude",
"view": "write",
"type": "number",
"required": false,
"label": "Latitude",
"labelPlural": "Latitudes",
"help": "Latitude is optional"
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "string",
"required": true,
"label": "Image",
"labelPlural": "Images",
"help": "A picture of the Device or Site."
},
"primaryUser": {
"fieldName": "primaryUser",
"view": "write",
"type": "number",
"required": false,
"label": "Primary User",
"labelPlural": "Primary Users",
"help": "Primary User is required"
},
"siteImage": {
"fieldName": "siteImage",
"view": "write",
"type": "number",
"required": false,
"label": "Site Image",
"labelPlural": "Site Images",
"help": "Site image is optional"
},
"operationsStatus": {
"fieldName": "operationsStatus",
"view": "write",
"type": "string",
"required": false,
"label": "Operation Status",
"labelPlural": "Operation Statuses",
"help": "Operation Status is optional"
},
"applicationPartnerDefault": {
"fieldName": "applicationPartnerDefault",
"view": "write",
"type": "number",
"required": false,
"label": "Application Partner Default",
"labelPlural": "Application Partner Defaults",
"help": "Application Partner Default is optional"
},
"users": {
"fieldName": "users",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Users",
"labelPlural": "Users",
"help": "List of associated users"
},
"programs": {
"fieldName": "programs",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Program",
"labelPlural": "Programs",
"help": "List of associated programs"
},
"applicationPartners": {
"fieldName": "applicationPartners",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Application Partner",
"labelPlural": "Application Partners",
"help": "List of associated application partners"
},
"tags": {
"fieldName": "tags",
"view": "write",
"type": "array",
"required": false,
"label": "Tag",
"labelPlural": "Tags",
"help": "List of custom tags"
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_SITE",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this site is assigned to"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "The unique name of the Site"
},
"address1": {
"type": "string",
"enum": [
"123 main st"
],
"description": "The first address for the Site"
},
"address2": {
"type": "string",
"enum": [
"``"
],
"description": "Second address field if required"
},
"city": {
"type": "string",
"enum": [
"Los Angeles"
],
"description": "City of the site"
},
"state": {
"type": "string",
"enum": [
"CA"
],
"description": "State"
},
"countryLcd": {
"type": "string",
"enum": [
"COUNTRY_US"
],
"description": "Country code"
},
"longitude": {
"type": "number",
"enum": [
-118.243893
],
"description": "Longitude of the address and city info"
},
"latitude": {
"type": "number",
"enum": [
34.051908
],
"description": "Latitude"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg"
],
"description": "URI to image of the Users uploaded image of the Site"
},
"primaryUser": {
"type": "string",
"enum": [
"primarUser"
],
"description": "the primary users userCd"
},
"siteImage": {
"type": "string",
"enum": [
"/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg"
],
"description": "sites image"
},
"operationsStatus": {
"type": "string",
"enum": [
"OPERATIONS_STATUS_ACTIVE"
],
"description": "current site operation status"
},
"applicationPartnerDefault": {
"type": "string",
"enum": [
"applicationPartnerDefaultCd"
],
"description": "default application partner for this site"
},
"siteOverview": {
"type": "object",
"properties": {
"deviceCount": {
"type": "number",
"enum": [
12
],
"description": "Number of Devices associated with this Site"
},
"ruleCount": {
"type": "number",
"enum": [
1
],
"description": "Number of Rules associated with this Site"
},
"lastPoll": {
"type": "string",
"enum": [
"2016-04-02 12:33:14"
],
"description": "Last poll date"
},
"lastUpdated": {
"type": "string",
"enum": [
"2016-04-01 10:13:45"
],
"description": "Last poll date"
}
},
"required": [
"deviceCount",
"ruleCount",
"lastPoll",
"lastUpdated"
],
"additionalProperties": false,
"description": "An over of some information regarding the Site"
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"W8JNPoPg7rAh7B45HZMA"
]
},
"firstName": {
"type": "string",
"enum": [
"First"
]
},
"lastName": {
"type": "string",
"enum": [
"Last"
]
},
"fullName": {
"type": "string",
"enum": [
"First Last"
]
}
},
"required": [
"userCd",
"firstName",
"lastName",
"fullName"
],
"additionalProperties": false
},
"description": "Array of Users associated with this Site"
},
"programs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"programCd": {
"type": "string",
"enum": [
"Pg7rAh7B45W8JNPoHZMA"
]
},
"name": {
"type": "string",
"enum": [
"Program"
]
}
},
"required": [
"programCd",
"name"
],
"additionalProperties": false
},
"description": "Array of Programs associated with this Site"
},
"applicationPartners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
}
},
"required": [
"partnerCd",
"name"
],
"additionalProperties": false
},
"description": "List of ApplicationPartners"
},
"tags": {
"description": "Custom tags added by the user"
},
"editParameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"siteCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"SiteCd"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"SiteCds"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Site."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"companyCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Company CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Company CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Company."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name is required, and must be unique within a Site"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"address1": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"address1"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Address1"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Address1s"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Address1 is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"address2": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"address2"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Address2"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Address2s"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Address2 is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"city": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"city"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"City"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Citys"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"City is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"state": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"state"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"State"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"States"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"State is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"countryLcd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"countryLcd"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Country"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Countries"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Country is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"longitude": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"longitude"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Longitude"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Longitudes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Longitude is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"latitude": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"latitude"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Latitude"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Latitudes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Latitude is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"imageLink": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"imageLink"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Image"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Images"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"A picture of the Device or Site."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"primaryUser": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"primaryUser"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Primary User"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Primary Users"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Primary User is required"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"siteImage": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"siteImage"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Site Image"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Site Images"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Site image is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"operationsStatus": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"operationsStatus"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Operation Status"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Operation Statuses"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Operation Status is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"applicationPartnerDefault": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"applicationPartnerDefault"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Application Partner Default"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Application Partner Defaults"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Application Partner Default is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"users": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"users"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Users"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Users"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of associated users"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"programs": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"programs"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Program"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Programs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of associated programs"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"applicationPartners": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"applicationPartners"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Application Partner"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Application Partners"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of associated application partners"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"tags": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"tags"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"object",
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf"
],
"default": [
"array"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Tag"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Tags"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of custom tags"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"siteCd",
"companyCd",
"name",
"imageLink",
"primaryUser"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"siteCd",
"company",
"name",
"primaryUser",
"siteOverview",
"users",
"programs",
"applicationPartners",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": [
"JSON"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Multi Delete SitesDELETE/api/v3.1/sites{?siteCds}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint, or type and id don’t match
See also: Global Failures
Example URI
DELETE https://altairsmartedge.com/api/v3.1/sites?siteCds=cK4Uae73unb72TYuDJDr,72TYuDJDrcK4Uae73unb
URI Parameters
- siteCds
string(required) Example: cK4Uae73unb72TYuDJDr,72TYuDJDrcK4Uae73unbComma separated Site CDs
Response
204Headers
Content-Type: application/jsonSite ¶
Get SiteGET/api/v3.1/sites/{siteCd}{?editParameters}
- Types of Responses
- Response 200 - Retrieval successful - body included with any extra changes
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"siteCd": "cK4Uae73unb72TYuDJDr",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "Test Site",
"address1": "123 main st",
"address2": "``",
"city": "Los Angeles",
"state": "CA",
"countryLcd": "COUNTRY_US",
"longitude": -118.243893,
"latitude": 34.051908,
"imageLink": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg",
"primaryUser": "primarUser",
"siteImage": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/image1.jpg",
"operationsStatus": "OPERATIONS_STATUS_ACTIVE",
"applicationPartnerDefault": "applicationPartnerDefaultCd",
"siteOverview": {
"deviceCount": 12,
"ruleCount": 1,
"lastPoll": "2016-04-02 12:33:14",
"lastUpdated": "2016-04-01 10:13:45"
},
"users": [
{
"userCd": "W8JNPoPg7rAh7B45HZMA",
"firstName": "First",
"lastName": "Last",
"fullName": "First Last"
}
],
"programs": [
{
"programCd": "Pg7rAh7B45W8JNPoHZMA",
"name": "Program"
}
],
"applicationPartners": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Application Partner Name"
}
],
"tags": [],
"editParameters": {
"siteCd": {
"fieldName": "siteCd",
"view": "read",
"type": "string",
"required": true,
"label": "SiteCd",
"labelPlural": "SiteCds",
"help": "Unique identifier for the Site."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"address1": {
"fieldName": "address1",
"view": "write",
"type": "string",
"required": false,
"label": "Address1",
"labelPlural": "Address1s",
"help": "Address1 is optional"
},
"address2": {
"fieldName": "address2",
"view": "write",
"type": "string",
"required": false,
"label": "Address2",
"labelPlural": "Address2s",
"help": "Address2 is optional"
},
"city": {
"fieldName": "city",
"view": "write",
"type": "string",
"required": false,
"label": "City",
"labelPlural": "Citys",
"help": "City is optional"
},
"state": {
"fieldName": "state",
"view": "write",
"type": "string",
"required": false,
"label": "State",
"labelPlural": "States",
"help": "State is optional"
},
"countryLcd": {
"fieldName": "countryLcd",
"view": "write",
"type": "string",
"required": false,
"label": "Country",
"labelPlural": "Countries",
"help": "Country is optional"
},
"longitude": {
"fieldName": "longitude",
"view": "write",
"type": "number",
"required": false,
"label": "Longitude",
"labelPlural": "Longitudes",
"help": "Longitude is optional"
},
"latitude": {
"fieldName": "latitude",
"view": "write",
"type": "number",
"required": false,
"label": "Latitude",
"labelPlural": "Latitudes",
"help": "Latitude is optional"
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "string",
"required": true,
"label": "Image",
"labelPlural": "Images",
"help": "A picture of the Device or Site."
},
"primaryUser": {
"fieldName": "primaryUser",
"view": "write",
"type": "number",
"required": false,
"label": "Primary User",
"labelPlural": "Primary Users",
"help": "Primary User is required"
},
"siteImage": {
"fieldName": "siteImage",
"view": "write",
"type": "number",
"required": false,
"label": "Site Image",
"labelPlural": "Site Images",
"help": "Site image is optional"
},
"operationsStatus": {
"fieldName": "operationsStatus",
"view": "write",
"type": "string",
"required": false,
"label": "Operation Status",
"labelPlural": "Operation Statuses",
"help": "Operation Status is optional"
},
"applicationPartnerDefault": {
"fieldName": "applicationPartnerDefault",
"view": "write",
"type": "number",
"required": false,
"label": "Application Partner Default",
"labelPlural": "Application Partner Defaults",
"help": "Application Partner Default is optional"
},
"users": {
"fieldName": "users",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Users",
"labelPlural": "Users",
"help": "List of associated users"
},
"programs": {
"fieldName": "programs",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Program",
"labelPlural": "Programs",
"help": "List of associated programs"
},
"applicationPartners": {
"fieldName": "applicationPartners",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Application Partner",
"labelPlural": "Application Partners",
"help": "List of associated application partners"
},
"tags": {
"fieldName": "tags",
"view": "write",
"type": "array",
"required": false,
"label": "Tag",
"labelPlural": "Tags",
"help": "List of custom tags"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SITE",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"description": "The unique CD for the Site"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"description": "Company this site is assigned to"
},
"name": {
"type": "string",
"description": "The unique name of the Site"
},
"address1": {
"type": "string",
"description": "The first address for the Site"
},
"address2": {
"type": "string",
"description": "Second address field if required"
},
"city": {
"type": "string",
"description": "City of the site"
},
"state": {
"type": "string",
"description": "State"
},
"countryLcd": {
"type": "string",
"description": "Country code"
},
"longitude": {
"type": "number",
"description": "Longitude of the address and city info"
},
"latitude": {
"type": "number",
"description": "Latitude"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Users uploaded image of the Site"
},
"primaryUser": {
"type": "string",
"description": "the primary users userCd"
},
"siteImage": {
"type": "string",
"description": "sites image"
},
"operationsStatus": {
"type": "string",
"description": "current site operation status"
},
"applicationPartnerDefault": {
"type": "string",
"description": "default application partner for this site"
},
"siteOverview": {
"type": "object",
"properties": {
"deviceCount": {
"type": "number",
"description": "Number of Devices associated with this Site"
},
"ruleCount": {
"type": "number",
"description": "Number of Rules associated with this Site"
},
"lastPoll": {
"type": "string",
"description": "Last poll date"
},
"lastUpdated": {
"type": "string",
"description": "Last poll date"
}
},
"required": [
"deviceCount",
"ruleCount",
"lastPoll",
"lastUpdated"
],
"description": "An over of some information regarding the Site"
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"W8JNPoPg7rAh7B45HZMA"
]
},
"firstName": {
"type": "string",
"enum": [
"First"
]
},
"lastName": {
"type": "string",
"enum": [
"Last"
]
},
"fullName": {
"type": "string",
"enum": [
"First Last"
]
}
},
"required": [
"userCd",
"firstName",
"lastName",
"fullName"
],
"additionalProperties": false
},
"description": "Array of Users associated with this Site"
},
"programs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"programCd": {
"type": "string",
"enum": [
"Pg7rAh7B45W8JNPoHZMA"
]
},
"name": {
"type": "string",
"enum": [
"Program"
]
}
},
"required": [
"programCd",
"name"
],
"additionalProperties": false
},
"description": "Array of Programs associated with this Site"
},
"applicationPartners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
}
},
"required": [
"partnerCd",
"name"
],
"additionalProperties": false
},
"description": "List of ApplicationPartners"
},
"tags": {
"description": "Custom tags added by the user"
},
"editParameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"address1": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"address2": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"city": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"state": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"countryLcd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"longitude": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"latitude": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"imageLink": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"primaryUser": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"siteImage": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"operationsStatus": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"applicationPartnerDefault": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "number",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"users": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"programs": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"applicationPartners": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"tags": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"object",
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf"
],
"default": [
"array"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"siteCd",
"companyCd",
"name",
"imageLink",
"primaryUser"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"siteCd",
"name",
"primaryUser",
"siteOverview",
"users",
"programs",
"applicationPartners",
"editParameters"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": [
"JSON"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Create a new SitePOST/api/v3.1/sites/{?editParameters}
Process options for creating a new site
Custom tags can be added to a site. Send in as an array. Existing tags not sent in with an update will get removed.
Send in all required fields for a new site
-
Send in this POST with all required fields set
-
API will validate all the fields and return either OK or errors
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/?editParameters=false
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"company": {
"companyCd": "4fs44gtrgaer4t"
},
"name": "Newly Created Site",
"city": "Fremont",
"state": "CA",
"zipCode": "94538",
"countryLcd": "USA",
"primaryUser": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "CD of the Company"
}
},
"required": [
"companyCd"
]
},
"name": {
"type": "string",
"description": "Name of the Site, as provided by the User"
},
"city": {
"type": "string",
"description": "Name of the City, as provided by the User."
},
"state": {
"type": "string",
"description": "Name of the State, as provided by the User."
},
"zipCode": {
"type": "string",
"description": "ZipCode, as provided by the User."
},
"countryLcd": {
"type": "string",
"description": "Country Code, as provided by the User."
},
"primaryUser": {
"type": "string",
"description": "`primaryUserCd` (string, required) - site creator"
}
},
"required": [
"company",
"name",
"city",
"state",
"zipCode",
"countryLcd"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"siteCd": "ofcVbSsW0JRNvwy2QZOH"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SITE",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"description": "Returns new siteCd"
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": [
"JSON"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Update a SitePUT/api/v3.1/sites/{siteCd}{?editParameters}
Custom tags can be added to a site. Send in as an array. Existing tags not sent in with an update will get removed.
Only send in data that is changed
For example: if the name, and a Site Info of the site is changing, then the body would be:
Site came down as this …
...
"name": "blah old name",
...
"siteTimezone":"America\New_York"
...
now you want to change the name, and HI_PRIMARY_USER, then you send in ...
{
"name": "new name",
"primaryUser": "replaceWithNewUserCd"
}Custom Fields: verify previous data
When updating a custom field on a site you can verify that the current value you have for the field has not been updated in the database since the retrieval by sending in so-called “previousData”. The previous data should hold the data exactly as retrieved previously in an API call. It will be compared with the data in the database. If it is unchanged then the new value sent in for the custom field can be saved. If changed then an error message will be returned.
Example of data to send in:
{
"customFields": {
"myCustomField": "newValue"
},
"previousData": {
"customFields": {
"myCustomField": "existingValue"
}
}
}- Types of Responses
- Response 200 - Update successful
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr?editParameters=false
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
Request
Body
{
"name": "Updated Site Name"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Site, as provided by the User"
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"siteCd": "ofcVbSsW0JRNvwy2QZOH"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SITE",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"description": "Returns new siteCd"
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": [
"JSON"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Delete a SiteDELETE/api/v3.1/sites/{siteCd}{?editParameters}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint, or type and id don’t match
Example URI
DELETE https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr?editParameters=false
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
Response
204Headers
Content-Type: application/jsonSite Users ¶
Primary User
The Primary User of a Site is found in a siteInfo record with infoTypeLcd IT_PRIMARY_USER. For example:
...
primarUser: "4G0MJIdpsgY4Rm1dQv4s"
...If you want to change the Primary User then you Update User using
{
"primaryUser": "replaceWithNewUserCd"
}Associated Users
The Users associated with a Site are found on the “users” property of the Site object.
...
"users": [
{
"userCd": "W8JNPoPg7rAh7B45HZMA",
"firstName": "First",
"lastName": "Last",
"fullName": "First Last"
}
],
...The list of Users that can be associated with a Site can be found in the editParameters of the Site object:
...
"editParameters": {
...
"users": {
"fieldName": "users",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Users",
"labelPlural": "Users",
"help": "",
"options": [
{
"value": "W8JNPoPg7rAh7B45HZMA",
"text": "First Last"
},
{
"value": "VOo7dZR0P6gZelug0wv0",
"text": "Test User"
}
]
},
...
}
}
...To update associated users for a site, pass in the array of all associated User CDs.
{
"users": [
"W8JNPoPg7rAh7B45HZMA",
"VOo7dZR0P6gZelug0wv0"
]
}The format is the same when creating a Site, you can pass in an array of User CDs.
Site Actions ¶
Action Commands
Discover Devices ¶
Discover DevicesGET/api/v3.1/sites/{siteCd}/actions/discover
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/discover
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"baseProtocol": "BACnet",
"identifier": "998",
"ip": "192.168.2.34",
"mac": "3D:01:CC",
"id": "998",
"subaddress": "``",
"driver": "3m",
"productCd": "WetpVV1FCOB75vVHo6ik",
"bridgeCd": "``",
"status": "online",
"name": "BACnet Chiller",
"make": "Altair",
"model": "Generic BACnet Chiller",
"imageLink": "/Factory/images/products/WetpVV1FCOB75vVHo6ik.jpg",
"productTypes": [
{
"name": "Chiller"
}
],
"isBridge": false,
"needsBridge": false,
"bridgeRequirement": "BR_BRIDGE_REQ_ASSIGNED",
"siblingProductCd": "``"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DISCOVER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"baseProtocol": {
"type": "string",
"enum": [
"BACnet",
"ControlByWeb",
"Insteon",
"IP",
"ZigBee",
"ZWave"
],
"description": "The base protocol of the discovered device"
},
"identifier": {
"type": "string",
"enum": [
"998"
],
"description": "identifier, depending on device, could be ip, mac or id"
},
"ip": {
"type": "string",
"enum": [
"192.168.2.34"
],
"description": "IP address, empty if device has none"
},
"mac": {
"type": "string",
"enum": [
"3D:01:CC"
],
"description": "MAC address, empty if device has none"
},
"id": {
"type": "string",
"enum": [
"998"
],
"description": "ID, empty if device has none"
},
"subaddress": {
"type": "string",
"enum": [
"``"
]
},
"driver": {
"type": "string",
"enum": [
"3m",
"aprilaire",
"bacnet",
"camera",
"controlbyweb",
"egauge",
"fieldserver",
"hue",
"insteon",
"modbus",
"nest",
"proliphix",
"veris",
"z3netmeter",
"zigbee",
"zwave"
],
"description": "product driver type"
},
"productCd": {
"type": "string",
"enum": [
"WetpVV1FCOB75vVHo6ik"
],
"description": "Producd CD of discovered device"
},
"bridgeCd": {
"type": "string",
"enum": [
"``"
],
"description": "Device CD of bridge for this device, if known"
},
"status": {
"type": "string",
"enum": [
"online"
],
"description": "Device status"
},
"name": {
"type": "string",
"enum": [
"BACnet Chiller"
],
"description": "Name of the product"
},
"make": {
"type": "string",
"enum": [
"Altair"
],
"description": "Make of the product"
},
"model": {
"type": "string",
"enum": [
"Generic BACnet Chiller"
],
"description": "Product model"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/images/products/WetpVV1FCOB75vVHo6ik.jpg"
],
"description": "Link to product image"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Chiller"
],
"description": "Name of product type"
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"isBridge": {
"type": "boolean",
"enum": [
false
],
"description": "Is this device a bridge?"
},
"needsBridge": {
"type": "boolean",
"enum": [
false
],
"description": "Does this device need a bridge?"
},
"bridgeRequirement": {
"type": "string",
"enum": [
"BR_BRIDGE_REQ_ASSIGNED",
"BR_BRIDGE_REQ_SOME_AVAIL"
],
"description": "Bridge requirement for the device"
},
"siblingProductCd": {
"type": "string",
"enum": [
"``"
],
"description": "Product CD of sibling device"
}
},
"required": [
"baseProtocol",
"identifier",
"driver",
"productCd",
"productTypes",
"isBridge",
"needsBridge",
"bridgeRequirement"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Discover BACnet Devices ¶
Discover BACnet DevicesGET/api/v3.1/sites/{siteCd}/actions/discoverBACnet
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/discoverBACnet
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"site": {
"siteCd": "cK4Uae73unb72TYuDJDr",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "Test Site"
},
"gateway": {
"deviceCd": "75vVHo6ikWetpVV1FCOB",
"name": "My CC150 Gateway"
},
"discovered": [
{
"discoveredDevice": {
"address": "10:38:0:35 0xBAC",
"bacnet-network": 2001,
"device-identifier": 482909,
"display-name": "WNC-3Y-208-BN, 0482909",
"max-info-frames": 1,
"max-master": 127,
"model-name": "WNC-3Y-208-BN",
"multiread": true,
"router": false,
"saddress": "``",
"software-version": "1.13",
"standard-version": "1.13",
"system-status": "operational",
"vendor-identifier": 500,
"vendor-name": "Continental Control Systems, LLC",
"objects": {
"482909:0:0": {
"description": "Energy, total net (kWh) non-resettable",
"object-identifier": 0,
"object-name": "EnergySumNR",
"object-type": "analog-input",
"units": "kilowatt-hours",
"value": 0
},
"482909:5:5": {
"description": "Display the LED wink pattern",
"object-identifier": 5,
"object-name": "Wink",
"object-type": "binary-input",
"units": "``",
"value": 0
}
}
},
"matches": [
{
"productCd": "u1lq0isN3tv70HIy6L4G",
"name": "BACnet AHU",
"manufacturerName": "Altair",
"model": "Generic BACnet AHU",
"make": "BACnet AHU",
"imageLink": "/Factory/images/products/u1lq0isN3tv70HIy6L4G.jpg",
"labels": [
{
"labelCd": "PQ7arhw9LznXsyVGUtmy",
"inputType": 1,
"inputIndex": "5",
"label": "Outside"
}
],
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "BACnet",
"protocols": [
{
"protocolCd": "I37YifZSqBC1NPSa7g3T",
"name": "BACnet IP - AHU",
"version": "1.0"
}
],
"accuracy": 95
}
]
}
]
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_DISCOVER_BACNET_PRODUCT",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"site": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this site is assigned to"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "The unique name of the Site"
}
},
"required": [
"siteCd",
"company",
"name"
],
"additionalProperties": false
},
"gateway": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"75vVHo6ikWetpVV1FCOB"
],
"description": "The unique CD for the D evice"
},
"name": {
"type": "string",
"enum": [
"My CC150 Gateway"
],
"description": "The unique name of the Device"
}
},
"required": [
"deviceCd",
"name"
],
"additionalProperties": false
},
"discovered": {
"type": "array",
"items": {
"type": "object",
"properties": {
"discoveredDevice": {
"type": "object",
"properties": {
"address": {
"type": "string",
"enum": [
"10:38:0:35 0xBAC"
]
},
"bacnet-network": {
"type": "number",
"enum": [
2001
]
},
"device-identifier": {
"type": "number",
"enum": [
482909
]
},
"display-name": {
"type": "string",
"enum": [
"WNC-3Y-208-BN, 0482909"
]
},
"max-info-frames": {
"type": "number",
"enum": [
1
]
},
"max-master": {
"type": "number",
"enum": [
127
]
},
"model-name": {
"type": "string",
"enum": [
"WNC-3Y-208-BN"
]
},
"multiread": {
"type": "boolean",
"enum": [
true
]
},
"router": {
"type": "boolean",
"enum": [
false
]
},
"saddress": {
"type": "string",
"enum": [
"``"
]
},
"software-version": {
"type": "string",
"enum": [
"1.13"
]
},
"standard-version": {
"type": "string",
"enum": [
"1.13"
]
},
"system-status": {
"type": "string",
"enum": [
"operational"
]
},
"vendor-identifier": {
"type": "number",
"enum": [
500
]
},
"vendor-name": {
"type": "string",
"enum": [
"Continental Control Systems, LLC"
]
},
"objects": {
"type": "object",
"properties": {
"482909:0:0": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Energy, total net (kWh) non-resettable"
]
},
"object-identifier": {
"type": "number",
"enum": [
0
]
},
"object-name": {
"type": "string",
"enum": [
"EnergySumNR"
]
},
"object-type": {
"type": "string",
"enum": [
"analog-input"
]
},
"units": {
"type": "string",
"enum": [
"kilowatt-hours"
]
},
"value": {
"type": "number",
"enum": [
0
]
}
},
"required": [
"description",
"object-identifier",
"object-name",
"object-type",
"units",
"value"
],
"additionalProperties": false
},
"482909:5:5": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Display the LED wink pattern"
]
},
"object-identifier": {
"type": "number",
"enum": [
5
]
},
"object-name": {
"type": "string",
"enum": [
"Wink"
]
},
"object-type": {
"type": "string",
"enum": [
"binary-input"
]
},
"units": {
"type": "string",
"enum": [
"``"
]
},
"value": {
"type": "number",
"enum": [
0
]
}
},
"required": [
"description",
"object-identifier",
"object-name",
"object-type",
"units",
"value"
],
"additionalProperties": false
}
},
"required": [
"482909:0:0",
"482909:5:5"
],
"additionalProperties": false
}
},
"required": [
"address",
"bacnet-network",
"device-identifier",
"display-name",
"max-info-frames",
"max-master",
"model-name",
"multiread",
"router",
"saddress",
"software-version",
"standard-version",
"system-status",
"vendor-identifier",
"vendor-name",
"objects"
],
"additionalProperties": false
},
"matches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"enum": [
"u1lq0isN3tv70HIy6L4G"
],
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"enum": [
"BACnet AHU"
],
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"enum": [
"Generic BACnet AHU"
],
"description": "Model name of the Product"
},
"make": {
"type": "string",
"enum": [
"BACnet AHU"
],
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/images/products/u1lq0isN3tv70HIy6L4G.jpg"
],
"description": "URI to image of the Product"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"labelCd": {
"type": "string",
"enum": [
"PQ7arhw9LznXsyVGUtmy"
],
"description": "The unique Label ID"
},
"inputType": {
"type": "number",
"enum": [
1
],
"description": "BACnet Input Type"
},
"inputIndex": {
"type": "string",
"enum": [
"5"
],
"description": "BACnet Input Index"
},
"label": {
"type": "string",
"enum": [
"Outside"
],
"description": "Label Text"
}
},
"required": [
"labelCd",
"inputType",
"inputIndex",
"label"
],
"additionalProperties": false
},
"description": "Array of Product Labels (BACnet)"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"enum": [
"BACnet"
],
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"I37YifZSqBC1NPSa7g3T"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"BACnet IP - AHU"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
},
"accuracy": {
"type": "number",
"enum": [
95
]
}
},
"required": [
"productCd",
"name",
"manufacturerName",
"model",
"make",
"imageLink",
"labels",
"productTypes",
"baseProtocol",
"protocols",
"accuracy"
],
"additionalProperties": false
}
}
},
"required": [
"discoveredDevice",
"matches"
],
"additionalProperties": false
}
}
},
"required": [
"site",
"gateway",
"discovered"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Discover Jace Devices ¶
Discover Jace DevicesPOST/api/v3.1/sites/{siteCd}/actions/discoverJace
When a device is created from a Jace included in the BACnet discovery report the related info for the Jace and the newly created device are stored in the database to create a so-called prediction template.
This endpoint uses these prediction templates with the latest BACnet discovery reports to suggest devices that can be created from Jaces in the report. The prediction template contains a number of data points. This endpoint attempts to match these datapoints agains discoverd Jace data points. The required accuracy for this can be specified in the request body (defaults to 75%).
This endpoint reports the average accuracy of all data point matches and a probability percentage which is the average accuracy multiplied by the percentage of data points matched. The product CD needed to create a new device is returned as well as the custom labels that need to be added to the device.
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/discoverJace
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
Request
Body
{
"requiredAccuracy": 75
}Schema
{
"type": "object",
"properties": {
"requiredAccuracy": {
"type": "number",
"description": "Required accuracy of the matching algorithm"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"bacnetDeviceInstance": 997,
"displayName": "Candi997Demo_997",
"vendorName": "Tridium",
"modelName": "NiagaraAX Station",
"dataPointsToMatch": 6,
"dataPointsMatched": 1,
"percentageMatched": 16.67,
"dataPoints": [
{
"DL_AIR_SUPPLY_TEMPERATURE_CELSIUS": [
{
"accuracy": 82.35,
"objectName": "Logic.VAV.Supply Air",
"objectType": 0,
"objectIdentifier": 21,
"units": "degrees-fahrenheit"
}
]
}
],
"averageAccuracy": 82.35,
"probability": 13.73,
"productCd": "fSqoi0iu0KYsVHe4PYRI",
"customLabels": [
{
"DL_AIR_SUPPLY_TEMPERATURE_CELSIUS": "R52WfS3k1ihtAZL42mC4"
}
]
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_PREDICTION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bacnetDeviceInstance": {
"type": "number",
"enum": [
997
],
"description": "The BACnet device ID"
},
"displayName": {
"type": "string",
"enum": [
"Candi997Demo_997"
],
"description": "The BACnet device display name"
},
"vendorName": {
"type": "string",
"enum": [
"Tridium"
],
"description": "The BACnet vendor name"
},
"modelName": {
"type": "string",
"enum": [
"NiagaraAX Station"
],
"description": "The BACnet model name"
},
"dataPointsToMatch": {
"type": "number",
"enum": [
6
],
"description": "Number of data points in the prediction template"
},
"dataPointsMatched": {
"type": "number",
"enum": [
1
],
"description": "Number of data points matched to the BACnet report"
},
"percentageMatched": {
"type": "number",
"enum": [
16.67
],
"description": "Percentage of data points matched"
},
"dataPoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"DL_AIR_SUPPLY_TEMPERATURE_CELSIUS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accuracy": {
"type": "number",
"enum": [
82.35
],
"description": "The percentage accuracy of the data point match"
},
"objectName": {
"type": "string",
"enum": [
"Logic.VAV.Supply Air"
],
"description": "The object name of the data point in the report"
},
"objectType": {
"type": "number",
"enum": [
0
],
"description": "The object type of the data point in the report"
},
"objectIdentifier": {
"type": "number",
"enum": [
21
],
"description": "The object identifier of the data point in the report"
},
"units": {
"type": "string",
"enum": [
"degrees-fahrenheit"
],
"description": "The units of the data point in the report"
}
},
"required": [
"accuracy",
"objectName",
"objectType",
"objectIdentifier",
"units"
],
"additionalProperties": false
}
}
},
"required": [
"DL_AIR_SUPPLY_TEMPERATURE_CELSIUS"
],
"additionalProperties": false
}
},
"averageAccuracy": {
"type": "number",
"enum": [
82.35
],
"description": "The average percentage accuracy of all the data point matches"
},
"probability": {
"type": "number",
"enum": [
13.73
],
"description": "The percentage of number of datapoint matches multiplied by the average percentage accuracy"
},
"productCd": {
"type": "string",
"enum": [
"fSqoi0iu0KYsVHe4PYRI"
],
"description": "The product CD of the product the prediction template device is based on"
},
"customLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"DL_AIR_SUPPLY_TEMPERATURE_CELSIUS": {
"type": "string",
"enum": [
"R52WfS3k1ihtAZL42mC4"
],
"description": "The data label with label CD to be added to the device created from the product"
}
},
"required": [
"DL_AIR_SUPPLY_TEMPERATURE_CELSIUS"
],
"additionalProperties": false
}
}
},
"required": [
"bacnetDeviceInstance",
"displayName",
"vendorName",
"modelName",
"dataPointsToMatch",
"dataPointsMatched",
"percentageMatched",
"dataPoints",
"averageAccuracy",
"probability",
"productCd",
"customLabels"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Device Changes ¶
See Device Changes
Get Device ChangesGET/api/v3.1/sites/{siteCd}/actions/getChanges
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/getChanges
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"onlineState": 0,
"onlineLast": 1490883714,
"status": "OK",
"udDtypeTime": 1490883713,
"udDtypeKwhOdm": 2062.898,
"udDtypeKwhAOdm": 1377.178,
"udDtypeKwhBOdm": 685.717,
"udDtypeKwhCOdm": 0.003,
"udDtypeKw": 0,
"udDtypeKwA": 0,
"udDtypeKwB": 0,
"udDtypeKvahAOdm": 1392.832,
"udDtypeKvahBOdm": 1705.935,
"udDtypeKvahCOdm": 0.003,
"udDtypeKvaA": 0,
"udDtypeKvaB": 0,
"udDtypeKvarhAOdm": 14.075,
"udDtypeKvarhBOdm": 7.561,
"udDtypeKvarhCOdm": 0,
"udDtypeKvarA": 0,
"udDtypeKvarB": 0,
"udDtypeVrmsA": 121.4,
"udDtypeVrmsB": 121.4,
"udDtypeIrmsA": 0,
"udDtypeIrmsB": 0,
"coolSetPoint": 28.33,
"fanMode": "On",
"heatSetPoint": 18.89,
"mode": "Cool",
"scale": "Degrees F",
"temperature": 24.61,
"changeTime": 1490883713
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DEVICE_CHANGES",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
},
"deviceChange": [
{
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"onlineState": 0,
"onlineLast": 1490883714,
"status": "OK",
"udDtypeTime": 1490883713,
"udDtypeKwhOdm": 2062.898,
"udDtypeKwhAOdm": 1377.178,
"udDtypeKwhBOdm": 685.717,
"udDtypeKwhCOdm": 0.003,
"udDtypeKw": 0,
"udDtypeKwA": 0,
"udDtypeKwB": 0,
"udDtypeKvahAOdm": 1392.832,
"udDtypeKvahBOdm": 1705.935,
"udDtypeKvahCOdm": 0.003,
"udDtypeKvaA": 0,
"udDtypeKvaB": 0,
"udDtypeKvarhAOdm": 14.075,
"udDtypeKvarhBOdm": 7.561,
"udDtypeKvarhCOdm": 0,
"udDtypeKvarA": 0,
"udDtypeKvarB": 0,
"udDtypeVrmsA": 121.4,
"udDtypeVrmsB": 121.4,
"udDtypeIrmsA": 0,
"udDtypeIrmsB": 0,
"coolSetPoint": 28.33,
"fanMode": "On",
"heatSetPoint": 18.89,
"mode": "Cool",
"scale": "Degrees F",
"temperature": 24.61,
"changeTime": 1490883713
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Bills desk"
],
"description": "Location of the Device as labeled by the User in the Cloud"
},
"onlineState": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5
],
"description": "Online status of the device"
},
"onlineLast": {
"type": "number",
"enum": [
1490883714
],
"description": "Timestamp of last time online"
},
"status": {
"type": "string",
"enum": [
"OK"
],
"description": "Status of the device"
},
"udDtypeTime": {
"type": "number",
"enum": [
1490883713
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhOdm": {
"type": "number",
"enum": [
2062.898
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhAOdm": {
"type": "number",
"enum": [
1377.178
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhBOdm": {
"type": "number",
"enum": [
685.717
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhCOdm": {
"type": "number",
"enum": [
0.003
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKw": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvahAOdm": {
"type": "number",
"enum": [
1392.832
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvahBOdm": {
"type": "number",
"enum": [
1705.935
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvahCOdm": {
"type": "number",
"enum": [
0.003
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvaA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvaB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarhAOdm": {
"type": "number",
"enum": [
14.075
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarhBOdm": {
"type": "number",
"enum": [
7.561
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarhCOdm": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeVrmsA": {
"type": "number",
"enum": [
121.4
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeVrmsB": {
"type": "number",
"enum": [
121.4
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeIrmsA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeIrmsB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"coolSetPoint": {
"type": "number",
"enum": [
28.33
],
"description": "Label will only be returned for appropriate device"
},
"fanMode": {
"type": "string",
"enum": [
"On"
],
"description": "Label will only be returned for appropriate device"
},
"heatSetPoint": {
"type": "number",
"enum": [
18.89
],
"description": "Label will only be returned for appropriate device"
},
"mode": {
"type": "string",
"enum": [
"Cool"
],
"description": "Label will only be returned for appropriate device"
},
"scale": {
"type": "string",
"enum": [
"Degrees F"
],
"description": "Label will only be returned for appropriate device"
},
"temperature": {
"type": "number",
"enum": [
24.61
],
"description": "Label will only be returned for appropriate device"
},
"changeTime": {
"type": "number",
"enum": [
1490883713
],
"description": "Label will only be returned for appropriate device"
}
},
"required": [
"deviceCd",
"name",
"location",
"onlineState",
"onlineLast"
],
"additionalProperties": false
},
"description": "Array of device changes"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
},
"deviceChange": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Bills desk"
],
"description": "Location of the Device as labeled by the User in the Cloud"
},
"onlineState": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5
],
"description": "Online status of the device"
},
"onlineLast": {
"type": "number",
"enum": [
1490883714
],
"description": "Timestamp of last time online"
},
"status": {
"type": "string",
"enum": [
"OK"
],
"description": "Status of the device"
},
"udDtypeTime": {
"type": "number",
"enum": [
1490883713
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhOdm": {
"type": "number",
"enum": [
2062.898
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhAOdm": {
"type": "number",
"enum": [
1377.178
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhBOdm": {
"type": "number",
"enum": [
685.717
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhCOdm": {
"type": "number",
"enum": [
0.003
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKw": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvahAOdm": {
"type": "number",
"enum": [
1392.832
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvahBOdm": {
"type": "number",
"enum": [
1705.935
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvahCOdm": {
"type": "number",
"enum": [
0.003
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvaA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvaB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarhAOdm": {
"type": "number",
"enum": [
14.075
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarhBOdm": {
"type": "number",
"enum": [
7.561
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarhCOdm": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeVrmsA": {
"type": "number",
"enum": [
121.4
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeVrmsB": {
"type": "number",
"enum": [
121.4
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeIrmsA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeIrmsB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"coolSetPoint": {
"type": "number",
"enum": [
28.33
],
"description": "Label will only be returned for appropriate device"
},
"fanMode": {
"type": "string",
"enum": [
"On"
],
"description": "Label will only be returned for appropriate device"
},
"heatSetPoint": {
"type": "number",
"enum": [
18.89
],
"description": "Label will only be returned for appropriate device"
},
"mode": {
"type": "string",
"enum": [
"Cool"
],
"description": "Label will only be returned for appropriate device"
},
"scale": {
"type": "string",
"enum": [
"Degrees F"
],
"description": "Label will only be returned for appropriate device"
},
"temperature": {
"type": "number",
"enum": [
24.61
],
"description": "Label will only be returned for appropriate device"
},
"changeTime": {
"type": "number",
"enum": [
1490883713
],
"description": "Label will only be returned for appropriate device"
}
},
"required": [
"deviceCd",
"name",
"location",
"onlineState",
"onlineLast"
],
"additionalProperties": false
},
"description": "Array of device changes"
}
},
"required": [
"data",
"deviceChange"
]
}Update Site ¶
Update SitePOST/api/v3.1/sites/{siteCd}/actions/update
- Types of Responses
- Response 200 - Update Site successfully queued
- Response 409 - Conflict - If the Update Site would validate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/update
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"status": "queued"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SYNC_SITE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The Update Site status"
}
},
"required": [
"status"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 907,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 409,
"messages": [
{
"id": "errorDeviceHasNoSocket",
"text": "Device does not have a socket.",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH"
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorDeviceHasNoSocket"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Device does not have a socket."
],
"description": "Default text describing the error"
},
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Get Status of Update SiteGET/api/v3.1/sites/{siteCd}/actions/update/status
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/update/status
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"needSync": true,
"syncCode": 0,
"syncTime": "Sat Mar 18 2:41pm"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SYNC_STATUS",
"httpStatus": 200,
"messages": [
{
"id": "messageSyncSuccessful",
"text": "All Gateways at Site updated successfully!"
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"needSync": {
"type": "boolean",
"description": "Is Update Site needed (when IoT Server is out of date)"
},
"syncCode": {
"type": "number",
"description": "Status code of last time Update Site was completed (0 = OK)"
},
"syncTime": {
"type": "string",
"description": "Time string of last time Update Site was completed"
}
},
"required": [
"needSync",
"syncCode",
"syncTime"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"messageSyncSuccessful"
],
"description": "ID of the message for last Update Site run"
},
"text": {
"type": "string",
"enum": [
"All Gateways at Site updated successfully!"
],
"description": "text of the message for last Update Site run"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
}
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Device Issues List ¶
For all devices on the site. See Device Issues
Device Issues ListGET/api/v3.1/sites/{siteCd}/actions/deviceIssues
Also valid: /api/v3.1/sites/{siteCd}/deviceIssues
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/deviceIssues
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
Response
200Headers
Content-Type: application/jsonDevice Status List ¶
For all devices on the site.
See also the “Online State” information section of the Miscellaneous Important Notes.
Device Status ListGET/api/v3.1/sites/{siteCd}/actions/deviceStatus{?limit,page,orderBy,direction,filter}
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/deviceStatus?limit=100&page=1&orderBy=name&direction=asc&filter=text
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: name Example: nameField to order results by
Choices:
namelocationproductmodelmanufacturertypeonlineState- direction
string(optional) Default: asc Example: ascSort direction for the results list
Choices:
ascdesc- filter
string(optional) Example: textFilters results by matching text in fields: Name, Location, Product Name, Product Model, Manufacturer Name, Product Type, Online State
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"onlineState": 0,
"onlineLast": 1490883714,
"status": "OK",
"udDtypeTime": 1490883713,
"udDtypeKwhOdm": 2062.898,
"udDtypeKwhAOdm": 1377.178,
"udDtypeKwhBOdm": 685.717,
"udDtypeKwhCOdm": 0.003,
"udDtypeKw": 0,
"udDtypeKwA": 0,
"udDtypeKwB": 0,
"udDtypeKvahAOdm": 1392.832,
"udDtypeKvahBOdm": 1705.935,
"udDtypeKvahCOdm": 0.003,
"udDtypeKvaA": 0,
"udDtypeKvaB": 0,
"udDtypeKvarhAOdm": 14.075,
"udDtypeKvarhBOdm": 7.561,
"udDtypeKvarhCOdm": 0,
"udDtypeKvarA": 0,
"udDtypeKvarB": 0,
"udDtypeVrmsA": 121.4,
"udDtypeVrmsB": 121.4,
"udDtypeIrmsA": 0,
"udDtypeIrmsB": 0,
"coolSetPoint": 28.33,
"fanMode": "On",
"heatSetPoint": 18.89,
"mode": "Cool",
"scale": "Degrees F",
"temperature": 24.61,
"changeTime": 1490883713
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DEVICE_STATUS",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Bills desk"
],
"description": "Location of the Device as labeled by the User in the Cloud"
},
"onlineState": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5
],
"description": "Online status of the device"
},
"onlineLast": {
"type": "number",
"enum": [
1490883714
],
"description": "Timestamp of last time online"
},
"status": {
"type": "string",
"enum": [
"OK"
],
"description": "Status of the device"
},
"udDtypeTime": {
"type": "number",
"enum": [
1490883713
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhOdm": {
"type": "number",
"enum": [
2062.898
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhAOdm": {
"type": "number",
"enum": [
1377.178
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhBOdm": {
"type": "number",
"enum": [
685.717
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwhCOdm": {
"type": "number",
"enum": [
0.003
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKw": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKwB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvahAOdm": {
"type": "number",
"enum": [
1392.832
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvahBOdm": {
"type": "number",
"enum": [
1705.935
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvahCOdm": {
"type": "number",
"enum": [
0.003
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvaA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvaB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarhAOdm": {
"type": "number",
"enum": [
14.075
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarhBOdm": {
"type": "number",
"enum": [
7.561
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarhCOdm": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeKvarB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeVrmsA": {
"type": "number",
"enum": [
121.4
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeVrmsB": {
"type": "number",
"enum": [
121.4
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeIrmsA": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"udDtypeIrmsB": {
"type": "number",
"enum": [
0
],
"description": "Label will only be returned for appropriate device"
},
"coolSetPoint": {
"type": "number",
"enum": [
28.33
],
"description": "Label will only be returned for appropriate device"
},
"fanMode": {
"type": "string",
"enum": [
"On"
],
"description": "Label will only be returned for appropriate device"
},
"heatSetPoint": {
"type": "number",
"enum": [
18.89
],
"description": "Label will only be returned for appropriate device"
},
"mode": {
"type": "string",
"enum": [
"Cool"
],
"description": "Label will only be returned for appropriate device"
},
"scale": {
"type": "string",
"enum": [
"Degrees F"
],
"description": "Label will only be returned for appropriate device"
},
"temperature": {
"type": "number",
"enum": [
24.61
],
"description": "Label will only be returned for appropriate device"
},
"changeTime": {
"type": "number",
"enum": [
1490883713
],
"description": "Label will only be returned for appropriate device"
}
},
"required": [
"deviceCd",
"name",
"location",
"onlineState",
"onlineLast"
],
"additionalProperties": false
},
"description": "Array of device status"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Device Online State List ¶
For all devices on the site.
See also the “Online State” information section of the Miscellaneous Important Notes.
Device Online State ListGET/api/v3.1/sites/{siteCd}/actions/deviceOnlineState{?limit,page,orderBy,direction,filter}
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/deviceOnlineState?limit=100&page=1&orderBy=name&direction=asc&filter=text
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: name Example: nameField to order results by
Choices:
namelocationproductmodelmanufacturertype- direction
string(optional) Default: asc Example: ascSort direction for the results list
Choices:
ascdesc- filter
string(optional) Example: textFilters results by matching text in fields: Name, Location, Product Name, Product Model, Manufacturer Name, Product Type
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"DL_ONLINE_STATE": 0,
"DL_STATUS": "OK"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_DEVICE_ONLINE_STATE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Bills desk"
],
"description": "Location of the Device as labeled by the User in the Cloud"
},
"DL_ONLINE_STATE": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5
],
"description": "Online status of the device"
},
"DL_STATUS": {
"type": "string",
"enum": [
"OK"
],
"description": "Status of the device"
}
},
"required": [
"deviceCd",
"name",
"location",
"DL_ONLINE_STATE"
],
"additionalProperties": false
},
"description": "Array of device online state"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Clone Site ¶
CloneGET/api/v3.1/sites/{siteCd}/actions/clone{?number,cloneUsers,cloneApplicationPartners}
- Types of Responses
- Response 200 - Clone successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/clone?number=1&cloneUsers=true&cloneApplicationPartners=true
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- number
number(optional) Default: 1 Example: 1Number of clones to create
- cloneUsers
string(optional) Default: true Example: truetrue/false, Clone the Site’s Associated Users Mapping
Choices:
truefalse- cloneApplicationPartners
string(optional) Default: true Example: truetrue/false, Clone the Site’s Application Partner Mapping and Default Application Partner
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"siteCd": "3unb72TYucK4Uae7DJDr",
"name": "Cloned Site Name"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_SITE_CLONE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"3unb72TYucK4Uae7DJDr"
],
"description": "CD of the Site"
},
"name": {
"type": "string",
"enum": [
"Cloned Site Name"
],
"description": "Name of the Site"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"description": "Array of cloned sites"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Available Usage Types ¶
Available Usage TypesGET/api/v3.1/sites/{siteCd}/actions/getAvailableUsageTypes
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/getAvailableUsageTypes
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"value": "UD_DTYPE_KWH",
"text": "Kilowatt Hour (kWh)"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_USAGE_TYPE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"enum": [
"UD_DTYPE_KWH"
],
"description": "Usage Type LCD"
},
"text": {
"type": "string",
"enum": [
"Kilowatt Hour (kWh)"
],
"description": "Description"
}
},
"required": [
"value",
"text"
],
"additionalProperties": false
},
"description": "Array of Usage Types"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Available Event Types ¶
Available Event TypesGET/api/v3.1/sites/{siteCd}/actions/getAvailableEventTypes{?includeGateway,includeStandardTypes,returnPerDevice}
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/getAvailableEventTypes?includeGateway=true&includeStandardTypes=true&returnPerDevice=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- includeGateway
boolean(optional) Example: trueInclude gateway in results? Default: true.
- includeStandardTypes
boolean(optional) Example: trueInclude standard types in results? Default: true.
- returnPerDevice
boolean(optional) Example: falseReturn results per device? Default: false.
Request
default query parametersResponse
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"value": "DL_ONLINE_STATE",
"text": "Online State"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_EVENT_TYPE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"enum": [
"DL_ONLINE_STATE"
],
"description": "Event Type LCD"
},
"text": {
"type": "string",
"enum": [
"Online State"
],
"description": "Description"
}
},
"required": [
"value",
"text"
],
"additionalProperties": false
},
"description": "Array of Event Types"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Request
return results per deviceResponse
200Headers
Content-Type: application/jsonBody
{
"data": {
"N1q4XNN0q3mrziYDHls8": [
{
"value": "DL_ONLINE_STATE",
"text": "Online State"
}
],
"xVnAjuURVY4R1pvortI0": [
{
"value": "DL_ONLINE_STATE",
"text": "Online State"
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_EVENT_TYPE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"N1q4XNN0q3mrziYDHls8": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"enum": [
"DL_ONLINE_STATE"
],
"description": "Event Type LCD"
},
"text": {
"type": "string",
"enum": [
"Online State"
],
"description": "Description"
}
},
"required": [
"value",
"text"
],
"additionalProperties": false
},
"description": "Array of Event Types"
},
"xVnAjuURVY4R1pvortI0": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"enum": [
"DL_ONLINE_STATE"
],
"description": "Event Type LCD"
},
"text": {
"type": "string",
"enum": [
"Online State"
],
"description": "Description"
}
},
"required": [
"value",
"text"
],
"additionalProperties": false
},
"description": "Array of Event Types"
}
},
"required": [
"N1q4XNN0q3mrziYDHls8",
"xVnAjuURVY4R1pvortI0"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Add Application Partner Mapping ¶
Add Application Partner MappingGET/api/v3.1/sites/{siteCd}/actions/addApplicationPartnerMapping{?applicationPartnerCds,deviceCds}
Add Application Partner to Device mapping for the specified Application Partner(s) and Device(s). If no Device(s) are specified then all Devices the user has access to for this Site will be mapped.
- Types of Responses
- Response 200 - Request successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/addApplicationPartnerMapping?applicationPartnerCds=JDrcK4Uae7nb72TYuD3u&deviceCds=nb72TYuD3uJDrcK4Uae7
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- applicationPartnerCds
string(required) Example: JDrcK4Uae7nb72TYuD3uComma separated list of Application Partner CDs
- deviceCds
string(optional) Example: nb72TYuD3uJDrcK4Uae7Comma separated list of Device CDs
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"applicationPartnerCd": "JDrcK4Uae7nb72TYuD3u",
"deviceCd": "nb72TYuD3uJDrcK4Uae7"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_APPLICATION_PARTNER_MAPPING_ADD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"applicationPartnerCd": {
"type": "string",
"enum": [
"JDrcK4Uae7nb72TYuD3u"
],
"description": "Application Partner CD"
},
"deviceCd": {
"type": "string",
"enum": [
"nb72TYuD3uJDrcK4Uae7"
],
"description": "Device CD"
}
},
"required": [
"applicationPartnerCd",
"deviceCd"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Remove Application Partner Mapping ¶
Remove Application Partner MappingGET/api/v3.1/sites/{siteCd}/actions/removeApplicationPartnerMapping{?applicationPartnerCds,deviceCds}
Remove Application Partner to Device mapping for the specified Application Partner(s) and Device(s). If no Device(s) are specified then all Devices the user has access to for this Site will be used.
- Types of Responses
- Response 200 - Request successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/actions/removeApplicationPartnerMapping?applicationPartnerCds=JDrcK4Uae7nb72TYuD3u&deviceCds=nb72TYuD3uJDrcK4Uae7
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- applicationPartnerCds
string(required) Example: JDrcK4Uae7nb72TYuD3uComma separated list of Application Partner CDs
- deviceCds
string(optional) Example: nb72TYuD3uJDrcK4Uae7Comma separated list of Device CDs
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"applicationPartnerCd": "JDrcK4Uae7nb72TYuD3u",
"deviceCd": "nb72TYuD3uJDrcK4Uae7"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_APPLICATION_PARTNER_MAPPING_REMOVE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"applicationPartnerCd": {
"type": "string",
"enum": [
"JDrcK4Uae7nb72TYuD3u"
],
"description": "Application Partner CD"
},
"deviceCd": {
"type": "string",
"enum": [
"nb72TYuD3uJDrcK4Uae7"
],
"description": "Device CD"
}
},
"required": [
"applicationPartnerCd",
"deviceCd"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Device ¶
Individual companies can add tag elements in the system (Sites, Devices, Users, Partners) with meta data that is specific to their needs. These are generic fields that will appear as regular properties on those objects. They are grouped under a property called customFields, if present on the object. See the Custom Fields section for help on defining these element.
Get Device List ¶
Device ListGET/api/v3.1/sites/{siteCd}/devices{?editParameters,limit,page,orderBy,direction,filter}
Get the Device list for this Site.
Note that devices of different types can have different properties returned as part of the device object. For example, meters will have “usageTypes” in the “settings” section.
There are a number of sections to categorize properties: “settings”, “network”, “status” and “audit”. Different products have different properties in these sections.
Inspect the editParameters for a device for details on the properties.
Notice the limit and page parameters for limiting and paging through a potentially large Device list.
When filtering on Online State the following values should be used: ‘unknown’, ‘online’, ‘offline’, ‘never online’,‘offline gateway’, ‘offline bridge’.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Devices for this Site
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices?editParameters=false&limit=100&page=1&orderBy=name&direction=asc&filter=text
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: name Example: nameField to order results by
Choices:
namelocationproductmodelmanufacturertypeonlineState- direction
string(optional) Default: asc Example: ascSort direction for the results list
Choices:
ascdesc- filter
string(optional) Example: textFilters results by matching text in fields: Name, Location, Product Name, Product Model, Manufacturer Name, Product Type, Online State
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"imageLink": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/ofcVbSsW0JRNvwy2QZOH/image1.jpg",
"product": {
"productCd": "r1LneacYS2P8en818LS7",
"name": "GE Jasco Appliance Switch Module 45603",
"manufacturerName": "General Electric",
"model": "45603",
"make": "GE Jasco",
"imageLink": "/Factory/images/products/r1LneacYS2P8en818LS7.jpg",
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "Z-Wave Switch",
"protocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
]
},
"devicePorts": [
{
"devicePortCd": "cdW4t2rtfwrttyuNkobLr7P",
"name": "Ethernet",
"productPortCd": "PORT-ETHERNET"
}
],
"actions": [
{
"name": "POWER_ON",
"description": "Turns the Power ON",
"controllable": true,
"requiresParam": true
}
],
"bridge": "Z-Stick S2-Z-Wave Radio Frequency",
"settings": {
"dataUsagePollSecs": "UD_INC_30SEC",
"usageTypes": [
"UD_DTYPE_KWH",
"UD_DTYPE_KWH_ODM"
],
"streamLabels": [
"DL_TEMPERATURE",
"DL_MODE"
],
"customProductTemplate": "OGh0rLJ1b0eiimYozJ7Z"
},
"network": {
"isNetworkLinkDevice": false,
"showNetworkLink": false
},
"status": {
"needsAttention": false,
"operationsStatus": "OPERATIONS_STATUS_ACTIVE"
},
"audit": {
"addedBy": "3j43hfhbk454d",
"addedByName": "My User",
"addedDate": "2018-03-15 08:35:48",
"modifiedBy": "3j43hfhbk454d",
"modifiedByName": "My User",
"modifiedDate": "2018-03-15 08:39:43"
},
"authorized": true,
"authorizationRequired": true,
"applicationPartners": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Application Partner Name"
}
],
"editParameters": {
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"location": {
"fieldName": "location",
"view": "write",
"type": "string",
"required": true,
"label": "Location",
"labelPlural": "Locations",
"help": "A User editable field that provides for a physical location of the Device."
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "string",
"required": true,
"label": "Image",
"labelPlural": "Images",
"help": "A picture of the Device or Site."
},
"settings": {
"usageTypes": {
"fieldName": "usageTypes",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "List of Usage Types"
},
"streamLabels": {
"fieldName": "streamLabels",
"view": "read",
"type": "anyOf",
"required": false,
"label": "Stream Label",
"labelPlural": "Stream Labels",
"help": "List of Stream Labels"
},
"customProductTemplate": {
"fieldName": "customProductTemplate",
"view": "read",
"type": "oneOf",
"required": false,
"label": "Custom Product Template",
"labelPlural": "Custom Product Templates",
"help": "List of Custom Product Templates"
}
},
"network": {
"isNetworkLinkDevice": {
"fieldName": "isNetworkLinkDevice",
"view": "read",
"type": "string",
"required": false,
"label": "Is Network Link Device",
"labelPlural": "Is Network Link Device",
"help": "Is this a Network Link Device?"
}
},
"status": {
"operationsStatus": {
"fieldName": "operationsStatus",
"view": "write",
"type": "string",
"required": false,
"label": "Operation Status",
"labelPlural": "Operation Statuses",
"help": "Operation Status is optional"
}
},
"audit": {
"addedBy": {
"fieldName": "addedBy",
"view": "read",
"type": "string",
"required": true,
"label": "Added By",
"labelPlural": "Added By",
"help": "CD of User that added the Device"
}
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_DEVICE",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Bills desk"
],
"description": "Location of the Device as labeled by the User in the Cloud"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/ofcVbSsW0JRNvwy2QZOH/image1.jpg"
],
"description": "URI to image of the Users uploaded image of the Device or Product"
},
"product": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"enum": [
"r1LneacYS2P8en818LS7"
],
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch Module 45603"
],
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"enum": [
"General Electric"
],
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"enum": [
"45603"
],
"description": "Model name of the Product"
},
"make": {
"type": "string",
"enum": [
"GE Jasco"
],
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/images/products/r1LneacYS2P8en818LS7.jpg"
],
"description": "URI to image of the Product"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"qa54NXq0DKgyywN1HpWy"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"name",
"manufacturerName",
"model",
"make",
"imageLink",
"productTypes",
"baseProtocol",
"protocols"
],
"additionalProperties": false,
"description": "Product information"
},
"devicePorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"devicePortCd": {
"type": "string",
"enum": [
"cdW4t2rtfwrttyuNkobLr7P"
],
"description": "Unique identifier for the Device Port"
},
"name": {
"type": "string",
"enum": [
"Ethernet"
],
"description": "The Name of the Device Port (set by Altair)"
},
"productPortCd": {
"type": "string",
"enum": [
"PORT-ETHERNET"
],
"description": "The Port Type (set by Altair)"
}
},
"required": [
"devicePortCd",
"name",
"productPortCd"
],
"additionalProperties": false
},
"description": "List of DevicePorts for this Device"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"POWER_ON"
]
},
"description": {
"type": "string",
"enum": [
"Turns the Power ON"
]
},
"controllable": {
"type": "boolean",
"enum": [
true
]
},
"requiresParam": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"name",
"description",
"controllable",
"requiresParam"
],
"additionalProperties": false
},
"description": "List of Actions"
},
"bridge": {
"type": "string",
"enum": [
"Z-Stick S2-Z-Wave Radio Frequency"
],
"description": "Description of the Bridge being used"
},
"settings": {
"type": "object",
"properties": {
"dataUsagePollSecs": {
"type": "string",
"enum": [
"UD_INC_30SEC",
"UD_INC_15MIN"
],
"description": "Poll interval for meter usage"
},
"usageTypes": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"UD_DTYPE_KWH"
]
},
{
"type": "string",
"enum": [
"UD_DTYPE_KWH_ODM"
]
}
],
"description": "Usage types for a meter"
},
"streamLabels": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"DL_TEMPERATURE"
]
},
{
"type": "string",
"enum": [
"DL_MODE"
]
}
],
"description": "Stream labels for a Device"
},
"customProductTemplate": {
"type": "string",
"enum": [
"OGh0rLJ1b0eiimYozJ7Z"
],
"description": "The CD of the custom product template that has been applied."
}
},
"required": [
"dataUsagePollSecs"
],
"additionalProperties": false,
"description": "Device settings information"
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "boolean",
"enum": [
false
],
"description": "Is this a network link device? (Bridge only.)"
},
"showNetworkLink": {
"type": "boolean",
"enum": [
false
],
"description": "Does the device support network link control? (Bridge only.)"
}
},
"additionalProperties": false,
"description": "Device network information (for bridges)"
},
"status": {
"type": "object",
"properties": {
"needsAttention": {
"type": "boolean",
"enum": [
false
],
"description": "Does the device require attention?"
},
"operationsStatus": {
"type": "string",
"enum": [
"OPERATIONS_STATUS_ACTIVE",
"OPERATIONS_STATUS_INACTIVE"
],
"description": "Device operations status"
}
},
"required": [
"needsAttention",
"operationsStatus"
],
"additionalProperties": false,
"description": "Device status information"
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "string",
"enum": [
"3j43hfhbk454d"
],
"description": "The CD of the User who added the Device"
},
"addedByName": {
"type": "string",
"enum": [
"My User"
],
"description": "The name of the User who added the Device"
},
"addedDate": {
"type": "string",
"enum": [
"2018-03-15 08:35:48"
],
"description": "Date the Device was added"
},
"modifiedBy": {
"type": "string",
"enum": [
"3j43hfhbk454d"
],
"description": "The CD of the User who modified the Device"
},
"modifiedByName": {
"type": "string",
"enum": [
"My User"
],
"description": "The name of the User who modified the Device"
},
"modifiedDate": {
"type": "string",
"enum": [
"2018-03-15 08:39:43"
],
"description": "Date the Device was modified"
}
},
"required": [
"addedBy",
"addedByName",
"addedDate"
],
"additionalProperties": false,
"description": "Device audit information"
},
"authorized": {
"type": "boolean",
"enum": [
true
],
"description": "Is the gateway authorized? Only returned for gateway"
},
"authorizationRequired": {
"type": "boolean",
"enum": [
true
],
"description": "Is gateway authorization required? Only returned for gateway"
},
"applicationPartners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
}
},
"required": [
"partnerCd",
"name"
],
"additionalProperties": false
},
"description": "List of ApplicationPartners"
},
"editParameters": {
"type": "object",
"properties": {
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"deviceCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Device CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Device CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Device."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name is required, and must be unique within a Site"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"location": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"location"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Location"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Locations"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"A User editable field that provides for a physical location of the Device."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"imageLink": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"imageLink"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Image"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Images"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"A picture of the Device or Site."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"settings": {
"type": "object",
"properties": {
"usageTypes": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"usageTypes"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Usage Type"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Usage Types"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of Usage Types"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"streamLabels": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"streamLabels"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Stream Label"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Stream Labels"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of Stream Labels"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"customProductTemplate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"customProductTemplate"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"anyOf",
"number",
"string",
"onePlusOf",
"object",
"array"
],
"default": [
"oneOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Custom Product Template"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Custom Product Templates"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of Custom Product Templates"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"usageTypes",
"streamLabels",
"customProductTemplate"
],
"additionalProperties": false
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"isNetworkLinkDevice"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"anyOf",
"number",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Is Network Link Device"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Is Network Link Device"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Is this a Network Link Device?"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"isNetworkLinkDevice"
],
"additionalProperties": false
},
"status": {
"type": "object",
"properties": {
"operationsStatus": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"operationsStatus"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Operation Status"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Operation Statuses"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Operation Status is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"operationsStatus"
],
"additionalProperties": false
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"addedBy"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"anyOf",
"number",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Added By"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Added By"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"CD of User that added the Device"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"addedBy"
],
"additionalProperties": false
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink",
"settings",
"network",
"status",
"audit"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink",
"product",
"devicePorts",
"actions",
"bridge",
"applicationPartners",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Bulk Update DevicesPUT/api/v3.1/sites/devices
Multiple devices can be updated in a single batch API call. The deviceCds need to be passed in as an array in the request body. A maximum of 500 devices is allowed in one go. Only “general” properties can be updated, such as device location or settings such as minTrim or vacancyTimeout. If a property is device specific then it can not be updated in this bulk call.
A device will only get updated if the device has the setting specified in the request body, otherwise it will fail silently.
- Types of Responses
- Response 200 - Update successful - body with deviceCd and name objects returned for the updated devices
- Response 409 - Conflict - If the update would validate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/devices
Request
Body
{
"deviceCds": [
"72TYucK4U3unbae7DJDr"
],
"settings": {
"minTrim": "5"
}
}Schema
{
"type": "object",
"properties": {
"deviceCds": {
"type": "array",
"items": {
"type": "string"
},
"description": "This is array of deviceCds for devices you want to update."
},
"settings": {
"type": "object",
"properties": {
"minTrim": {
"type": "string",
"description": "Example of a device setting to update"
}
}
}
},
"required": [
"deviceCds"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "72TYucK4U3unbae7DJDr",
"name": "Name of Updated Device"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_UPDATE_DEVICES",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"72TYucK4U3unbae7DJDr"
],
"description": "CD of the Device"
},
"name": {
"type": "string",
"enum": [
"Name of Updated Device"
],
"description": "Name of the Device"
}
},
"required": [
"deviceCd",
"name"
],
"additionalProperties": false
},
"description": "Array of updated devices"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Device ¶
Get DeviceGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}{?editParameters}
Note that devices of different types can have different properties returned as part of the device object. For example, meters will have “usageTypes” in the “settings” section.
There are a number of sections to categorize properties: “settings”, “network”, “status” and “audit”. Different products have different properties in these sections.
Inspect the editParameters for a device for details on the properties.
- Types of Responses
- Response 200 - Retrieval successful - body included with any extra changes
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDr- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"imageLink": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/ofcVbSsW0JRNvwy2QZOH/image1.jpg",
"product": {
"productCd": "r1LneacYS2P8en818LS7",
"name": "GE Jasco Appliance Switch Module 45603",
"manufacturerName": "General Electric",
"model": "45603",
"make": "GE Jasco",
"imageLink": "/Factory/images/products/r1LneacYS2P8en818LS7.jpg",
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "Z-Wave Switch",
"protocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
]
},
"devicePorts": [
{
"devicePortCd": "cdW4t2rtfwrttyuNkobLr7P",
"name": "Ethernet",
"productPortCd": "PORT-ETHERNET"
}
],
"actions": [
{
"name": "POWER_ON",
"description": "Turns the Power ON",
"controllable": true,
"requiresParam": true
}
],
"bridge": "Z-Stick S2-Z-Wave Radio Frequency",
"settings": {
"dataUsagePollSecs": "UD_INC_30SEC",
"usageTypes": [
"UD_DTYPE_KWH",
"UD_DTYPE_KWH_ODM"
],
"streamLabels": [
"DL_TEMPERATURE",
"DL_MODE"
],
"customProductTemplate": "OGh0rLJ1b0eiimYozJ7Z"
},
"network": {
"isNetworkLinkDevice": false,
"showNetworkLink": false
},
"status": {
"needsAttention": false,
"operationsStatus": "OPERATIONS_STATUS_ACTIVE"
},
"audit": {
"addedBy": "3j43hfhbk454d",
"addedByName": "My User",
"addedDate": "2018-03-15 08:35:48",
"modifiedBy": "3j43hfhbk454d",
"modifiedByName": "My User",
"modifiedDate": "2018-03-15 08:39:43"
},
"authorized": true,
"authorizationRequired": true,
"applicationPartners": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Application Partner Name"
}
],
"editParameters": {
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"location": {
"fieldName": "location",
"view": "write",
"type": "string",
"required": true,
"label": "Location",
"labelPlural": "Locations",
"help": "A User editable field that provides for a physical location of the Device."
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "string",
"required": true,
"label": "Image",
"labelPlural": "Images",
"help": "A picture of the Device or Site."
},
"settings": {
"usageTypes": {
"fieldName": "usageTypes",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "List of Usage Types"
},
"streamLabels": {
"fieldName": "streamLabels",
"view": "read",
"type": "anyOf",
"required": false,
"label": "Stream Label",
"labelPlural": "Stream Labels",
"help": "List of Stream Labels"
},
"customProductTemplate": {
"fieldName": "customProductTemplate",
"view": "read",
"type": "oneOf",
"required": false,
"label": "Custom Product Template",
"labelPlural": "Custom Product Templates",
"help": "List of Custom Product Templates"
}
},
"network": {
"isNetworkLinkDevice": {
"fieldName": "isNetworkLinkDevice",
"view": "read",
"type": "string",
"required": false,
"label": "Is Network Link Device",
"labelPlural": "Is Network Link Device",
"help": "Is this a Network Link Device?"
}
},
"status": {
"operationsStatus": {
"fieldName": "operationsStatus",
"view": "write",
"type": "string",
"required": false,
"label": "Operation Status",
"labelPlural": "Operation Statuses",
"help": "Operation Status is optional"
}
},
"audit": {
"addedBy": {
"fieldName": "addedBy",
"view": "read",
"type": "string",
"required": true,
"label": "Added By",
"labelPlural": "Added By",
"help": "CD of User that added the Device"
}
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "Unique Device code."
},
"name": {
"type": "string",
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"description": "Location of the Device as labeled by the User in the Cloud"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Users uploaded image of the Device or Product"
},
"product": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"description": "Model name of the Product"
},
"make": {
"type": "string",
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Product"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"qa54NXq0DKgyywN1HpWy"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"productTypes",
"baseProtocol",
"protocols"
],
"description": "Product information"
},
"devicePorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"devicePortCd": {
"type": "string",
"enum": [
"cdW4t2rtfwrttyuNkobLr7P"
],
"description": "Unique identifier for the Device Port"
},
"name": {
"type": "string",
"enum": [
"Ethernet"
],
"description": "The Name of the Device Port (set by Altair)"
},
"productPortCd": {
"type": "string",
"enum": [
"PORT-ETHERNET"
],
"description": "The Port Type (set by Altair)"
}
},
"required": [
"devicePortCd",
"name",
"productPortCd"
],
"additionalProperties": false
},
"description": "List of DevicePorts for this Device"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"POWER_ON"
]
},
"description": {
"type": "string",
"enum": [
"Turns the Power ON"
]
},
"controllable": {
"type": "boolean",
"enum": [
true
]
},
"requiresParam": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"name",
"description",
"controllable",
"requiresParam"
],
"additionalProperties": false
},
"description": "List of Actions"
},
"bridge": {
"type": "string",
"description": "Description of the Bridge being used"
},
"settings": {
"type": "object",
"properties": {
"dataUsagePollSecs": {
"type": "string",
"enum": [
"UD_INC_30SEC",
"UD_INC_15MIN"
],
"description": "Poll interval for meter usage"
},
"usageTypes": {
"type": "array",
"description": "Usage types for a meter"
},
"streamLabels": {
"type": "array",
"description": "Stream labels for a Device"
},
"customProductTemplate": {
"type": "string",
"description": "The CD of the custom product template that has been applied."
}
},
"required": [
"dataUsagePollSecs"
],
"description": "Device settings information"
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "boolean",
"description": "Is this a network link device? (Bridge only.)"
},
"showNetworkLink": {
"type": "boolean",
"description": "Does the device support network link control? (Bridge only.)"
}
},
"description": "Device network information (for bridges)"
},
"status": {
"type": "object",
"properties": {
"needsAttention": {
"type": "boolean",
"description": "Does the device require attention?"
},
"operationsStatus": {
"type": "string",
"enum": [
"OPERATIONS_STATUS_ACTIVE",
"OPERATIONS_STATUS_INACTIVE"
],
"description": "Device operations status"
}
},
"required": [
"needsAttention",
"operationsStatus"
],
"description": "Device status information"
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "string",
"description": "The CD of the User who added the Device"
},
"addedByName": {
"type": "string",
"description": "The name of the User who added the Device"
},
"addedDate": {
"type": "string",
"description": "Date the Device was added"
},
"modifiedBy": {
"type": "string",
"description": "The CD of the User who modified the Device"
},
"modifiedByName": {
"type": "string",
"description": "The name of the User who modified the Device"
},
"modifiedDate": {
"type": "string",
"description": "Date the Device was modified"
}
},
"required": [
"addedBy",
"addedByName",
"addedDate"
],
"description": "Device audit information"
},
"authorized": {
"type": "boolean",
"description": "Is the gateway authorized? Only returned for gateway"
},
"authorizationRequired": {
"type": "boolean",
"description": "Is gateway authorization required? Only returned for gateway"
},
"applicationPartners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
}
},
"required": [
"partnerCd",
"name"
],
"additionalProperties": false
},
"description": "List of ApplicationPartners"
},
"editParameters": {
"type": "object",
"properties": {
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"location": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"imageLink": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"settings": {
"type": "object",
"properties": {
"usageTypes": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"streamLabels": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"customProductTemplate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"anyOf",
"number",
"string",
"onePlusOf",
"object",
"array"
],
"default": [
"oneOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"usageTypes",
"streamLabels",
"customProductTemplate"
]
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"anyOf",
"number",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"isNetworkLinkDevice"
]
},
"status": {
"type": "object",
"properties": {
"operationsStatus": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"operationsStatus"
]
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"anyOf",
"number",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"addedBy"
]
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink",
"product",
"devicePorts",
"actions",
"bridge",
"applicationPartners"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Create a new DevicePOST/api/v3.1/sites/{siteCd}/devices/{?editParameters}
Process options for creating a new device
Note that devices of different types can have different properties returned as part of the device object. For example, meters will have “usageTypes” in the “settings” section. Inspect the editParameters for a device for details on the properties.
Option 1: Just send in a known ProductCd
-
Send in this POST with just the productCd identified (will fail if this is not supplied)
-
API will return a fully filled out device, with all fields created and ready for filling in
- Also, editParameters will be returned identifying any fields that still need to be filled in, including errors
- Note: this will create a Device in the system, but if any errors occur, an Update Site will not be allowed till they are fixed
-
User will fix any fields with errors as appropriate, and submit the PUT to Update
-
Any additional errors will be handled as usual
Option 2: Send in all required fields for a new device
-
Send in this POST with all required fields set (requires before-hand knowledge of all fields required for a Product)
-
API will validate all the fields and return either OK or errors
The bridgeCd is a combination of two 20 character long CDs concatenated with a hyphen. The two CDs are the port CD on the bridge (the port to which the device is connected) and the protocol CD used to connect.
-
Inbound data (Request)
- name:
Electric Whole House Meter(string, required) - Name of the device, as provided by the User - location:
Back yard fence(string, required) - The physical location of the Device, as provided by the User. - devicePorts (array[DevicePort], fixed)
- product
- productCd:
b3L38Hf6Xvi6h6MoTBX6(string, required) - The Product CD of this Device
- productCd:
- bridge
- bridgeCd:
s9Yev0f7shtLAnjv9u51-OGh0rLJ1b0eiimYozJ7Z(string, required) - Bridge CD this product is connected to
- bridgeCd:
- name:
-
Types of Responses
-
Response 200 - Update successful - body included with any extra changes
-
Response 409 - Conflict - If the update would invalidate a constraint, or type and id don’t match. Most errors will be in this category
- errorDeviceNameMustExist - Device Name must not be blank.
- errorDeviceNameMustBeUnique - Device Name must be unique within a Site.
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDr- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"name": "Electric Whole House Meter",
"location": "Back yard fence",
"product": {
"productCd": "b3L38Hf6Xvi6h6MoTBX6"
},
"bridge": {
"bridgeCd": "s9Yev0f7shtLAnjv9u51-OGh0rLJ1b0eiimYozJ7Z"
},
"usageTypes": [
"UD_DTYPE_KWH"
]
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the device, as provided by the User"
},
"location": {
"type": "string",
"description": "The physical location of the Device, as provided by the User."
},
"product": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"description": "The Product CD of this Device"
}
},
"required": [
"productCd"
]
},
"bridge": {
"type": "object",
"properties": {
"bridgeCd": {
"type": "string",
"description": "Bridge CD this product is connected to"
}
},
"required": [
"bridgeCd"
]
},
"usageTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Usage Types for a Meter, required for a Meter"
}
},
"required": [
"name",
"location"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "ofcVbSsW0JRNvwy2QZOH"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "Returns new deviceCd"
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Update a DevicePUT/api/v3.1/sites/{siteCd}/devices/{deviceCd}
Note that devices of different types can have different properties returned as part of the device object. For example, meters will have “usageTypes”. Inspect the editParameters for a device for details on the properties.
Only send in data that is changed
For example: if the name, location, and a Device Info of the device is changing, then the body would be:
Device came down as this …
...
"name": "blah old name",
...
"appOffset: "",
...
now you want to change the name, and appOffset, then you send in ...
{
"name": "new name",
"appOffset": "120, 200"
}
Custom Fields: verify previous data
When updating a custom field on a device you can verify that the current value you have for the field has not been updated in the database since the retrieval by sending in so-called “previousData”. The previous data should hold the data exactly as retrieved previously in an API call. It will be compared with the data in the database. If it is unchanged then the new value sent in for the custom field can be saved. If changed then an error message will be returned.
Example of data to send in:
{
"customFields": {
"myCustomField": "newValue"
},
"previousData": {
"customFields": {
"myCustomField": "existingValue"
}
}
}- Types of Responses
- Response 200 - Update successful
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDr- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
Request
Body
{
"name": "New Name"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This is the fieldName you are wanting to change, and the value you are changing it to."
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "ofcVbSsW0JRNvwy2QZOH"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "Returns new deviceCd"
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Delete a DeviceDELETE/api/v3.1/sites/{siteCd}/devices/{deviceCd}{?removeSiblingCds,forceDelete}
If a device to be deleted is part of a combo device then the sibling device CD needs to be given in the removeSiblingCds parameter. A bridge with attached devices can only be deleted if forceDelete is set to true.
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8?removeSiblingCds=CE1Tx8GVmN8E7o6JLNGA,mN8E7o6JLNGACE1Tx8GV&forceDelete=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDr- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- removeSiblingCds
string(optional) Example: CE1Tx8GVmN8E7o6JLNGA,mN8E7o6JLNGACE1Tx8GVComma separated Sibling Device CDs
- forceDelete
string(optional) Default: false Example: falsetrue/false, delete bridge even though it has attached devices
Choices:
truefalse
Response
204Headers
Content-Type: application/jsonSocket List ¶
Socket ListGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/sockets
Get the Socket list for the Device. We currently allow only one Socket per Device
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Sockets for this Device
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/sockets
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"socketCd": "GACE1Tx8GVE7o6JLNmN8",
"name": "My Socket",
"site": {
"siteCd": "cK4Uae73unb72TYuDJDr",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "My Site"
},
"device": {
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "My Meter",
"location": "My Location"
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_SOCKET",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"socketCd": {
"type": "string",
"enum": [
"GACE1Tx8GVE7o6JLNmN8"
],
"description": "The Socket CD"
},
"name": {
"type": "string",
"enum": [
"My Socket"
],
"description": "Name of the Socket"
},
"site": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The Site CD"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this site is assigned to"
},
"name": {
"type": "string",
"enum": [
"My Site"
],
"description": "Name of the Site"
}
},
"required": [
"siteCd",
"company",
"name"
],
"additionalProperties": false
},
"device": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "The Device CD"
},
"name": {
"type": "string",
"enum": [
"My Meter"
],
"description": "Name of the Device"
},
"location": {
"type": "string",
"enum": [
"My Location"
],
"description": "Location of the Device"
}
},
"required": [
"deviceCd",
"name",
"location"
],
"additionalProperties": false
}
},
"required": [
"socketCd",
"name",
"site",
"device"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Socket ¶
SocketGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/sockets/{socketCd}
Get the Socket for this Device
- Types of Responses
- Response 200 - Retrieval successful - body contains Socket for this Device
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/sockets/GACE1Tx8GVE7o6JLNmN8
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- socketCd
string(required) Example: GACE1Tx8GVE7o6JLNmN8The Socket CD
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"socketCd": "GACE1Tx8GVE7o6JLNmN8",
"name": "My Socket",
"site": {
"siteCd": "cK4Uae73unb72TYuDJDr",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "My Site"
},
"device": {
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "My Meter",
"location": "My Location"
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SOCKET",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"socketCd": {
"type": "string",
"description": "The Socket CD"
},
"name": {
"type": "string",
"description": "Name of the Socket"
},
"site": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"description": "The Site CD"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"description": "Company this site is assigned to"
},
"name": {
"type": "string",
"description": "Name of the Site"
}
},
"required": [
"siteCd",
"name"
]
},
"device": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "The Device CD"
},
"name": {
"type": "string",
"description": "Name of the Device"
},
"location": {
"type": "string",
"description": "Location of the Device"
}
},
"required": [
"deviceCd",
"name",
"location"
]
}
},
"required": [
"socketCd",
"name"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Create a SocketPOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/sockets/
Create a new Socket for a Device. This can only be done if the Device does not have any sockets available.
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/sockets/
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"socketCd": "GACE1Tx8GVE7o6JLNmN8",
"name": "My Socket",
"site": {
"siteCd": "cK4Uae73unb72TYuDJDr",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "My Site"
},
"device": {
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "My Meter",
"location": "My Location"
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SOCKET",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"socketCd": {
"type": "string",
"description": "The Socket CD"
},
"name": {
"type": "string",
"description": "Name of the Socket"
},
"site": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"description": "The Site CD"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"description": "Company this site is assigned to"
},
"name": {
"type": "string",
"description": "Name of the Site"
}
},
"required": [
"siteCd",
"name"
]
},
"device": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "The Device CD"
},
"name": {
"type": "string",
"description": "Name of the Device"
},
"location": {
"type": "string",
"description": "Location of the Device"
}
},
"required": [
"deviceCd",
"name",
"location"
]
}
},
"required": [
"socketCd",
"name"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Delete SocketDELETE/api/v3.1/sites/{siteCd}/devices/{deviceCd}/sockets/{socketCd}
Delete socket. This is only allowed if the socket is not assigned to any device.
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/sockets/GACE1Tx8GVE7o6JLNmN8
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- socketCd
string(required) Example: GACE1Tx8GVE7o6JLNmN8The Socket CD
Response
204Headers
Content-Type: application/jsonCustom Fields Hierarchy ¶
This endpoint returns sub levels and devices at each level. It takes two optional URL parameters: startAt and depth. The defaults are ‘top’ and ‘1’ respectively. This means the returned levels start at the top level and include one sub level.
The top level does not have devices linked. Any sub level can have devices. If there are any, they will be returned. By default the details returned for a device contain only essential properties. The full device object can be returned by setting the URI parameter ‘compact’ to ‘false’.
If a level at the lowest level retrieved (use of ‘depth’ parameter) has sub levels the property ‘levels’ for the level in question will return ‘true’ instead of the list of sub levels. One can go further down the hierarchy by changing the startAt and depth parameters.
A wildcard (*) can be used for the siteCd. If an actual siteCd is used then only devices for that site will be returned in the results.
Get Custom Fields Hierarchy (Start at Top)GET/api/v3.1/sites/{siteCd}/devices/customFields/{customFieldCd}{?depth,compact}
This shows the default return starting at the top level, with one sub level.
- Types of Responses
- Response 200 - If Hierarchy is retrieved
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/*/devices/customFields/a1psH6Z5g3968ESe449K?depth=1&compact=true
URI Parameters
- siteCd
string(required) Example: *- customFieldCd
string(required) Example: a1psH6Z5g3968ESe449K- depth
number(optional) Example: 1- compact
boolean(optional) Example: true
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": "top",
"name": "My Hierarchy",
"levels": [
{
"id": "mySubLevel1Cd",
"name": "My Hierarchy Sub Level 1",
"devices": [
{
"deviceCd": "bSsWofcV0JRNvwy2QZOH",
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "My Device 1",
"location": "Location 1"
},
{
"deviceCd": "0JR2QbSNvwysWofcVZOH",
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "My Device 2",
"location": "Location 2"
},
{
"deviceCd": "oNvwy2fcVbSsW0JRQZOH",
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "My Device 3",
"location": "Location 3"
}
]
},
{
"id": "mySubLevel2Cd",
"name": "My Hierarchy Sub Level 2",
"devices": [
{
"deviceCd": "SsWofcVb0JRNvwy2QZOH",
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "My Device 4",
"location": "Location 4"
},
{
"deviceCd": "0JRNvwy2ofcVbSsWQZOH",
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "My Device 5",
"location": "Location 5"
}
]
}
]
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_HIERARCHY",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"top"
],
"description": "CD of the level"
},
"name": {
"type": "string",
"enum": [
"My Hierarchy"
],
"description": "name of the level"
},
"levels": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"mySubLevel1Cd"
],
"description": "CD of the level"
},
"name": {
"type": "string",
"enum": [
"My Hierarchy Sub Level 1"
],
"description": "name of the level"
},
"devices": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"bSsWofcV0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"My Device 1"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Location 1"
],
"description": "Location of the Device as labeled by the User in the Cloud"
}
},
"required": [
"deviceCd",
"siteCd",
"name",
"location"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"0JR2QbSNvwysWofcVZOH"
],
"description": "Unique Device code."
},
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"My Device 2"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Location 2"
],
"description": "Location of the Device as labeled by the User in the Cloud"
}
},
"required": [
"deviceCd",
"siteCd",
"name",
"location"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"oNvwy2fcVbSsW0JRQZOH"
],
"description": "Unique Device code."
},
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"My Device 3"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Location 3"
],
"description": "Location of the Device as labeled by the User in the Cloud"
}
},
"required": [
"deviceCd",
"siteCd",
"name",
"location"
],
"additionalProperties": false
}
]
}
},
"required": [
"id",
"name",
"devices"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"mySubLevel2Cd"
],
"description": "CD of the level"
},
"name": {
"type": "string",
"enum": [
"My Hierarchy Sub Level 2"
],
"description": "name of the level"
},
"devices": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"SsWofcVb0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"My Device 4"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Location 4"
],
"description": "Location of the Device as labeled by the User in the Cloud"
}
},
"required": [
"deviceCd",
"siteCd",
"name",
"location"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"0JRNvwy2ofcVbSsWQZOH"
],
"description": "Unique Device code."
},
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"My Device 5"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Location 5"
],
"description": "Location of the Device as labeled by the User in the Cloud"
}
},
"required": [
"deviceCd",
"siteCd",
"name",
"location"
],
"additionalProperties": false
}
]
}
},
"required": [
"id",
"name",
"devices"
],
"additionalProperties": false
}
],
"description": "Sublevels, if any"
}
},
"required": [
"id",
"name",
"levels"
],
"additionalProperties": false
},
"description": "Array of hierarchy items"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Get Custom Fields Hierarchy (Start at Sub)GET/api/v3.1/sites/{siteCd}/devices/customFields/{customFieldCd}{?startAt,depth,compact}
This shows the return starting at sub level 2 and includes one sub level.
- Types of Responses
- Response 200 - If Hierarchy is retrieved
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/*/devices/customFields/a1psH6Z5g3968ESe449K?startAt=mySubLevel2Cd&depth=1&compact=true
URI Parameters
- siteCd
string(required) Example: *- customFieldCd
string(required) Example: a1psH6Z5g3968ESe449K- startAt
string(optional) Example: mySubLevel2Cd- depth
number(optional) Example: 1- compact
boolean(optional) Example: true
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": "mySubLevel2Cd",
"name": "My Hierarchy Sub Level 2",
"devices": [
{
"deviceCd": "SsWofcVb0JRNvwy2QZOH",
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "My Device 4",
"location": "Location 4"
},
{
"deviceCd": "0JRNvwy2ofcVbSsWQZOH",
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "My Device 5",
"location": "Location 5"
}
],
"levels": [
{
"id": "mySubLevel2SubLevel2Cd",
"name": "My Hierarchy Sub Level 2 Sub Level 1",
"devices": [
{
"deviceCd": "3f5Nv2ofcVwybSsWQZOH",
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "My Device 6",
"location": "Location 6"
}
]
}
]
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_HIERARCHY",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"mySubLevel2Cd"
],
"description": "CD of the level"
},
"name": {
"type": "string",
"enum": [
"My Hierarchy Sub Level 2"
],
"description": "name of the level"
},
"devices": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"SsWofcVb0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"My Device 4"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Location 4"
],
"description": "Location of the Device as labeled by the User in the Cloud"
}
},
"required": [
"deviceCd",
"siteCd",
"name",
"location"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"0JRNvwy2ofcVbSsWQZOH"
],
"description": "Unique Device code."
},
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"My Device 5"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Location 5"
],
"description": "Location of the Device as labeled by the User in the Cloud"
}
},
"required": [
"deviceCd",
"siteCd",
"name",
"location"
],
"additionalProperties": false
}
]
},
"levels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"mySubLevel2SubLevel2Cd"
],
"description": "CD of the level"
},
"name": {
"type": "string",
"enum": [
"My Hierarchy Sub Level 2 Sub Level 1"
],
"description": "name of the level"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"3f5Nv2ofcVwybSsWQZOH"
],
"description": "Unique Device code."
},
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
],
"description": "The unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"My Device 6"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Location 6"
],
"description": "Location of the Device as labeled by the User in the Cloud"
}
},
"required": [
"deviceCd",
"siteCd",
"name",
"location"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"devices"
],
"additionalProperties": false
},
"description": "Sublevels, if any"
}
},
"required": [
"id",
"name",
"devices",
"levels"
],
"additionalProperties": false
},
"description": "Array of hierarchy items"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Ultimate Example ¶
Get DeviceGET/api/v3.1/sites/SVEN_CC150_A/devices/GbuLO22mQ26s3UijQO64?editParameters=true
Use Cases using the following Device as example:
- Display information
- Each field will have a corresponding field in editParameters (EP).
- Each EP block will contain a “label” and “labelPlural” as appropriate for use
- Much EP blocks information comes from en.json, English only supported today
- EP have a “required” field, which makes it a requirement before updating/creating. But intermittent updates can be performed, even though the API returns an error because all required fields were not included, the fields sent in (if possible) are saved.
- Some EP have an “options” array. These are the options that are available for this field.
- There is also a “help” field, which may(not) be used. Right now, most of them are blank.
- Each field will have a corresponding field in editParameters (EP).
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/SVEN_CC150_A/devices/GbuLO22mQ26s3UijQO64?editParameters=true
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"$ref": "definitions.json#/device",
"deviceCd": "GbuLO22mQ26s3UijQO64",
"name": "GE Jasco Appliance Switc",
"location": "library",
"imageLink": "/Factory/images/products/TUUgArq22O3HAnVPi8TQ.jpg",
"product": {
"productCd": "TUUgArq22O3HAnVPi8TQ",
"name": "Plug-In Switch Module 45603",
"make": "GE Jasco",
"model": "45603",
"imageLink": "/Factory/images/products/TUUgArq22O3HAnVPi8TQ.jpg",
"productTypes": [
{
"productTypeCd": "jzJtl9Z8qKb5DT1yHw1v",
"productCategoryCd": "ZSOqdczWF2OLW2KLqNQw",
"name": "Switches - Lights"
},
{
"productTypeCd": "O05gOEUoi5xsnXtr9o4a",
"productCategoryCd": "ZSOqdczWF2OLW2KLqNQw",
"name": "Switches - Power"
}
],
"productProtocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
],
"baseProtocol": "ZWave"
},
"devicePorts": [
{
"devicePortCd": "dU80O3aJFKZ5o6rtgujQ",
"name": "Z-Wave Radio Frequency",
"productPortCd": "PORT-RF_ZWAVE",
"zwaveNodeAddress": "6"
}
],
"actions": [
{
"$ref": "#/definitions/action",
"action": "POWER_ON",
"description": "Power On",
"controllable": true,
"requiresParam": false
},
{
"$ref": "#/definitions/action",
"action": "POWER_OFF",
"description": "Power Off",
"controllable": true,
"requiresParam": false
},
{
"$ref": "#/definitions/action",
"action": "GET_STATUS",
"description": "Get Status",
"controllable": false,
"requiresParam": false
}
],
"bridge": {
"bridgeCd": "s9Yev0f7shtLAnjv9u51-OGh0rLJ1b0eiimYozJ7Z",
"bridgeName": "Z-Stick S2-Z-Wave Radio Frequency-Z-Wave Switch"
},
"editParameters": {
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CD",
"help": " for device CD"
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Name",
"help": ""
},
"location": {
"fieldName": "location",
"view": "write",
"type": "string",
"required": true,
"label": "Location",
"labelPlural": "Location",
"help": ""
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "image",
"required": false,
"label": "Image",
"labelPlural": "Images",
"help": ""
},
"product": {
"fieldName": "product",
"view": "read",
"type": "object",
"required": false,
"label": "Product",
"labelPlural": "Products",
"help": "",
"object": {
"productCd": {
"fieldName": "productCd",
"view": "read",
"type": "string",
"required": true,
"label": "Product CD",
"labelPlural": "Product CD",
"help": ""
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Name",
"help": ""
},
"model": {
"fieldName": "model",
"view": "read",
"type": "string",
"required": true,
"label": "Model",
"labelPlural": "Model",
"help": ""
},
"description": {
"fieldName": "description",
"view": "read",
"type": "string",
"required": false,
"label": "Description",
"labelPlural": "Description",
"help": ""
},
"image": {
"fieldName": "image",
"view": "read",
"type": "string",
"required": false,
"label": "Image",
"labelPlural": "Image",
"help": ""
},
"make": {
"fieldName": "make",
"view": "read",
"type": "string",
"required": false,
"label": "Make",
"labelPlural": "Make",
"help": ""
},
"protocols": {
"fieldName": "protocols",
"view": "read",
"type": "array",
"required": false,
"label": "Protocol",
"labelPlural": "Protocols",
"help": "",
"list": [
{
"fieldName": "Protocol",
"view": "read",
"type": "object",
"required": false,
"label": "Protocol",
"labelPlural": "Protocols",
"help": "",
"object": {
"protocoLcd": {
"fieldName": "protocoLcd",
"view": "read",
"type": "string",
"required": false,
"label": "Protocol LCD",
"labelPlural": "Protocol LCD",
"help": ""
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": ""
},
"version": {
"fieldName": "version",
"view": "read",
"type": "string",
"required": true,
"label": "Version",
"labelPlural": "Versions",
"help": ""
}
}
}
]
},
"productTypes": {
"fieldName": "productTypes",
"view": "read",
"type": "array",
"required": false,
"label": "Product Type",
"labelPlural": "Product Types",
"help": "",
"list": [
{
"fieldName": "Product Type",
"view": "read",
"type": "object",
"required": false,
"label": "Product Type",
"labelPlural": "Product Types",
"help": "",
"object": {
"productTypeCd": {
"fieldName": "productTypeCd",
"view": "read",
"type": "string",
"required": false,
"label": "Product Type CD",
"labelPlural": "Product Type CDs",
"help": ""
},
"productCategoryCd": {
"fieldName": "productCategoryCd",
"view": "read",
"type": "string",
"required": true,
"label": "Product Category CD",
"labelPlural": "Product Category CDs",
"help": ""
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": ""
},
"description": {
"fieldName": "description",
"view": "read",
"type": "string",
"required": false,
"label": "Description",
"labelPlural": "Descriptions",
"help": ""
},
"sortOrder": {
"fieldName": "sortOrder",
"view": "read",
"type": "string",
"required": false,
"label": "Sort Order",
"labelPlural": "Sort Orders",
"help": ""
}
}
},
{
"fieldName": "Product Type",
"view": "read",
"type": "object",
"required": false,
"label": "Product Type",
"labelPlural": "Product Types",
"help": "",
"object": {
"productTypeCd": {
"fieldName": "productTypeCd",
"view": "read",
"type": "string",
"required": false,
"label": "Product Type CD",
"labelPlural": "Product Type CDs",
"help": ""
},
"productCategoryCd": {
"fieldName": "productCategoryCd",
"view": "read",
"type": "string",
"required": true,
"label": "Product Category CD",
"labelPlural": "Product Category CDs",
"help": ""
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": ""
},
"description": {
"fieldName": "description",
"view": "read",
"type": "string",
"required": false,
"label": "Description",
"labelPlural": "Descriptions",
"help": ""
},
"sortOrder": {
"fieldName": "sortOrder",
"view": "read",
"type": "string",
"required": false,
"label": "Sort Order",
"labelPlural": "Sort Orders",
"help": ""
}
}
}
]
}
}
},
"devicePorts": {
"fieldName": "devicePorts",
"view": "read",
"type": "array",
"required": true,
"label": "Device Port",
"labelPlural": "Device Ports",
"help": "",
"list": [
{
"fieldName": "devicePortCd",
"view": "read",
"type": "object",
"required": true,
"label": "Device Port",
"labelPlural": "Device Ports",
"help": "",
"devicePortCd": "dU80O3aJFKZ5o6rtgujQ",
"object": {
"devicePortCd": {
"fieldName": "devicePortCd",
"view": "read",
"type": "string",
"required": false,
"label": "Device Port CD",
"labelPlural": "Device Port CD",
"help": ""
},
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CD",
"help": ""
},
"productPortCd": {
"fieldName": "productPortCd",
"view": "read",
"type": "string",
"required": true,
"label": "Product Port CD",
"labelPlural": "Product Port CD",
"help": ""
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Name",
"help": ""
},
"zwaveNodeAddress": {
"fieldName": "zwaveNodeAddress",
"view": "write",
"type": "string",
"required": true,
"label": "Z-Wave Address",
"labelPlural": "Z-Wave Address",
"help": ""
}
}
}
]
},
"bridge": {
"fieldName": "bridge",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Bridge",
"labelPlural": "Bridges",
"help": "",
"options": [
{
"text": "Z-Stick S2-Z-Wave Radio Frequency-Z-Wave Switch",
"value": "Lte4ZB00VsYfgZIXLjBa-qa54NXq0DKgyywN1HpWy"
}
]
},
"actions": {
"fieldName": "actions",
"view": "read",
"type": "array",
"required": false,
"label": "Action",
"labelPlural": "Actions",
"help": "",
"object": {
"action": {
"fieldName": "action",
"view": "read",
"type": "string",
"required": true,
"label": "Action",
"labelPlural": "Action",
"help": ""
},
"description": {
"fieldName": "description",
"view": "read",
"type": "string",
"required": true,
"label": "Description",
"labelPlural": "Description",
"help": ""
},
"controllable": {
"fieldName": "controllable",
"view": "read",
"type": "boolean",
"required": true,
"label": "Controllable",
"labelPlural": "Controllable",
"help": ""
},
"requiresParam": {
"fieldName": "requiresParam",
"view": "read",
"type": "boolean",
"required": true,
"label": "Requires Parameter",
"labelPlural": "Requires Parameter",
"help": ""
}
}
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-09-05T18:05:39-07:00",
"elapsed": 285,
"server": "altairsmartedge.com",
"api": {
"version": "3",
"endpoint": "/api/v3.1/sites/SVEN_CC150_A/devices/GbuLO22mQ26s3UijQO64?editParameters=true"
}
}
}Update DevicePUT/api/v3.1/sites/SVEN_CC150_A/devices/GbuLO22mQ26s3UijQO64?editParameters=true
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/SVEN_CC150_A/devices/GbuLO22mQ26s3UijQO64?editParameters=true
Request
Body
{
"name": "New Chiller Name",
"location": "new Location Name"
}Response
204Headers
Content-Type: application/jsonDevice Actions ¶
Action Commands
Get Action List ¶
Get Action ListGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions
Get a list of Actions for a Device.
See also: Global Failures
-
Values in Response
- name:
POWER_ON(required, string) - Action code to use for a SET command - description:
Turns the Power ON(required, string) - Description of the Action - controllable:
true- (boolean, required) - Is this Device controllable in some way (Light switch vs gateway is not controllable) - requiresParam:
true- (boolean, required) - Does this Action required a parameter (e.g. DIM requires the dim level number) - parameters (array, optional) - NOT SUPPORTED YET - A list or description of parameters that are acceptable
- name:
-
Types of Responses
-
Response 200 - Returns list of actions for a particular Device
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"name": "POWER_ON",
"description": "Turns the Power ON",
"controllable": true,
"requiresParam": true
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_ACTION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"POWER_ON"
]
},
"description": {
"type": "string",
"enum": [
"Turns the Power ON"
]
},
"controllable": {
"type": "boolean",
"enum": [
true
]
},
"requiresParam": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"name",
"description",
"controllable",
"requiresParam"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Individual Actions ¶
Set ActionGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/{action}
Submit a specific Action to the Device. (same as POST)
Note: A GET (set) of an Action does not return the new setting of a Device. All changes to the Device will be delivered via a GET_STATUS action call, or in deviceChanges. See Device Changes.
- Types of Responses
- Response 200 - Returns the information about the success or failure of the delivery of the Action
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/POWER_DIM
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- action
string(required) Example: POWER_DIMThe Action mnemonic
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "E7o6JLNGACE1Tx8GVmN8",
"onlineState": 1,
"onlineLast": 122303982
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_ACTION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "The Device CD that was actioned"
},
"onlineState": {
"type": "number",
"description": "Online State, (0 = offline, 1 = online)"
},
"onlineLast": {
"type": "number",
"description": "time the device was online last, if known. Else -1."
}
},
"required": [
"deviceCd",
"onlineState",
"onlineLast"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Set ActionPOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/{action}
Submit a specific Action to the Device. (same as GET)
- Types of Responses
- Response 200 - Returns the information about the success or failure of the delivery of the Action
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/GET_STATUS
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- action
string(required) Example: GET_STATUSThe Action mnemonic
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "E7o6JLNGACE1Tx8GVmN8",
"onlineState": 1,
"onlineLast": 122303982
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_ACTION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "The Device CD that was actioned"
},
"onlineState": {
"type": "number",
"description": "Online State, (0 = offline, 1 = online)"
},
"onlineLast": {
"type": "number",
"description": "time the device was online last, if known. Else -1."
}
},
"required": [
"deviceCd",
"onlineState",
"onlineLast"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Batch Actions ¶
Batch ActionPOST/api/v3.1/sites/{siteCd}/devices/*/actions/{action}{?deviceCd}
Batch submit a specific Action to Devices of the same Product. This only works for end devices.
- Types of Responses
- Response 200 - Returns the information about the success or failure of the delivery of the Action
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/*/actions/GET_STATUS?deviceCd=E7o6JLNGACE1Tx8GVmN8
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- action
string(required) Example: GET_STATUSThe Action mnemonic
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8Comma separated list of Device CDs
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "E7o6JLNGACE1Tx8GVmN8",
"onlineState": 1,
"onlineLast": 122303982
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_ACTION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"E7o6JLNGACE1Tx8GVmN8"
],
"description": "The Device CD that was actioned"
},
"onlineState": {
"type": "number",
"enum": [
1
],
"description": "Online State, (0 = offline, 1 = online)"
},
"onlineLast": {
"type": "number",
"enum": [
122303982
],
"description": "time the device was online last, if known. Else -1."
}
},
"required": [
"deviceCd",
"onlineState",
"onlineLast"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Get Attached Devices ¶
Get Attached DevicesGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/getAttachedDevices{?limit,page,filter}
See also: Global Failures
- Types of Responses
- Response 200 - Returns the list of attached devices (only bridges can have attached devices)
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/getAttachedDevices?limit=100&page=1&filter=text
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- filter
string(optional) Example: textFilters results by matching text in fields: Name, Location
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "E7o6JLNGACE1Tx8GVmN8",
"productCd": "JLNGACE1Tx8GE7o6VmN8",
"zigBeeMAC": "``",
"name": "My Attached Device",
"location": "Device Location"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_ATTACHED_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"E7o6JLNGACE1Tx8GVmN8"
],
"description": "The unique CD of the Device"
},
"productCd": {
"type": "string",
"enum": [
"JLNGACE1Tx8GE7o6VmN8"
],
"description": "The unique CD of the Product"
},
"zigBeeMAC": {
"type": "string",
"enum": [
"``"
],
"description": "ZigBee MAC address of the device (if ZigBee)"
},
"name": {
"type": "string",
"enum": [
"My Attached Device"
],
"description": "Name of the Device"
},
"location": {
"type": "string",
"enum": [
"Device Location"
],
"description": "Location of the Device"
}
},
"required": [
"deviceCd",
"productCd",
"name"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Add Custom Labels ¶
Add Custom LabelsPOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/addCustomLabels
Adds custom labels available from custom fields (see Custom Label Type request at Create a new Custom Field). Sending in an incorrect options (or blank) will return the list of available options.
See also: Global Failures
- Types of Responses
- Response 200 - Returns the device details
- Response 409 - Conflict - If the update would validate a constraint
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/addCustomLabels
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the BACnet device
Request
Body
{
"customLabels": [
"x8GE7o6VmJLNGACE1TN8"
]
}Schema
{
"type": "object",
"properties": {
"customLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of CDs of the Custom Labels"
}
},
"required": [
"customLabels"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"imageLink": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/ofcVbSsW0JRNvwy2QZOH/image1.jpg",
"product": {
"productCd": "r1LneacYS2P8en818LS7",
"name": "GE Jasco Appliance Switch Module 45603",
"manufacturerName": "General Electric",
"model": "45603",
"make": "GE Jasco",
"imageLink": "/Factory/images/products/r1LneacYS2P8en818LS7.jpg",
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "Z-Wave Switch",
"protocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
]
},
"devicePorts": [
{
"devicePortCd": "cdW4t2rtfwrttyuNkobLr7P",
"name": "Ethernet",
"productPortCd": "PORT-ETHERNET"
}
],
"actions": [
{
"name": "POWER_ON",
"description": "Turns the Power ON",
"controllable": true,
"requiresParam": true
}
],
"bridge": "Z-Stick S2-Z-Wave Radio Frequency",
"settings": {
"dataUsagePollSecs": "UD_INC_30SEC",
"usageTypes": [
"UD_DTYPE_KWH",
"UD_DTYPE_KWH_ODM"
],
"streamLabels": [
"DL_TEMPERATURE",
"DL_MODE"
],
"customProductTemplate": "OGh0rLJ1b0eiimYozJ7Z"
},
"network": {
"isNetworkLinkDevice": false,
"showNetworkLink": false
},
"status": {
"needsAttention": false,
"operationsStatus": "OPERATIONS_STATUS_ACTIVE"
},
"audit": {
"addedBy": "3j43hfhbk454d",
"addedByName": "My User",
"addedDate": "2018-03-15 08:35:48",
"modifiedBy": "3j43hfhbk454d",
"modifiedByName": "My User",
"modifiedDate": "2018-03-15 08:39:43"
},
"authorized": true,
"authorizationRequired": true,
"applicationPartners": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Application Partner Name"
}
],
"editParameters": {
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"location": {
"fieldName": "location",
"view": "write",
"type": "string",
"required": true,
"label": "Location",
"labelPlural": "Locations",
"help": "A User editable field that provides for a physical location of the Device."
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "string",
"required": true,
"label": "Image",
"labelPlural": "Images",
"help": "A picture of the Device or Site."
},
"settings": {
"usageTypes": {
"fieldName": "usageTypes",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "List of Usage Types"
},
"streamLabels": {
"fieldName": "streamLabels",
"view": "read",
"type": "anyOf",
"required": false,
"label": "Stream Label",
"labelPlural": "Stream Labels",
"help": "List of Stream Labels"
},
"customProductTemplate": {
"fieldName": "customProductTemplate",
"view": "read",
"type": "oneOf",
"required": false,
"label": "Custom Product Template",
"labelPlural": "Custom Product Templates",
"help": "List of Custom Product Templates"
}
},
"network": {
"isNetworkLinkDevice": {
"fieldName": "isNetworkLinkDevice",
"view": "read",
"type": "string",
"required": false,
"label": "Is Network Link Device",
"labelPlural": "Is Network Link Device",
"help": "Is this a Network Link Device?"
}
},
"status": {
"operationsStatus": {
"fieldName": "operationsStatus",
"view": "write",
"type": "string",
"required": false,
"label": "Operation Status",
"labelPlural": "Operation Statuses",
"help": "Operation Status is optional"
}
},
"audit": {
"addedBy": {
"fieldName": "addedBy",
"view": "read",
"type": "string",
"required": true,
"label": "Added By",
"labelPlural": "Added By",
"help": "CD of User that added the Device"
}
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "Unique Device code."
},
"name": {
"type": "string",
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"description": "Location of the Device as labeled by the User in the Cloud"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Users uploaded image of the Device or Product"
},
"product": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"description": "Model name of the Product"
},
"make": {
"type": "string",
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Product"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"qa54NXq0DKgyywN1HpWy"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"productTypes",
"baseProtocol",
"protocols"
],
"description": "Product information"
},
"devicePorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"devicePortCd": {
"type": "string",
"enum": [
"cdW4t2rtfwrttyuNkobLr7P"
],
"description": "Unique identifier for the Device Port"
},
"name": {
"type": "string",
"enum": [
"Ethernet"
],
"description": "The Name of the Device Port (set by Altair)"
},
"productPortCd": {
"type": "string",
"enum": [
"PORT-ETHERNET"
],
"description": "The Port Type (set by Altair)"
}
},
"required": [
"devicePortCd",
"name",
"productPortCd"
],
"additionalProperties": false
},
"description": "List of DevicePorts for this Device"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"POWER_ON"
]
},
"description": {
"type": "string",
"enum": [
"Turns the Power ON"
]
},
"controllable": {
"type": "boolean",
"enum": [
true
]
},
"requiresParam": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"name",
"description",
"controllable",
"requiresParam"
],
"additionalProperties": false
},
"description": "List of Actions"
},
"bridge": {
"type": "string",
"description": "Description of the Bridge being used"
},
"settings": {
"type": "object",
"properties": {
"dataUsagePollSecs": {
"type": "string",
"enum": [
"UD_INC_30SEC",
"UD_INC_15MIN"
],
"description": "Poll interval for meter usage"
},
"usageTypes": {
"type": "array",
"description": "Usage types for a meter"
},
"streamLabels": {
"type": "array",
"description": "Stream labels for a Device"
},
"customProductTemplate": {
"type": "string",
"description": "The CD of the custom product template that has been applied."
}
},
"required": [
"dataUsagePollSecs"
],
"description": "Device settings information"
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "boolean",
"description": "Is this a network link device? (Bridge only.)"
},
"showNetworkLink": {
"type": "boolean",
"description": "Does the device support network link control? (Bridge only.)"
}
},
"description": "Device network information (for bridges)"
},
"status": {
"type": "object",
"properties": {
"needsAttention": {
"type": "boolean",
"description": "Does the device require attention?"
},
"operationsStatus": {
"type": "string",
"enum": [
"OPERATIONS_STATUS_ACTIVE",
"OPERATIONS_STATUS_INACTIVE"
],
"description": "Device operations status"
}
},
"required": [
"needsAttention",
"operationsStatus"
],
"description": "Device status information"
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "string",
"description": "The CD of the User who added the Device"
},
"addedByName": {
"type": "string",
"description": "The name of the User who added the Device"
},
"addedDate": {
"type": "string",
"description": "Date the Device was added"
},
"modifiedBy": {
"type": "string",
"description": "The CD of the User who modified the Device"
},
"modifiedByName": {
"type": "string",
"description": "The name of the User who modified the Device"
},
"modifiedDate": {
"type": "string",
"description": "Date the Device was modified"
}
},
"required": [
"addedBy",
"addedByName",
"addedDate"
],
"description": "Device audit information"
},
"authorized": {
"type": "boolean",
"description": "Is the gateway authorized? Only returned for gateway"
},
"authorizationRequired": {
"type": "boolean",
"description": "Is gateway authorization required? Only returned for gateway"
},
"applicationPartners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
}
},
"required": [
"partnerCd",
"name"
],
"additionalProperties": false
},
"description": "List of ApplicationPartners"
},
"editParameters": {
"type": "object",
"properties": {
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"location": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"imageLink": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"settings": {
"type": "object",
"properties": {
"usageTypes": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"streamLabels": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"customProductTemplate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"anyOf",
"number",
"string",
"onePlusOf",
"object",
"array"
],
"default": [
"oneOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"usageTypes",
"streamLabels",
"customProductTemplate"
]
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"anyOf",
"number",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"isNetworkLinkDevice"
]
},
"status": {
"type": "object",
"properties": {
"operationsStatus": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"operationsStatus"
]
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"anyOf",
"number",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"addedBy"
]
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink",
"product",
"devicePorts",
"actions",
"bridge",
"applicationPartners"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Translate Into Custom Product Template ¶
Translate Into Custom Product TemplatePOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/translateIntoCustomProductTemplate
Translates the current Device into a Custom Product Template. This assumes the device was created from a base product and that Custom Labels were added. The newly created Custom Product Template can be used for new devices.
See also: Global Failures
- Types of Responses
- Response 200 - Returns the Custom Field CD
- Response 409 - Conflict - If the update would validate a constraint
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/translateIntoCustomProductTemplate
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the BACnet device
Request
Body
{
"name": "Custom Product Name"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Unique Custom Product Name"
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "sD76fgAkdfuxdf"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "Custom Field CD for the Custom Product Template"
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Generate Devices From BACnet Report ¶
Generate Devices From BACnet ReportPOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/generateDevicesFromBACnetReport
(Auto-)generates devices from the most recent BACnet Report for this gateway; see Downloads: Reports.
The report can be filtered by device-identifier to limit the newly generated devices to only contain the devices which BACnet identifiers are contained in the comma separated filter (example ‘{“device-identifier”:“997,999”}’). In this comma separated list, a range can also be used (example ‘{“device-identifier”:“997,999,1001-1099”}’). If this input parameter is omitted then all device-identifiers from the report will be used.
The BACnet device objects found in the report are used to auto-generate custom labels, see also Custom Data Labels.
The newly created device uses a generic BACnet Base Product as its base and adds the auto-generated custom labels to it, see also Add Custom Labels.
If a device already exists with the same auto-generated name then no new device will be generated (it will be skipped). This is to prevent writing over an existing device.
See also: Global Failures
- Types of Responses
- Response 200 - Returns the device details
- Response 409 - Conflict - If the update would validate a constraint
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E1Tx8GVmN8E7o6JLNGAC/actions/generateDevicesFromBACnetReport
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E1Tx8GVmN8E7o6JLNGACThe Device CD of the Gateway
Request
Body
{
"device-identifier": "2000,2001"
}Schema
{
"type": "object",
"properties": {
"device-identifier": {
"type": "string",
"description": "Comma separated list of BACnet device identifiers."
}
},
"required": [
"device-identifier"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "AoG7n1T16sxgWHCm01Hz",
"name": "Auto-generated BACnet 2000"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_GENERATE_DEVICES",
"httpStatus": 200,
"timeStamp": "2020-11-30T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"AoG7n1T16sxgWHCm01Hz"
],
"description": "CD of the Device"
},
"name": {
"type": "string",
"enum": [
"Auto-generated BACnet 2000"
],
"description": "Name of the Device"
}
},
"required": [
"deviceCd",
"name"
],
"additionalProperties": false
},
"description": "Array of auto-generated devices"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Pulse ¶
Get PulseGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/getPulse{?startDateTime,endDateTime}
This will retrieve a list of online/offline status changes for the gateway
See also: Global Failures
- Types of Responses
- Response 200 - Returns the list of status changes
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/getPulse?startDateTime=2016-05-01T00:00:00-08:00&endDateTime=2016-06-00T00:00:00-08:00
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- startDateTime
string(required) Example: 2016-05-01T00:00:00-08:00The Start Date and Time of the Online Status changes being sought
- endDateTime
string(optional) Example: 2016-06-00T00:00:00-08:00The End Date and Time of the Online Status changes being sought. If not provided, presumes now.
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "E7o6JLNGACE1Tx8GVmN8",
"deviceName": "Smart Edge Gateway",
"siteCd": "cK4Uae73unb72TYuDJDr",
"siteName": "My Site",
"values": [
{
"dateTime": "2016-09-02T14:54:30-07:00",
"value": 2
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_PULSE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "The Device CD"
},
"deviceName": {
"type": "string",
"description": "The User provided Name of the Gateway"
},
"siteCd": {
"type": "string",
"description": "The Site CD"
},
"siteName": {
"type": "string",
"description": "The User provided Name of the Site"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dateTime": {
"type": "string",
"enum": [
"2016-09-02T14:54:30-07:00"
],
"description": "The dateTime of this value."
},
"value": {
"type": "number",
"enum": [
2
],
"description": "The value for this dateTime"
}
},
"required": [
"dateTime",
"value"
],
"additionalProperties": false
},
"description": "Array of Pulse"
}
},
"required": [
"deviceCd",
"deviceName",
"siteCd",
"siteName",
"values"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Link Devices ¶
Get Link DevicesGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/linkDevices
This will retrieve a list of devices on the site that have no bridge set and can use this device as a bridge. In other words, devices that can be linked to this device (gateway or bridge).
See also: Global Failures
- Types of Responses
- Response 200 - Returns the device details
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/linkDevices
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "8GVmN8JLNGAE7o6CE1Tx",
"name": "My Link Device"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_LINK_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"8GVmN8JLNGAE7o6CE1Tx"
],
"description": "The unique CD of the Device"
},
"name": {
"type": "string",
"enum": [
"My Link Device"
],
"description": "Name of the Device"
}
},
"required": [
"deviceCd",
"name"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Add Link DevicesPOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/linkDevices
This will link all devices from the request to this device (gateway or bridge). The devices from the request should have no existing bridge and be able to use this device as a bridge. The list of these devices can be retrieved using the GET endpoint.
See also: Global Failures
- Types of Responses
- Response 200 - Returns the device details
- Response 409 - Conflict - If the add would validate a constraint
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/linkDevices
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
Request
Headers
Content-Type: application/jsonBody
{
"deviceCd": [
"8GVmN8JLNGAE7o6CE1Tx"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"deviceCd": {
"type": "array"
}
},
"required": [
"deviceCd"
]
}Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "8GVmN8JLNGAE7o6CE1Tx",
"name": "My Link Device"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_LINK_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"8GVmN8JLNGAE7o6CE1Tx"
],
"description": "The unique CD of the Device"
},
"name": {
"type": "string",
"enum": [
"My Link Device"
],
"description": "Name of the Device"
}
},
"required": [
"deviceCd",
"name"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Clone Device ¶
CloneGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/clone{?number,cloneApplicationPartners}
- Types of Responses
- Response 200 - Clone successful
See also: Global Failures
Note, when cloning one device of a pair of combo devices the accompanying combo device will also be cloned and the list of returned clones will contain the cloned combo devices too.
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/clone?number=1&cloneApplicationPartners=true
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- number
number(optional) Default: 1 Example: 1Number of clones to create
- cloneApplicationPartners
string(optional) Default: true Example: truetrue/false, Clone the Devices’s Application Partner Mapping
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "72TYucK4U3unbae7DJDr",
"name": "Cloned Device Name"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_DEVICE_CLONE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"72TYucK4U3unbae7DJDr"
],
"description": "CD of the Device"
},
"name": {
"type": "string",
"enum": [
"Cloned Device Name"
],
"description": "Name of the Device"
}
},
"required": [
"deviceCd",
"name"
],
"additionalProperties": false
},
"description": "Array of cloned devices"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Device Specific Info ¶
Device Action Options
Pull up this table to see details about Actions for generic devices.
Device Labels
Pull up this table to see details about the Labels that are tracked for devices.
Device Increment Types
| Usage Type LCD | Description |
|---|---|
| UD_INC_30SEC | 30 Seconds |
| UD_INC_15MIN | 15 Minutes |
| UD_INC_HOUR | Hourly |
| UD_INC_DAY | Daily |
| UD_INC_MONTH | Monthly |
Device Network Config ¶
Device Network Config ¶
This can only be done for a gateway.
Update Network ConfigPUT/api/v3.1/sites/{siteCd}/devices/{deviceCd}/networkConfig
See also: Global Failures
- Types of Responses
- Response 200 - Returns feedback
- Response 409 - Conflict - If the update would validate a constraint
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/networkConfig
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
Request
Body
{
"method": "static",
"interface": "eth0",
"lanAddress": "192.168.0.12",
"netmask": "255.255.0.0",
"gateway": "192.168.0.1",
"dns1": "8.8.8.8",
"dns2": "8.8.4.4",
"sshProxy": "10.0.0.1:544",
"httpProxy": "10.0.0.1:545",
"noroute": "n"
}Schema
{
"type": "object",
"properties": {
"method": {
"enum": [
"static",
"dhcp"
],
"description": "Network Config method"
},
"interface": {
"type": "string",
"default": "eth0",
"description": "Linux network interface name, defaults to eth0"
},
"lanAddress": {
"type": "string",
"description": "IPv4 LAN address, required if method is static"
},
"netmask": {
"type": "string",
"description": "IPv4 netmask, required if method is static"
},
"gateway": {
"type": "string",
"description": "IPv4 gateway, required if method is static"
},
"dns1": {
"type": "string",
"description": "IPv4 DNS server 1, required if method is static"
},
"dns2": {
"type": "string",
"description": "IPv4 DNS server 2"
},
"sshProxy": {
"type": "string",
"description": "IPv4 with port number - SSH Proxy"
},
"httpProxy": {
"type": "string",
"description": "IPv4 with port number - HTTP Proxy"
},
"noroute": {
"enum": [
"n",
"y"
],
"description": "Do not apply default route to this interface? Default is \"n\" (no)."
}
},
"required": [
"method"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"status": "queued"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_UPDATE_NETWORK_CONFIG",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the request"
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Device Events/Usage Data ¶
Device Events Commands
Azure example:
| Example | eventTypeLcd | startDate | endDate | incrementTypeLcd |
|---|---|---|---|---|
| Usage Data Req | UD_DTYPE_KWH_ODM | 2016-03-01 00:00:00-08:00 | 2016-03-02 00:00:00-08:00 | UD_INC_15MIN |
| Device Event | DL_SUPPLY | 2016-03-01 00:00:00-08:00 | 2016-03-02 00:00:00-08:00 | UD_INC_ANY |
Get Device Events ¶
Get Device EventsGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/getEventData{?eventType,productTypeCd,startDateTime,endDateTime,bucketize,increment}
See also: Global Failures
See also: Device Specific Info
This format introduces wildcards for sites and devices. With this, you can tell the API to get the events for:
-
all the sites and all the devices (/sites/*/devices/*/actions/getEventData)
-
all devices for a particular site (/sites/{siteCd}/devices/*/actions/getEventData)
-
a particular device at a site (/sites/{siteCd}/devices/{deviceCd}/actions/getEventData)
On a site level you can add a filter for devices. By adding a comma separated list of the device CDs for the devices you want returned in a URL parameter called deviceCds (e.g., deviceCds=cd1,cd2,cd3,cd4) only those devices will be processed.
The datetime parameters should be given in IS08601. If the timezone offset is omitted then it will be assumed to be device local time.
Event data can be bucketized by using the following two query parameters: bucketize and increment.
The increment options should speak for themselves. Note that the end time of the bucket is used in the return of the API. For example, if the increment is 15 minutes then the data for the bucket 00:00 - 00:15 will be returned with time 00:15.
The bucketize options are as follows:
-
DIFFERENCE/DIFF At the start and end of the bucket values are interpolated to the exact times. The difference in values between end and start of the bucket is returned.
-
AVERAGE/AVG At the start and end of the bucket values are interpolated to the exact times. The average of all values is calculated weighed by time.
-
FIRST The very first value in the bucket is returned.
-
LAST The very last value in the bucket is returned.
-
NEAREST This is the same as LAST.
-
INTERPOLATE_START At the start of the bucket the values are interpolated to the exact start time. This value is returned.
-
INTERPOLATE_END At the end of the bucket the values are interpolated to the exact end time. This value is returned.
-
INTERPOLATE This is the same as INTERPOLATE_END
-
SUM All values in the bucket are added up.
-
MAX The maximum value in the bucket is returned.
Interpolation is linear.
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/getEventData?eventType=DL_SENSOR&productTypeCd=9ZCPez20c9uNWodElk5r&startDateTime=2016-05-01T00:00:00-08:00&endDateTime=2016-06-00T00:00:00-08:00&bucketize=DIFF&increment=UD_INC_15MIN
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- eventType
string(required) Example: DL_SENSORThe LCD of the type of data being sought
- productTypeCd
string(optional) Example: 9ZCPez20c9uNWodElk5rThe CD of the Product Type for which data is being sought
- startDateTime
string(required) Example: 2016-05-01T00:00:00-08:00The Start Date and Time of the Events being sought
- endDateTime
string(optional) Example: 2016-06-00T00:00:00-08:00The End Date and Time of the Events being sought. If not provided, presumes now.
- bucketize
string(optional) Example: DIFFIf used together with increment the data will be bucketized
Choices:
DIFFERENCEDIFFAVERAGEAVGFIRSTLASTNEARESTINTERPOLATE_STARTINTERPOLATE_ENDINTERPOLATESUMMAX- increment
string(optional) Example: UD_INC_15MINIf used together with bucketize the data will be bucketized
Choices:
UD_INC_MINUD_INC_5MINUD_INC_10MINUD_INC_15MINUD_INC_HOUR
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "E7o6JLNGACE1Tx8GVmN8",
"deviceName": "Sensor Room J44",
"values": [
{
"dateTime": "2016-09-02T14:54:30-07:00",
"value": 221
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_DEVICE_EVENT",
"httpStatus": 200,
"page": {
"number": 10,
"size": 5
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "The Device CD"
},
"deviceName": {
"type": "string",
"description": "The User provided Name of the Device"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dateTime": {
"type": "string",
"enum": [
"2016-09-02T14:54:30-07:00"
],
"description": "The dateTime of this value. The ending dateTime if an interval."
},
"value": {
"type": "number",
"enum": [
221
],
"description": "The value for this dateTime"
}
},
"required": [
"dateTime",
"value"
],
"additionalProperties": false
},
"description": "Array of Device Events"
}
},
"required": [
"deviceCd",
"deviceName",
"values"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The max number of items in a page (10 is the max number of items)"
},
"size": {
"type": "number",
"description": "The number of items in this page (but only 5 were returned this time)"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "Current page that is being returned (we are on the 1st page)"
},
"total": {
"type": "number",
"description": "Max number of pages available at this time (of 1 pages)"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Get Meter Usage Data ¶
Get Meter Usage DataGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/actions/getUsageData{?usageType,increment,startDateTime,endDateTime,format,limit,page}
See also: Global Failures
For Device Specific types of Usage Data available, see Device Labels, and the Labels column in Device Specific Info.
This API call can also be run at the site level. In that case all available meters on the site will be included in the return:
- all meters for a particular site (/sites/{siteCd}/actions/getUsageData)
On a site level you can add a filter for meters. By adding a comma separated list of the device CDs for the meters you want returned in a URL parameter called deviceCds (e.g., deviceCds=cd1,cd2,cd3,cd4) only those devices will be processed.
For this query, there are a few places to find the inbound data requirements.
-
usageType - is found in the Power Monitors/Meters section, the Gateway (3rd) column on the Device Labels sheet
-
incrementType - is found on Device Increments
The datetime parameters should be given in IS08601. If the timezone offset is omitted then it will be assumed to be device local time.
The format parameter can be used to specify the format of the returned data. By default this is set to ‘classic’. The option ‘bucketized’ returns the APMF_BUCKETIZED format as described at the Application Partner section. The option ‘timeseries’ returns the APMF_TIMESERIES format. See Create an Application Partner.
The limit and page parameters are only available to increments smaller than UD_INC_MONTH.
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/actions/getUsageData?usageType=UD_DTYPE_KWH_ODM&increment=UD_INC_15MIN&startDateTime=2016-05-01T00:00:00-08:00&endDateTime=2016-06-00T00:00:00-08:00&format=classic&limit=100&page=1
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(optional) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
NOTE: If deviceCd is not provided, then the proceeding “/devices” should not be provided either
- usageType
string(required) Example: UD_DTYPE_KWH_ODMThe LCD of the Usage type being sought
- increment
string(required) Example: UD_INC_15MINThe LCD of the increment desired
- startDateTime
string(required) Example: 2016-05-01T00:00:00-08:00The Start Date and Time of the Events being sought
- endDateTime
string(optional) Example: 2016-06-00T00:00:00-08:00The End Date and Time of the Events being sought. If not provided, presumes now.
- format
string(optional) Default: classic Example: classicDetermines the format for the return data
Choices:
classictimeseriesbucketized- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "E7o6JLNGACE1Tx8GVmN8",
"deviceName": "Main Meter",
"values": [
{
"dateTime": "2016-09-02T14:54:30-07:00",
"value": 221
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_USAGE_DATA",
"httpStatus": 200,
"page": {
"number": 10,
"size": 5
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "The Device CD"
},
"deviceName": {
"type": "string",
"description": "The User provided Name of the Device"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dateTime": {
"type": "string",
"enum": [
"2016-09-02T14:54:30-07:00"
],
"description": "The dateTime of this value. The ending dateTime if an interval."
},
"value": {
"type": "number",
"enum": [
221
],
"description": "The value for this dateTime"
}
},
"required": [
"dateTime",
"value"
],
"additionalProperties": false
},
"description": "Array of Usage Data"
}
},
"required": [
"deviceCd",
"deviceName",
"values"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The max number of items in a page (10 is the max number of items)"
},
"size": {
"type": "number",
"description": "The number of items in this page (but only 5 were returned this time)"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "Current page that is being returned (we are on the 1st page)"
},
"total": {
"type": "number",
"description": "Max number of pages available at this time (of 1 pages)"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Device Issues ¶
Device Issues Commands
Device Issues List ¶
Device Issues ListGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/deviceIssues{?startDateTime,endDateTime,showIgnored,showOKDevices,showInActive}
This format introduces wildcards for sites and devices. With this, you can tell the API to get the status for:
-
all the sites and all the devices (/sites/*/devices/*/deviceIssues -or- /sites/deviceIssues)
-
all devices for a particular site (/sites/{siteCd}/devices/*/deviceIssues -or- /sites/{siteCd}/deviceIssues)
-
a particular device at a site (/sites/{siteCd}/devices/{deviceCd}/deviceIssues)
The request defaults to (with no additional parameters):
-
Now - Returns the data that is returned is the last known state for all matching Devices
-
Not Ignored - Returns Devices that are not currently being ignored
-
Not all Devices - Returns only the Devices that are currently having an issue and are not OK
A User may decide they can Ignore the notificactions about the Status of a particular Device because they know why it is having issues (EX: They know the Device is currently unplugged and will be plugged back in 3 days from now.) Altair allows the User to Ignore a Device that they know is having issues, so that they do not continue to get notices about the Device. The User can Ignore the Device for up to 60 days. A Device returning to operating status while it is being Ignored does not change the Ignore setting.
Use Cases:
-
As a Company Manager, I need to see a list of all Devices that I have access to, that are currently having an Issue.
- This means that I want to send in 1 query that returns all my Devices, and only the Devices that are having Issues right now.
-
As a CM, if a Device within a collection (all-mine, Company, Site, single-Device) had an issue(s) between a start and end date time, I want the list of the Device’s issues.
-
As a CM, so I can resolve issues, each Device Issue needs to have a text desc, and a help suggestion for this issue.
-
As a CM, I need to drill down into a single Device’s issue and see the history of it’s status messages
-
As a CM, I need to set a Device as “Ignore” for up to, but never exceeding, 2 months, so that I don’t get inundated with status problems when I know they are not currently a problem (for whatever reason).
-
As a CM, I don’t want to get notices about devices when I know they are broken, even if they come back online, because there may be a longer set of construction going on that I know of and I don’t want to have to set the Ignore flag multiple times.
See also: Global Failures
See also: Device Specific Info
The datetime parameters should be given in IS08601. If the timezone offset is omitted then it will be assumed to be device local time.
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/deviceIssues?startDateTime=2016-05-01T00:00:00-08:00&endDateTime=2016-06-00T00:00:00-08:00&showIgnored=false&showOKDevices=false&showInActive=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrTBD 1
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8TBD 1
- startDateTime
string(required) Example: 2016-05-01T00:00:00-08:00The Start Date and Time of the Status being sought. If not provided, presumes now and endDateTime is ignored.
- endDateTime
string(optional) Example: 2016-06-00T00:00:00-08:00The End Date and Time of the Status being sought. If not provided, presumes now.
- showIgnored
boolean(optional) Example: falseIf set to
true, returns all Devices even if they have been set to Ignored. Defaults to false.- showOKDevices
boolean(optional) Example: falseDefaults to false. Returns all Devices current status, even ones not having an issue.
- showInActive
boolean(optional) Example: falseDefaults to false. Returns InActive Sites and Devices too.
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"issueCd": "CE1Tx8GVE7o6JLNGAmN8",
"dateTimeUtc": "2016-12-01T21:32:58-07:00",
"dateTime": "2016-12-01T13:32:58-07:00",
"status": "OK",
"device": {
"deviceCd": "E7o6JLNGACE1Tx8GVmN8",
"name": "Meter - Energy, Grid, Bldg 3"
},
"site": {
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "Test Site"
},
"company": {
"companyCd": "Vamwo1XXlx4MWngdb6zk",
"name": "Altair"
},
"ignoreDateTime": "null"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_STATUS",
"httpStatus": 200,
"page": {
"number": 10,
"size": 5
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"issueCd": {
"type": "string",
"enum": [
"CE1Tx8GVE7o6JLNGAmN8"
],
"description": "The Device Issue CD"
},
"dateTimeUtc": {
"type": "string",
"enum": [
"2016-12-01T21:32:58-07:00"
]
},
"dateTime": {
"type": "string",
"enum": [
"2016-12-01T13:32:58-07:00"
]
},
"status": {
"type": "string",
"enum": [
"OK"
],
"description": "The Device Status"
},
"device": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"E7o6JLNGACE1Tx8GVmN8"
],
"description": "The Device CD"
},
"name": {
"type": "string",
"enum": [
"Meter - Energy, Grid, Bldg 3"
],
"description": "The User provided Name of the Device"
}
},
"required": [
"deviceCd",
"name"
],
"additionalProperties": false
},
"site": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"cK4Uae73unb72TYuDJDr"
]
},
"name": {
"type": "string",
"enum": [
"Test Site"
]
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"Vamwo1XXlx4MWngdb6zk"
]
},
"name": {
"type": "string",
"enum": [
"Altair"
]
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false
},
"ignoreDateTime": {
"type": "string",
"enum": [
"null"
]
}
},
"required": [
"issueCd",
"dateTimeUtc",
"dateTime",
"status",
"device",
"site",
"company"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The max number of items in a page (10 is the max number of items)"
},
"size": {
"type": "number",
"description": "The number of items in this page (but only 5 were returned this time)"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "Current page that is being returned (we are on the 1st page)"
},
"total": {
"type": "number",
"description": "Max number of pages available at this time (of 1 pages)"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Device Issues UpdatePUT/api/v3.1/sites/{siteCd}/devices/{deviceCd}/deviceIssues
A User can tell the system to Ignore a Device’s Status for up to 60 days. This ignore request is for everyone, with a Right required for a User to set it.
The request requires the siteCd and the deviceCd to be provided in the path. And the ignoreDateTime is provided in the body.
- Types of Responses
- Response 204 - Update successful - no body returned
- Response 409 - Conflict - If the update would invalidate a constraint, or type and id don’t match.
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/deviceIssues
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrTBD 1
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8TBD 1
Request
Body
{
"ignoreDateTime": "2016-12-08T13:21:33"
}Schema
{
"type": "object",
"properties": {
"ignoreDateTime": {
"type": "string"
}
},
"required": [
"ignoreDateTime"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Headers
Content-Type: application/jsonResponse
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 907,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 409,
"messages": [
{
"id": "responseBadDate",
"text": "Supplied Date is either a bad format, or invalid with respect to the request."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"responseBadDate"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Supplied Date is either a bad format, or invalid with respect to the request."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Device Issues ¶
Device IssuesGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/deviceIssues/{issueCd}
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/deviceIssues/ACE1Tx8GVE7o6JLNGmN8
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrTBD 1
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8TBD 1
- issueCd
string(required) Example: ACE1Tx8GVE7o6JLNGmN8TBD 1
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"issueCd": "CE1Tx8GVE7o6JLNGAmN8",
"dateTimeUtc": "2016-12-01T21:32:58-07:00",
"dateTime": "2016-12-01T13:32:58-07:00",
"status": "OK",
"device": {
"deviceCd": "E7o6JLNGACE1Tx8GVmN8",
"name": "Meter - Energy, Grid, Bldg 3"
},
"site": {
"siteCd": "cK4Uae73unb72TYuDJDr",
"name": "Test Site"
},
"company": {
"companyCd": "Vamwo1XXlx4MWngdb6zk",
"name": "Altair"
},
"ignoreDateTime": "null"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_STATUS",
"httpStatus": 200,
"page": {
"number": 10,
"size": 5
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"issueCd": {
"type": "string",
"description": "The Device Issue CD"
},
"dateTimeUtc": {
"type": "string"
},
"dateTime": {
"type": "string"
},
"status": {
"type": "string",
"description": "The Device Status"
},
"device": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "The Device CD"
},
"name": {
"type": "string",
"description": "The User provided Name of the Device"
}
},
"required": [
"deviceCd",
"name"
]
},
"site": {
"type": "object",
"properties": {
"siteCd": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"siteCd",
"name"
]
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"companyCd",
"name"
]
},
"ignoreDateTime": {
"type": "string"
}
},
"required": [
"issueCd",
"dateTimeUtc",
"dateTime",
"status"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The max number of items in a page (10 is the max number of items)"
},
"size": {
"type": "number",
"description": "The number of items in this page (but only 5 were returned this time)"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "Current page that is being returned (we are on the 1st page)"
},
"total": {
"type": "number",
"description": "Max number of pages available at this time (of 1 pages)"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Device Issues Ignore ¶
Device Issues IgnorePOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/deviceIssues/{issueCd}/actions/ignore
- Types of Responses
- Response 204 - Update successful - no body returned
- Response 409 - Conflict - If the update would invalidate a constraint, or type and id don’t match.
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/deviceIssues/ACE1Tx8GVE7o6JLNGmN8/actions/ignore
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrTBD 1
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8TBD 1
- issueCd
string(required) Example: ACE1Tx8GVE7o6JLNGmN8TBD 1
Request
Body
{
"ignoreDateTime": "2016-12-08T13:21:33"
}Schema
{
"type": "object",
"properties": {
"ignoreDateTime": {
"type": "string"
}
},
"required": [
"ignoreDateTime"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Headers
Content-Type: application/jsonResponse
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 907,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 409,
"messages": [
{
"id": "responseBadDate",
"text": "Supplied Date is either a bad format, or invalid with respect to the request."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"responseBadDate"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Supplied Date is either a bad format, or invalid with respect to the request."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Device Issues Email ¶
Device Issues EmailPOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/deviceIssues/{issueCd}/actions/email
- Types of Responses
- Response 204 - Update successful - no body returned
- Response 409 - Conflict - If the update would invalidate a constraint, or type and id don’t match.
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/deviceIssues/ACE1Tx8GVE7o6JLNGmN8/actions/email
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrTBD 1
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8TBD 1
- issueCd
string(required) Example: ACE1Tx8GVE7o6JLNGmN8TBD 1
Request
Body
{
"users": [
"GVE7oGCE1Tx8AmN6JLN8"
],
"email": [
"user@example.com"
]
}Schema
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "string"
}
},
"email": {
"type": "array",
"items": {
"type": "string"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Headers
Content-Type: application/jsonResponse
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 907,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 409,
"messages": [
{
"id": "responseBadDate",
"text": "Supplied Date is either a bad format, or invalid with respect to the request."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"responseBadDate"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Supplied Date is either a bad format, or invalid with respect to the request."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Rules ¶
Rules List ¶
Rules list description
Get Rules ListGET/api/v3.1/sites/{siteCd}/rules{?compact,editParameters,limit,page,orderBy,direction,filter}
Get the Rules list for this Site.
Notice the limit and page parameters for limiting and paging through a potentially large Rules list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Rules for this Site
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules?compact=true&editParameters=false&limit=100&page=1&orderBy=orderBy&direction=asc&filter=text
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- compact
string(optional) Default: true Example: trueWhen false return notification and trigger details
Choices:
truefalse- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: orderBy Example: orderByField to order results by
Choices:
orderByname- direction
string(optional) Default: asc Example: ascSort direction for the results list
Choices:
ascdesc- filter
string(optional) Example: textFilters results by matching text in fields: Name
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"ruleCd": "IPCL18SO0s83y0FFwQ2a",
"name": "Rule 1",
"notifications": [
"fSQJPv0766Y3ZkGo23s0~1"
],
"steps": [
{
"type": "MACRO_TYPE_ACTION",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"action": "POWER_OFF",
"parameters": "``"
}
],
"triggers": [
"fUT8jTkxRu22K5RbZaFH"
],
"editParameters": {
"ruleCd": {
"fieldName": "ruleCd",
"view": "read",
"type": "string",
"required": true,
"label": "Rule CD",
"labelPlural": "Rule CDs",
"help": "Unique identifier for the Rule."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"notifications": {
"fieldName": "notifications",
"view": "read",
"type": "array",
"required": false,
"label": "Notifications",
"labelPlural": "Notifications",
"help": "Notifications for the Rule."
},
"steps": {
"fieldName": "steps",
"view": "read",
"type": "array",
"required": true,
"label": "Steps",
"labelPlural": "Steps",
"help": "Steps for the Rule.",
"list": [
{
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Rule.",
"options": [
{
"text": "Device Action",
"value": "MACRO_TYPE_ACTION"
}
]
},
{
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
{
"fieldName": "action",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Action",
"labelPlural": "Actions",
"help": "Actions for the Rule Steps."
},
{
"fieldName": "parameters",
"view": "write",
"type": "string",
"required": false,
"label": "Parameters",
"labelPlural": "Parameters",
"help": "Parameters for the Rule Steps."
},
{
"fieldName": "step",
"view": "write",
"type": "number",
"required": false,
"label": "Step",
"labelPlural": "Steps",
"help": "Order Number for the Rule Step."
}
]
},
"triggers": {
"fieldName": "triggers",
"view": "read",
"type": "array",
"required": false,
"label": "Triggers",
"labelPlural": "Triggers",
"help": "Triggers for the Rule."
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_RULE",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ruleCd": {
"type": "string",
"enum": [
"IPCL18SO0s83y0FFwQ2a"
],
"description": "Unique identifier of the Rule"
},
"name": {
"type": "string",
"enum": [
"Rule 1"
],
"description": "Name of the Rule"
},
"notifications": {
"type": "array",
"items": {
"type": "string",
"enum": [
"fSQJPv0766Y3ZkGo23s0~1"
]
},
"description": "List of CDs of notifications"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"MACRO_TYPE_ACTION"
],
"description": "Step type"
},
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"action": {
"type": "string",
"enum": [
"POWER_OFF"
],
"description": "Device Action"
},
"parameters": {
"type": "string",
"enum": [
"``"
],
"description": "Action parameters"
}
},
"required": [
"type",
"deviceCd",
"action"
],
"additionalProperties": false
},
"description": "List of Rule steps"
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"fUT8jTkxRu22K5RbZaFH"
]
},
"description": "List of CDs of triggers"
},
"editParameters": {
"type": "object",
"properties": {
"ruleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"ruleCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Rule CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Rule CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Rule."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name is required, and must be unique within a Site"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"notifications": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"notifications"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Notifications"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Notifications"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Notifications for the Rule."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"steps": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"steps"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Steps"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Steps"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Steps for the Rule."
],
"description": "Some help text available for hover or on error"
},
"list": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"type"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Type"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Types"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Types for the Rule."
],
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Device Action"
],
"description": "Text to display on the UI"
},
"value": {
"type": "string",
"enum": [
"MACRO_TYPE_ACTION"
],
"description": "Value of the option"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"deviceCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Device CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Device CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Device."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"action"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Action"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Actions"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Actions for the Rule Steps."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"parameters"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Parameters"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Parameters"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Parameters for the Rule Steps."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"step"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"number",
"string",
"oneOf",
"array",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Step"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Steps"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Order Number for the Rule Step."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false
}
],
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"list"
],
"additionalProperties": false,
"description": "Edit info"
},
"triggers": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"triggers"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Triggers"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Triggers"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Triggers for the Rule."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"ruleCd",
"name",
"steps"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"ruleCd",
"name",
"steps",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Rule ¶
Get RuleGET/api/v3.1/sites/{siteCd}/rules/{ruleCd}{?compact,editParameters}
- Types of Responses
- Response 200 - Retrieval successful - body included with any extra changes
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG?compact=true&editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDr- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- compact
string(optional) Default: true Example: trueWhen false return notification and trigger details
Choices:
truefalse- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"ruleCd": "IPCL18SO0s83y0FFwQ2a",
"name": "Rule 1",
"notifications": [
"fSQJPv0766Y3ZkGo23s0~1"
],
"steps": [
{
"type": "MACRO_TYPE_ACTION",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"action": "POWER_OFF",
"parameters": "``"
}
],
"triggers": [
"fUT8jTkxRu22K5RbZaFH"
],
"editParameters": {
"ruleCd": {
"fieldName": "ruleCd",
"view": "read",
"type": "string",
"required": true,
"label": "Rule CD",
"labelPlural": "Rule CDs",
"help": "Unique identifier for the Rule."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"notifications": {
"fieldName": "notifications",
"view": "read",
"type": "array",
"required": false,
"label": "Notifications",
"labelPlural": "Notifications",
"help": "Notifications for the Rule."
},
"steps": {
"fieldName": "steps",
"view": "read",
"type": "array",
"required": true,
"label": "Steps",
"labelPlural": "Steps",
"help": "Steps for the Rule.",
"list": [
{
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Rule.",
"options": [
{
"text": "Device Action",
"value": "MACRO_TYPE_ACTION"
}
]
},
{
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
{
"fieldName": "action",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Action",
"labelPlural": "Actions",
"help": "Actions for the Rule Steps."
},
{
"fieldName": "parameters",
"view": "write",
"type": "string",
"required": false,
"label": "Parameters",
"labelPlural": "Parameters",
"help": "Parameters for the Rule Steps."
},
{
"fieldName": "step",
"view": "write",
"type": "number",
"required": false,
"label": "Step",
"labelPlural": "Steps",
"help": "Order Number for the Rule Step."
}
]
},
"triggers": {
"fieldName": "triggers",
"view": "read",
"type": "array",
"required": false,
"label": "Triggers",
"labelPlural": "Triggers",
"help": "Triggers for the Rule."
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_RULE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ruleCd": {
"type": "string",
"description": "Unique identifier of the Rule"
},
"name": {
"type": "string",
"description": "Name of the Rule"
},
"notifications": {
"type": "array",
"description": "List of CDs of notifications"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"MACRO_TYPE_ACTION"
],
"description": "Step type"
},
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"action": {
"type": "string",
"enum": [
"POWER_OFF"
],
"description": "Device Action"
},
"parameters": {
"type": "string",
"enum": [
"``"
],
"description": "Action parameters"
}
},
"required": [
"type",
"deviceCd",
"action"
],
"additionalProperties": false
},
"description": "List of Rule steps"
},
"triggers": {
"type": "array",
"description": "List of CDs of triggers"
},
"editParameters": {
"type": "object",
"properties": {
"ruleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"notifications": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"steps": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"list": {
"type": "array",
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"list"
],
"description": "Edit info"
},
"triggers": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"ruleCd",
"name",
"steps"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"ruleCd",
"name",
"steps"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Create a new RulePOST/api/v3.1/sites/{siteCd}/rules/{?editParameters}
Process options for creating a new rule
Recommended method is to create a Rule by only sending in the “name” property with editParameters set to “true”. This will return a 409 with available options in the editParameters to update the Rule. However, if all options are already known they can be passed in to create the new rule and a 200 will be returned if successful.
- Types of Responses
- Response 200 - Update successful - ruleCd returned in body or full Rule return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDr- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"name": "New Rule"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the rule"
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"ruleCd": "aCe1Tx8GVmN8E7o6JLNG"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_RULE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ruleCd": {
"type": "string",
"description": "The Rule CD"
}
},
"required": [
"ruleCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"ruleCd": "IPCL18SO0s83y0FFwQ2a",
"name": "Rule 1",
"notifications": [
"fSQJPv0766Y3ZkGo23s0~1"
],
"steps": [
{
"type": "MACRO_TYPE_ACTION",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"action": "POWER_OFF",
"parameters": "``"
}
],
"triggers": [
"fUT8jTkxRu22K5RbZaFH"
],
"editParameters": {
"ruleCd": {
"fieldName": "ruleCd",
"view": "read",
"type": "string",
"required": true,
"label": "Rule CD",
"labelPlural": "Rule CDs",
"help": "Unique identifier for the Rule."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"notifications": {
"fieldName": "notifications",
"view": "read",
"type": "array",
"required": false,
"label": "Notifications",
"labelPlural": "Notifications",
"help": "Notifications for the Rule."
},
"steps": {
"fieldName": "steps",
"view": "read",
"type": "array",
"required": true,
"label": "Steps",
"labelPlural": "Steps",
"help": "Steps for the Rule.",
"list": [
{
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Rule.",
"options": [
{
"text": "Device Action",
"value": "MACRO_TYPE_ACTION"
}
]
},
{
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
{
"fieldName": "action",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Action",
"labelPlural": "Actions",
"help": "Actions for the Rule Steps."
},
{
"fieldName": "parameters",
"view": "write",
"type": "string",
"required": false,
"label": "Parameters",
"labelPlural": "Parameters",
"help": "Parameters for the Rule Steps."
},
{
"fieldName": "step",
"view": "write",
"type": "number",
"required": false,
"label": "Step",
"labelPlural": "Steps",
"help": "Order Number for the Rule Step."
}
]
},
"triggers": {
"fieldName": "triggers",
"view": "read",
"type": "array",
"required": false,
"label": "Triggers",
"labelPlural": "Triggers",
"help": "Triggers for the Rule."
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_RULE",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ruleCd": {
"type": "string",
"description": "Unique identifier of the Rule"
},
"name": {
"type": "string",
"description": "Name of the Rule"
},
"notifications": {
"type": "array",
"description": "List of CDs of notifications"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"MACRO_TYPE_ACTION"
],
"description": "Step type"
},
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"action": {
"type": "string",
"enum": [
"POWER_OFF"
],
"description": "Device Action"
},
"parameters": {
"type": "string",
"enum": [
"``"
],
"description": "Action parameters"
}
},
"required": [
"type",
"deviceCd",
"action"
],
"additionalProperties": false
},
"description": "List of Rule steps"
},
"triggers": {
"type": "array",
"description": "List of CDs of triggers"
},
"editParameters": {
"type": "object",
"properties": {
"ruleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"notifications": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"steps": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"list": {
"type": "array",
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"list"
],
"description": "Edit info"
},
"triggers": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"ruleCd",
"name",
"steps"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"ruleCd",
"name",
"steps"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Update a RulePUT/api/v3.1/sites/{siteCd}/rules/{ruleCd}{?editParameters}
Only send in data that is changed
- Types of Responses
- Response 200 - Update successful - ruleCd returned in body or full Rule return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDr- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"name": "New Rule",
"steps": [
{
"type": "MACRO_TYPE_ACTION",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"action": "POWER_OFF",
"parameters": "``"
}
]
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the rule"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"MACRO_TYPE_ACTION"
],
"description": "Step type"
},
"deviceCd": {
"type": "string",
"description": "Unique Device code."
},
"action": {
"type": "string",
"description": "Device Action"
},
"parameters": {
"type": "string",
"description": "Action parameters"
}
},
"required": [
"deviceCd",
"action"
]
},
"description": "List of Rule steps"
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"ruleCd": "aCe1Tx8GVmN8E7o6JLNG"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_RULE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ruleCd": {
"type": "string",
"description": "The Rule CD"
}
},
"required": [
"ruleCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"ruleCd": "IPCL18SO0s83y0FFwQ2a",
"name": "Rule 1",
"notifications": [
"fSQJPv0766Y3ZkGo23s0~1"
],
"steps": [
{
"type": "MACRO_TYPE_ACTION",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"action": "POWER_OFF",
"parameters": "``"
}
],
"triggers": [
"fUT8jTkxRu22K5RbZaFH"
],
"editParameters": {
"ruleCd": {
"fieldName": "ruleCd",
"view": "read",
"type": "string",
"required": true,
"label": "Rule CD",
"labelPlural": "Rule CDs",
"help": "Unique identifier for the Rule."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"notifications": {
"fieldName": "notifications",
"view": "read",
"type": "array",
"required": false,
"label": "Notifications",
"labelPlural": "Notifications",
"help": "Notifications for the Rule."
},
"steps": {
"fieldName": "steps",
"view": "read",
"type": "array",
"required": true,
"label": "Steps",
"labelPlural": "Steps",
"help": "Steps for the Rule.",
"list": [
{
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Rule.",
"options": [
{
"text": "Device Action",
"value": "MACRO_TYPE_ACTION"
}
]
},
{
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
{
"fieldName": "action",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Action",
"labelPlural": "Actions",
"help": "Actions for the Rule Steps."
},
{
"fieldName": "parameters",
"view": "write",
"type": "string",
"required": false,
"label": "Parameters",
"labelPlural": "Parameters",
"help": "Parameters for the Rule Steps."
},
{
"fieldName": "step",
"view": "write",
"type": "number",
"required": false,
"label": "Step",
"labelPlural": "Steps",
"help": "Order Number for the Rule Step."
}
]
},
"triggers": {
"fieldName": "triggers",
"view": "read",
"type": "array",
"required": false,
"label": "Triggers",
"labelPlural": "Triggers",
"help": "Triggers for the Rule."
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_RULE",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"ruleCd": {
"type": "string",
"description": "Unique identifier of the Rule"
},
"name": {
"type": "string",
"description": "Name of the Rule"
},
"notifications": {
"type": "array",
"description": "List of CDs of notifications"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"MACRO_TYPE_ACTION"
],
"description": "Step type"
},
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"action": {
"type": "string",
"enum": [
"POWER_OFF"
],
"description": "Device Action"
},
"parameters": {
"type": "string",
"enum": [
"``"
],
"description": "Action parameters"
}
},
"required": [
"type",
"deviceCd",
"action"
],
"additionalProperties": false
},
"description": "List of Rule steps"
},
"triggers": {
"type": "array",
"description": "List of CDs of triggers"
},
"editParameters": {
"type": "object",
"properties": {
"ruleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"notifications": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"steps": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"list": {
"type": "array",
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"list"
],
"description": "Edit info"
},
"triggers": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"ruleCd",
"name",
"steps"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"ruleCd",
"name",
"steps"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Delete a RuleDELETE/api/v3.1/sites/{siteCd}/rules/{ruleCd}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDr- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
Response
204Headers
Content-Type: application/jsonNotifications List ¶
Rules list description
Get Notifications ListGET/api/v3.1/sites/{siteCd}/rules/{ruleCd}/notifications{?editParameters,limit,page}
Get the Notifications list for this Rule.
Notice the limit and page parameters for limiting and paging through a potentially large Rules list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Notifications for this Rule
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/notifications?editParameters=false&limit=100&page=1
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"notificationCd": "fSQJPv0766Y3ZkGo23s0~1",
"type": "MACRO_TYPE_NOTIFICATION",
"email": [
"test@example.com"
],
"sms": [
"+15555555555"
],
"users": [
"4grd34sggdrt2"
],
"subject": "Notification Subject",
"body": "Notification Body Text",
"editParameters": {
"notificationCd": {
"fieldName": "notificationCd",
"view": "read",
"type": "string",
"required": true,
"label": "Notification CD",
"labelPlural": "Notification CDs",
"help": "Unique identifier for the Notification."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Notification.",
"options": [
{
"text": "Notification",
"value": "MACRO_TYPE_NOTIFICATION"
}
]
},
"email": {
"fieldName": "email",
"view": "write",
"type": "array",
"required": false,
"label": "Email",
"labelPlural": "Emails",
"help": "Email Addresses for the Notification."
},
"sms": {
"fieldName": "email",
"view": "write",
"type": "array",
"required": false,
"label": "SMS Number",
"labelPlural": "SMS Numbers",
"help": "SMS Numbers for the Notification."
},
"users": {
"fieldName": "users",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Users",
"labelPlural": "Users",
"help": "Users for the Notification.",
"options": [
{
"text": "Full Name",
"value": "b70xUmQiRhbwGW5G2vnG"
}
]
},
"subject": {
"fieldName": "subject",
"view": "write",
"type": "string",
"required": false,
"label": "Subject",
"labelPlural": "Subjects",
"help": "Subject of the Notification."
},
"body": {
"fieldName": "body",
"view": "write",
"type": "string",
"required": true,
"label": "Body",
"labelPlural": "Bodies",
"help": "Body of the Notification."
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_NOTIFICATION",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"notificationCd": {
"type": "string",
"enum": [
"fSQJPv0766Y3ZkGo23s0~1"
],
"description": "The Notification CD"
},
"type": {
"type": "string",
"enum": [
"MACRO_TYPE_NOTIFICATION"
],
"description": "Notification type"
},
"email": {
"type": "array",
"items": {
"type": "string",
"enum": [
"test@example.com"
]
},
"description": "List of email addresses (email, sms or users required)"
},
"sms": {
"type": "array",
"items": {
"type": "string",
"enum": [
"+15555555555"
]
},
"description": "List of SMS phone numbers (email, sms or users required)"
},
"users": {
"type": "array",
"items": {
"type": "string",
"enum": [
"4grd34sggdrt2"
]
},
"description": "List of User CDs (email, sms or users required)"
},
"subject": {
"type": "string",
"enum": [
"Notification Subject"
],
"description": "Subject of the Notification email"
},
"body": {
"type": "string",
"enum": [
"Notification Body Text"
],
"description": "Body text of the Notification email"
},
"editParameters": {
"type": "object",
"properties": {
"notificationCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"notificationCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Notification CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Notification CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Notification."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"type"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Type"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Types"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Types for the Notification."
],
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Notification"
],
"description": "Text to display on the UI"
},
"value": {
"type": "string",
"enum": [
"MACRO_TYPE_NOTIFICATION"
],
"description": "Value of the option"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"additionalProperties": false,
"description": "Edit info"
},
"email": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"email"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Email"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Emails"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Email Addresses for the Notification."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"sms": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"email"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"SMS Number"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"SMS Numbers"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"SMS Numbers for the Notification."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"users": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"users"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"array",
"oneOf",
"string",
"number",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Users"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Users"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Users for the Notification."
],
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Full Name"
],
"description": "Full Name of User"
},
"value": {
"type": "string",
"enum": [
"b70xUmQiRhbwGW5G2vnG"
],
"description": "User CD"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"additionalProperties": false,
"description": "Edit info"
},
"subject": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"subject"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Subject"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Subjects"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Subject of the Notification."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"body": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"body"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Body"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Bodies"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Body of the Notification."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"notificationCd",
"type"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"notificationCd",
"type",
"body",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Notification ¶
Get NotificationGET/api/v3.1/sites/{siteCd}/rules/{ruleCd}/notifications/{notificationCd}{?editParameters}
- Types of Responses
- Response 200 - Retrieval successful - body included with any extra changes
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/notifications/fSQJPv0766Y3ZkGo23s0~1?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- notificationCd
string(required) Example: fSQJPv0766Y3ZkGo23s0~1The Notification CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"notificationCd": "fSQJPv0766Y3ZkGo23s0~1",
"type": "MACRO_TYPE_NOTIFICATION",
"email": [
"test@example.com"
],
"sms": [
"+15555555555"
],
"users": [
"4grd34sggdrt2"
],
"subject": "Notification Subject",
"body": "Notification Body Text",
"editParameters": {
"notificationCd": {
"fieldName": "notificationCd",
"view": "read",
"type": "string",
"required": true,
"label": "Notification CD",
"labelPlural": "Notification CDs",
"help": "Unique identifier for the Notification."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Notification.",
"options": [
{
"text": "Notification",
"value": "MACRO_TYPE_NOTIFICATION"
}
]
},
"email": {
"fieldName": "email",
"view": "write",
"type": "array",
"required": false,
"label": "Email",
"labelPlural": "Emails",
"help": "Email Addresses for the Notification."
},
"sms": {
"fieldName": "email",
"view": "write",
"type": "array",
"required": false,
"label": "SMS Number",
"labelPlural": "SMS Numbers",
"help": "SMS Numbers for the Notification."
},
"users": {
"fieldName": "users",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Users",
"labelPlural": "Users",
"help": "Users for the Notification.",
"options": [
{
"text": "Full Name",
"value": "b70xUmQiRhbwGW5G2vnG"
}
]
},
"subject": {
"fieldName": "subject",
"view": "write",
"type": "string",
"required": false,
"label": "Subject",
"labelPlural": "Subjects",
"help": "Subject of the Notification."
},
"body": {
"fieldName": "body",
"view": "write",
"type": "string",
"required": true,
"label": "Body",
"labelPlural": "Bodies",
"help": "Body of the Notification."
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_NOTIFICATION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"notificationCd": {
"type": "string",
"description": "The Notification CD"
},
"type": {
"type": "string",
"enum": [
"MACRO_TYPE_NOTIFICATION"
],
"description": "Notification type"
},
"email": {
"type": "array",
"description": "List of email addresses (email, sms or users required)"
},
"sms": {
"type": "array",
"description": "List of SMS phone numbers (email, sms or users required)"
},
"users": {
"type": "array",
"description": "List of User CDs (email, sms or users required)"
},
"subject": {
"type": "string",
"description": "Subject of the Notification email"
},
"body": {
"type": "string",
"description": "Body text of the Notification email"
},
"editParameters": {
"type": "object",
"properties": {
"notificationCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"email": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"sms": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"users": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"array",
"oneOf",
"string",
"number",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Full Name"
],
"description": "Full Name of User"
},
"value": {
"type": "string",
"enum": [
"b70xUmQiRhbwGW5G2vnG"
],
"description": "User CD"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"subject": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"body": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"notificationCd",
"type"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"notificationCd",
"type",
"body"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Create a new NotificationPOST/api/v3.1/sites/{siteCd}/rules/{ruleCd}/notifications/{?editParameters}
Process options for creating a new notification
- Types of Responses
- Response 200 - Update successful - notificationCd returned in body or full Notification return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/notifications/?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"type": "MACRO_TYPE_NOTIFICATION",
"email": [
"test@example.com"
],
"sms": [
"+15555555555"
],
"users": [
"unb72TYuDJDrcK4Uae73"
],
"subject": "Notification Subject",
"body": "Notification Body Text"
}Schema
{
"type": "object",
"properties": {
"type": {
"enum": [
"MACRO_TYPE_NOTIFICATION"
],
"description": "Type of Notification"
},
"email": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of Email addresses"
},
"sms": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of SMS phone numbers"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of User CDs"
},
"subject": {
"type": "string",
"description": "Subject of the Notification"
},
"body": {
"type": "string",
"description": "Body Text of the Notification"
}
},
"required": [
"type",
"subject",
"body"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"notificationCd": "fSQJPv0766Y3ZkGo23s0~1"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_RULE_NOTIFICATION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"notificationCd": {
"type": "string",
"description": "The Notification CD"
}
},
"required": [
"notificationCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"notificationCd": "fSQJPv0766Y3ZkGo23s0~1",
"type": "MACRO_TYPE_NOTIFICATION",
"email": [
"test@example.com"
],
"sms": [
"+15555555555"
],
"users": [
"4grd34sggdrt2"
],
"subject": "Notification Subject",
"body": "Notification Body Text",
"editParameters": {
"notificationCd": {
"fieldName": "notificationCd",
"view": "read",
"type": "string",
"required": true,
"label": "Notification CD",
"labelPlural": "Notification CDs",
"help": "Unique identifier for the Notification."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Notification.",
"options": [
{
"text": "Notification",
"value": "MACRO_TYPE_NOTIFICATION"
}
]
},
"email": {
"fieldName": "email",
"view": "write",
"type": "array",
"required": false,
"label": "Email",
"labelPlural": "Emails",
"help": "Email Addresses for the Notification."
},
"sms": {
"fieldName": "email",
"view": "write",
"type": "array",
"required": false,
"label": "SMS Number",
"labelPlural": "SMS Numbers",
"help": "SMS Numbers for the Notification."
},
"users": {
"fieldName": "users",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Users",
"labelPlural": "Users",
"help": "Users for the Notification.",
"options": [
{
"text": "Full Name",
"value": "b70xUmQiRhbwGW5G2vnG"
}
]
},
"subject": {
"fieldName": "subject",
"view": "write",
"type": "string",
"required": false,
"label": "Subject",
"labelPlural": "Subjects",
"help": "Subject of the Notification."
},
"body": {
"fieldName": "body",
"view": "write",
"type": "string",
"required": true,
"label": "Body",
"labelPlural": "Bodies",
"help": "Body of the Notification."
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_NOTIFICATION",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"notificationCd": {
"type": "string",
"description": "The Notification CD"
},
"type": {
"type": "string",
"enum": [
"MACRO_TYPE_NOTIFICATION"
],
"description": "Notification type"
},
"email": {
"type": "array",
"description": "List of email addresses (email, sms or users required)"
},
"sms": {
"type": "array",
"description": "List of SMS phone numbers (email, sms or users required)"
},
"users": {
"type": "array",
"description": "List of User CDs (email, sms or users required)"
},
"subject": {
"type": "string",
"description": "Subject of the Notification email"
},
"body": {
"type": "string",
"description": "Body text of the Notification email"
},
"editParameters": {
"type": "object",
"properties": {
"notificationCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"email": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"sms": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"users": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"array",
"oneOf",
"string",
"number",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Full Name"
],
"description": "Full Name of User"
},
"value": {
"type": "string",
"enum": [
"b70xUmQiRhbwGW5G2vnG"
],
"description": "User CD"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"subject": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"body": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"notificationCd",
"type"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"notificationCd",
"type",
"body"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Update a NotificationPUT/api/v3.1/sites/{siteCd}/rules/{ruleCd}/notifications/{notificationCd}{?editParameters}
Only send in data that is changed
- Types of Responses
- Response 200 - Update successful - ruleCd returned in body or full Rule return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/notifications/fSQJPv0766Y3ZkGo23s0~1?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- notificationCd
string(required) Example: fSQJPv0766Y3ZkGo23s0~1The Notification CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"email": [
"new-test@example.com"
],
"subject": "New Notification Subject",
"body": "New Notification Body Text"
}Schema
{
"type": "object",
"properties": {
"email": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of Email addresses"
},
"subject": {
"type": "string",
"description": "Subject of the Notification"
},
"body": {
"type": "string",
"description": "Body Text of the Notification"
}
},
"required": [
"subject",
"body"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"notificationCd": "fSQJPv0766Y3ZkGo23s0~1"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_RULE_NOTIFICATION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"notificationCd": {
"type": "string",
"description": "The Notification CD"
}
},
"required": [
"notificationCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"notificationCd": "fSQJPv0766Y3ZkGo23s0~1",
"type": "MACRO_TYPE_NOTIFICATION",
"email": [
"test@example.com"
],
"sms": [
"+15555555555"
],
"users": [
"4grd34sggdrt2"
],
"subject": "Notification Subject",
"body": "Notification Body Text",
"editParameters": {
"notificationCd": {
"fieldName": "notificationCd",
"view": "read",
"type": "string",
"required": true,
"label": "Notification CD",
"labelPlural": "Notification CDs",
"help": "Unique identifier for the Notification."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Notification.",
"options": [
{
"text": "Notification",
"value": "MACRO_TYPE_NOTIFICATION"
}
]
},
"email": {
"fieldName": "email",
"view": "write",
"type": "array",
"required": false,
"label": "Email",
"labelPlural": "Emails",
"help": "Email Addresses for the Notification."
},
"sms": {
"fieldName": "email",
"view": "write",
"type": "array",
"required": false,
"label": "SMS Number",
"labelPlural": "SMS Numbers",
"help": "SMS Numbers for the Notification."
},
"users": {
"fieldName": "users",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Users",
"labelPlural": "Users",
"help": "Users for the Notification.",
"options": [
{
"text": "Full Name",
"value": "b70xUmQiRhbwGW5G2vnG"
}
]
},
"subject": {
"fieldName": "subject",
"view": "write",
"type": "string",
"required": false,
"label": "Subject",
"labelPlural": "Subjects",
"help": "Subject of the Notification."
},
"body": {
"fieldName": "body",
"view": "write",
"type": "string",
"required": true,
"label": "Body",
"labelPlural": "Bodies",
"help": "Body of the Notification."
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_NOTIFICATION",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"notificationCd": {
"type": "string",
"description": "The Notification CD"
},
"type": {
"type": "string",
"enum": [
"MACRO_TYPE_NOTIFICATION"
],
"description": "Notification type"
},
"email": {
"type": "array",
"description": "List of email addresses (email, sms or users required)"
},
"sms": {
"type": "array",
"description": "List of SMS phone numbers (email, sms or users required)"
},
"users": {
"type": "array",
"description": "List of User CDs (email, sms or users required)"
},
"subject": {
"type": "string",
"description": "Subject of the Notification email"
},
"body": {
"type": "string",
"description": "Body text of the Notification email"
},
"editParameters": {
"type": "object",
"properties": {
"notificationCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"email": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"sms": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"users": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"array",
"oneOf",
"string",
"number",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Full Name"
],
"description": "Full Name of User"
},
"value": {
"type": "string",
"enum": [
"b70xUmQiRhbwGW5G2vnG"
],
"description": "User CD"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"subject": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"body": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"notificationCd",
"type"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"notificationCd",
"type",
"body"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Delete a NotificationDELETE/api/v3.1/sites/{siteCd}/rules/{ruleCd}/notifications/{notificationCd}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/notifications/fSQJPv0766Y3ZkGo23s0~1
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- notificationCd
string(required) Example: fSQJPv0766Y3ZkGo23s0~1The Notification CD
Response
204Headers
Content-Type: application/jsonTrigger List ¶
Trigger list description
Get Trigger ListGET/api/v3.1/sites/{siteCd}/rules/{ruleCd}/triggers{?editParameters,limit,page}
Get the Trigger list for this Rule.
Notice the limit and page parameters for limiting and paging through a potentially large Trigger list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Triggers for this Rule
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/triggers?editParameters=false&limit=100&page=1
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"triggerCd": "6Y3ZkGo23s0fSQJPv076",
"type": "DEVICE_ACTION",
"enabled `true`": true,
"name": "Trigger Name",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"action": "POWER_OFF",
"parameters": "``",
"editParameters": {
"triggerCd": {
"fieldName": "triggerCd",
"view": "read",
"type": "string",
"required": true,
"label": "Trigger CD",
"labelPlural": "Trigger CDs",
"help": "Unique identifier for the Trigger."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Trigger.",
"options": [
{
"text": "Device Action",
"value": "DEVICE_ACTION"
},
{
"text": "Device Value",
"value": "DEVICE_VALUE"
},
{
"text": "Device Compare",
"value": "DEVICE_COMPARE"
},
{
"text": "Schedule",
"value": "SCHEDULE"
}
]
},
"enabled": {
"fieldName": "enabled",
"view": "write",
"type": "string",
"required": true,
"label": "Enabled",
"labelPlural": "Enabled",
"help": "Is Trigger enabled?"
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"action": {
"fieldName": "action",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Action",
"labelPlural": "Actions",
"help": "Actions for the Trigger."
},
"parameters": {
"fieldName": "parameters",
"view": "write",
"type": "string",
"required": false,
"label": "Parameters",
"labelPlural": "Parameters",
"help": "Parameters for the Trigger action."
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_TRIGGER",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggerCd": {
"type": "string",
"enum": [
"6Y3ZkGo23s0fSQJPv076"
],
"description": "The Trigger CD"
},
"type": {
"type": "string",
"enum": [
"DEVICE_ACTION",
"DEVICE_VALUE",
"DEVICE_COMPARE",
"SCHEDULE"
],
"description": "Trigger type"
},
"enabled `true`": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is Trigger enabled?"
},
"name": {
"type": "string",
"enum": [
"Trigger Name"
],
"description": "Name of the Trigger"
},
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"action": {
"type": "string",
"enum": [
"POWER_OFF"
],
"description": "Device Action"
},
"parameters": {
"type": "string",
"enum": [
"``"
],
"description": "Action parameters"
},
"editParameters": {
"type": "object",
"properties": {
"triggerCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"triggerCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Trigger CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Trigger CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Trigger."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"type"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Type"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Types"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Types for the Trigger."
],
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Device Action"
],
"description": "Text to display on the UI"
},
"value": {
"type": "string",
"enum": [
"DEVICE_ACTION"
],
"description": "Value of the option"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Device Value"
],
"description": "Text to display on the UI"
},
"value": {
"type": "string",
"enum": [
"DEVICE_VALUE"
],
"description": "Value of the option"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Device Compare"
],
"description": "Text to display on the UI"
},
"value": {
"type": "string",
"enum": [
"DEVICE_COMPARE"
],
"description": "Value of the option"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Schedule"
],
"description": "Text to display on the UI"
},
"value": {
"type": "string",
"enum": [
"SCHEDULE"
],
"description": "Value of the option"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
}
],
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"additionalProperties": false,
"description": "Edit info"
},
"enabled": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"enabled"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Enabled"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Enabled"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Is Trigger enabled?"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name is required, and must be unique within a Site"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"deviceCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Device CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Device CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Device."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"action": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"action"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Action"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Actions"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Actions for the Trigger."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"parameters": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"parameters"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Parameters"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Parameters"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Parameters for the Trigger action."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"triggerCd",
"type",
"enabled",
"name",
"deviceCd",
"action",
"parameters"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"triggerCd",
"type",
"enabled `true`",
"name",
"deviceCd",
"action",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Trigger ¶
The request parameters for a trigger depend on the trigger type. The examples below show the request and response for the DEVICE_ACTION type. When creating a new Trigger you can see the appropriate properties in the list of editParameters.
Get TriggerGET/api/v3.1/sites/{siteCd}/rules/{ruleCd}/triggers/{triggerCd}{?editParameters}
- Types of Responses
- Response 200 - Retrieval successful - body included with any extra changes
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/triggers/fSQJPv0766Y3ZkGo23s0?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- triggerCd
string(required) Example: fSQJPv0766Y3ZkGo23s0The Trigger CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"triggerCd": "6Y3ZkGo23s0fSQJPv076",
"type": "DEVICE_ACTION",
"enabled `true`": true,
"name": "Trigger Name",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"action": "POWER_OFF",
"parameters": "``",
"editParameters": {
"triggerCd": {
"fieldName": "triggerCd",
"view": "read",
"type": "string",
"required": true,
"label": "Trigger CD",
"labelPlural": "Trigger CDs",
"help": "Unique identifier for the Trigger."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Trigger.",
"options": [
{
"text": "Device Action",
"value": "DEVICE_ACTION"
},
{
"text": "Device Value",
"value": "DEVICE_VALUE"
},
{
"text": "Device Compare",
"value": "DEVICE_COMPARE"
},
{
"text": "Schedule",
"value": "SCHEDULE"
}
]
},
"enabled": {
"fieldName": "enabled",
"view": "write",
"type": "string",
"required": true,
"label": "Enabled",
"labelPlural": "Enabled",
"help": "Is Trigger enabled?"
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"action": {
"fieldName": "action",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Action",
"labelPlural": "Actions",
"help": "Actions for the Trigger."
},
"parameters": {
"fieldName": "parameters",
"view": "write",
"type": "string",
"required": false,
"label": "Parameters",
"labelPlural": "Parameters",
"help": "Parameters for the Trigger action."
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_TRIGGER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"triggerCd": {
"type": "string",
"description": "The Trigger CD"
},
"type": {
"type": "string",
"enum": [
"DEVICE_ACTION",
"DEVICE_VALUE",
"DEVICE_COMPARE",
"SCHEDULE"
],
"description": "Trigger type"
},
"enabled `true`": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is Trigger enabled?"
},
"name": {
"type": "string",
"description": "Name of the Trigger"
},
"deviceCd": {
"type": "string",
"description": "Unique Device code."
},
"action": {
"type": "string",
"description": "Device Action"
},
"parameters": {
"type": "string",
"description": "Action parameters"
},
"editParameters": {
"type": "object",
"properties": {
"triggerCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"enabled": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"action": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"parameters": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"triggerCd",
"type",
"enabled",
"name",
"deviceCd",
"action",
"parameters"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"triggerCd",
"type",
"enabled `true`",
"name",
"deviceCd",
"action"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Create a new TriggerPOST/api/v3.1/sites/{siteCd}/rules/{ruleCd}/triggers/{?editParameters}
Process options for creating a new trigger
Recommended method is to create a Trigger by only sending in the “name” and the “type” properties with editParameters set to “true”. This will return a 409 with available options in the editParameters to update the Trigger.
Available types are DEVICE_ACTION, DEVICE_VALUE and SCHEDULE. For the DEVICE_VALUE type, the available dataLabel options will only be returned when a deviceCd is present in the request body.
However, if all options are already known they can be passed in to create the new trigger and a 200 will be returned if successful.
- Types of Responses
- Response 200 - Update successful - triggerCd returned in body or full Trigger return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/triggers/?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"name": "New Trigger",
"type": "DEVICE_ACTION"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the trigger"
},
"type": {
"type": "string",
"description": "Trigger type"
}
},
"required": [
"name",
"type"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"triggerCd": "fSQJPv0766Y3ZkGo23s0"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_TRIGGER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"triggerCd": {
"type": "string",
"description": "The Trigger CD"
}
},
"required": [
"triggerCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"triggerCd": "6Y3ZkGo23s0fSQJPv076",
"type": "DEVICE_ACTION",
"enabled `true`": true,
"name": "Trigger Name",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"action": "POWER_OFF",
"parameters": "``",
"editParameters": {
"triggerCd": {
"fieldName": "triggerCd",
"view": "read",
"type": "string",
"required": true,
"label": "Trigger CD",
"labelPlural": "Trigger CDs",
"help": "Unique identifier for the Trigger."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Trigger.",
"options": [
{
"text": "Device Action",
"value": "DEVICE_ACTION"
},
{
"text": "Device Value",
"value": "DEVICE_VALUE"
},
{
"text": "Device Compare",
"value": "DEVICE_COMPARE"
},
{
"text": "Schedule",
"value": "SCHEDULE"
}
]
},
"enabled": {
"fieldName": "enabled",
"view": "write",
"type": "string",
"required": true,
"label": "Enabled",
"labelPlural": "Enabled",
"help": "Is Trigger enabled?"
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"action": {
"fieldName": "action",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Action",
"labelPlural": "Actions",
"help": "Actions for the Trigger."
},
"parameters": {
"fieldName": "parameters",
"view": "write",
"type": "string",
"required": false,
"label": "Parameters",
"labelPlural": "Parameters",
"help": "Parameters for the Trigger action."
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_TRIGGER",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"triggerCd": {
"type": "string",
"description": "The Trigger CD"
},
"type": {
"type": "string",
"enum": [
"DEVICE_ACTION",
"DEVICE_VALUE",
"DEVICE_COMPARE",
"SCHEDULE"
],
"description": "Trigger type"
},
"enabled `true`": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is Trigger enabled?"
},
"name": {
"type": "string",
"description": "Name of the Trigger"
},
"deviceCd": {
"type": "string",
"description": "Unique Device code."
},
"action": {
"type": "string",
"description": "Device Action"
},
"parameters": {
"type": "string",
"description": "Action parameters"
},
"editParameters": {
"type": "object",
"properties": {
"triggerCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"enabled": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"action": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"parameters": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"triggerCd",
"type",
"enabled",
"name",
"deviceCd",
"action",
"parameters"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"triggerCd",
"type",
"enabled `true`",
"name",
"deviceCd",
"action"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Update a TriggerPUT/api/v3.1/sites/{siteCd}/rules/{ruleCd}/triggers/{triggerCd}{?editParameters}
Only send in data that is changed
- Types of Responses
- Response 200 - Update successful - ruleCd returned in body or full Rule return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/triggers/fSQJPv0766Y3ZkGo23s0?editParameters=false
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- triggerCd
string(required) Example: fSQJPv0766Y3ZkGo23s0The Trigger CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"name": "Update Trigger",
"type": "DEVICE_ACTION",
"action": "POWER_ON"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the trigger"
},
"type": {
"type": "string",
"description": "Trigger type"
},
"action": {
"type": "string",
"description": "Device Action"
}
},
"required": [
"name",
"type",
"action"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"triggerCd": "fSQJPv0766Y3ZkGo23s0"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_TRIGGER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"triggerCd": {
"type": "string",
"description": "The Trigger CD"
}
},
"required": [
"triggerCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"triggerCd": "6Y3ZkGo23s0fSQJPv076",
"type": "DEVICE_ACTION",
"enabled `true`": true,
"name": "Trigger Name",
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"action": "POWER_OFF",
"parameters": "``",
"editParameters": {
"triggerCd": {
"fieldName": "triggerCd",
"view": "read",
"type": "string",
"required": true,
"label": "Trigger CD",
"labelPlural": "Trigger CDs",
"help": "Unique identifier for the Trigger."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Types for the Trigger.",
"options": [
{
"text": "Device Action",
"value": "DEVICE_ACTION"
},
{
"text": "Device Value",
"value": "DEVICE_VALUE"
},
{
"text": "Device Compare",
"value": "DEVICE_COMPARE"
},
{
"text": "Schedule",
"value": "SCHEDULE"
}
]
},
"enabled": {
"fieldName": "enabled",
"view": "write",
"type": "string",
"required": true,
"label": "Enabled",
"labelPlural": "Enabled",
"help": "Is Trigger enabled?"
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"action": {
"fieldName": "action",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Action",
"labelPlural": "Actions",
"help": "Actions for the Trigger."
},
"parameters": {
"fieldName": "parameters",
"view": "write",
"type": "string",
"required": false,
"label": "Parameters",
"labelPlural": "Parameters",
"help": "Parameters for the Trigger action."
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_TRIGGER",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"triggerCd": {
"type": "string",
"description": "The Trigger CD"
},
"type": {
"type": "string",
"enum": [
"DEVICE_ACTION",
"DEVICE_VALUE",
"DEVICE_COMPARE",
"SCHEDULE"
],
"description": "Trigger type"
},
"enabled `true`": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is Trigger enabled?"
},
"name": {
"type": "string",
"description": "Name of the Trigger"
},
"deviceCd": {
"type": "string",
"description": "Unique Device code."
},
"action": {
"type": "string",
"description": "Device Action"
},
"parameters": {
"type": "string",
"description": "Action parameters"
},
"editParameters": {
"type": "object",
"properties": {
"triggerCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of Items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"enabled": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"action": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"array",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"parameters": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"array",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"triggerCd",
"type",
"enabled",
"name",
"deviceCd",
"action",
"parameters"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"triggerCd",
"type",
"enabled `true`",
"name",
"deviceCd",
"action"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Delete a TriggerDELETE/api/v3.1/sites/{siteCd}/rules/{ruleCd}/triggers/{triggerCd}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/triggers/fSQJPv0766Y3ZkGo23s0
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
- triggerCd
string(required) Example: fSQJPv0766Y3ZkGo23s0The Trigger CD
Response
204Headers
Content-Type: application/jsonRun Rule ¶
Run RulePOST/api/v3.1/sites/{siteCd}/rules/{ruleCd}/actions/run
Run the Rule
- Types of Responses
- Response 200 - Request successful
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/rules/aCe1Tx8GVmN8E7o6JLNG/actions/run
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- ruleCd
string(required) Example: aCe1Tx8GVmN8E7o6JLNGThe Rule CD
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"status": "queued"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_TRIGGER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the request"
}
},
"required": [
"status"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}User ¶
Individual companies can add tag elements in the system (Sites, Devices, Users, Partners) with meta data that is specific to their needs. These are generic fields that will appear as regular properties on those objects. They are grouped under a property called customFields, if present on the object. See the Custom Fields section for help on defining these element.
Authentication ¶
The API supports two methods of authorization:
- Use the login endpoint and exchange the session cookie on subsequent requests.
- Use the API Key as a Bearer token in the Authorization HTTP header.
A user can generate his/her own API Key and delete it. See the User Actions section for details.
Example of the Authorization HTTP header:
Authorization: Bearer dfdsf67.dsfdsf87.65dfsfdsIf any Bearer token is sent in, the session token is ignored. In order to use session based login, make sure not to send a Bearer token.
A User’s API Key is returned as part of the ALTAIR_USER object.
LoginPOST/api/v3.1/login
- Types of Responses
- Response 200 - Login successful - User’s info returned
- Response 403 - Forbidden - Login failed, EULA acceptance required
Example URI
POST https://altairsmartedge.com/api/v3.1/login
Request
Use LoginBody
{
"userLogin": "login",
"userPassword": "password",
"licenses": [
{
"id": "EULA_POWERTOOLS_OCT_2016",
"accepted": true
}
]
}Schema
{
"type": "object",
"properties": {
"userLogin": {
"type": "string",
"description": "The username of the user"
},
"userPassword": {
"type": "string",
"description": "The password of the user"
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "License ID"
},
"accepted": {
"type": "boolean",
"description": "Has the license been accepted>?"
}
},
"required": [
"id",
"accepted"
]
},
"description": "List of EULAs to be accepted"
}
},
"required": [
"userLogin",
"userPassword"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Request
Use EmailBody
{
"userEmail": "user@example.com",
"userPassword": "password",
"licenses": [
{
"id": "EULA_POWERTOOLS_OCT_2016",
"accepted": true
}
]
}Schema
{
"type": "object",
"properties": {
"userEmail": {
"type": "string",
"description": "The email address of the user"
},
"userPassword": {
"type": "string",
"description": "The password of the user"
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "License ID"
},
"accepted": {
"type": "boolean",
"description": "Has the license been accepted>?"
}
},
"required": [
"id",
"accepted"
]
},
"description": "List of EULAs to be accepted"
}
},
"required": [
"userEmail",
"userPassword"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"userCd": "aoJ2D5i4t4yTL3lO6L45",
"firstName": "John",
"lastName": "Smith",
"fullName": "John Smith",
"login": "johns",
"email": "johns@SoccerGreats.com",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"companyTree": {},
"phone1": "333-222-3333",
"phone2": "333-222-3334",
"fax": "333-222-3334",
"sms": "2223331234@att.smstext.net",
"title": "``",
"department": "``",
"reportsTo": {
"userCd": "D5i4t4yTL3aoJ2lO6L45",
"firstName": "Jane",
"lastName": "Jones",
"fullName": "Jane Jones"
},
"licenses": [
{
"id": "EULA_POWERTOOLS_OCT_2016",
"accepted": true
}
],
"maxEmailPerHour": "20",
"roles": [
{
"roleCd": "lCp7Lnsfc34kgytN5Cl8",
"name": "Partner Admin Role"
}
],
"rights": [
"RIGHT_DEVICE_READ"
],
"apiKey": "dsfds77df.fgfd7sdg",
"primarySites": [
{
"siteCd": "eC2L8TZ5z8rp8mKPne35",
"name": "Test Site"
}
],
"totalPrimarySites": 7,
"availablePrimarySites": 7,
"associatedSites": [
{
"siteCd": "eC2L8TZ5z8rp8mKPne35",
"name": "Test Site"
}
],
"totalAssociatedSites": 7,
"availableAssociatedSites": 7,
"accountLocked": true,
"accountDisabled": true
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_USER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for a User"
},
"firstName": {
"type": "string",
"description": "First name of the User"
},
"lastName": {
"type": "string",
"description": "Last name of the User"
},
"fullName": {
"type": "string",
"description": "First Name concatenated with Last Name"
},
"login": {
"type": "string",
"description": "Login for this Uuser"
},
"email": {
"type": "string",
"description": "Email of User, must be Unique"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"description": "Company this user is assigned to"
},
"companyTree": {
"type": "object",
"properties": {},
"description": "Hierarchy of company tree"
},
"phone1": {
"type": "string",
"description": "Phone of the User"
},
"phone2": {
"type": "string",
"description": "Phone2 of the User"
},
"fax": {
"type": "string",
"description": "Fax of the User"
},
"sms": {
"type": "string",
"description": "SMS email to use"
},
"title": {
"type": "string",
"description": "Title of the User"
},
"department": {
"type": "string",
"description": "Department of the User"
},
"reportsTo": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for a User"
},
"firstName": {
"type": "string",
"description": "First name of the User"
},
"lastName": {
"type": "string",
"description": "Last name of the User"
},
"fullName": {
"type": "string",
"description": "First Name concatenated with Last Name"
}
},
"required": [
"userCd",
"lastName"
],
"description": "Details of other User this User reports to"
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"EULA_POWERTOOLS_OCT_2016"
],
"description": "ID of the EULA"
},
"accepted": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Has EULA been accepted"
}
},
"required": [
"id",
"accepted"
],
"additionalProperties": false
},
"description": "List of EULAs"
},
"maxEmailPerHour": {
"type": "string",
"description": "Max number of Emails User is allowed to send"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"enum": [
"lCp7Lnsfc34kgytN5Cl8"
],
"description": "Unique identifier for a Role"
},
"name": {
"type": "string",
"enum": [
"Partner Admin Role"
],
"description": "Name of the Role"
}
},
"required": [
"roleCd",
"name"
],
"additionalProperties": false
},
"description": "List of Roles for this User"
},
"rights": {
"type": "array",
"description": "List of Right LCDs for this User"
},
"apiKey": {
"type": "string",
"description": "Authorization Key for API"
},
"primarySites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"eC2L8TZ5z8rp8mKPne35"
],
"description": "Unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "Name for the Site"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"description": "List of Primary Sites for this User"
},
"totalPrimarySites": {
"type": "number",
"description": "Total number of Primary Sites for this User"
},
"availablePrimarySites": {
"type": "number",
"description": "Total number of Primary Sites available to this User"
},
"associatedSites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"eC2L8TZ5z8rp8mKPne35"
],
"description": "Unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "Name for the Site"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"description": "List of Associated Sites for this User"
},
"totalAssociatedSites": {
"type": "number",
"description": "Total number of Associated Sites for this User"
},
"availableAssociatedSites": {
"type": "number",
"description": "Total number of Associated Sites available to this User"
},
"accountLocked": {
"type": "boolean",
"description": "Account has been locked?"
},
"accountDisabled": {
"type": "boolean",
"description": "Account has been disabled?"
}
},
"required": [
"userCd",
"lastName",
"login",
"email",
"licenses",
"roles",
"primarySites",
"totalPrimarySites",
"availablePrimarySites",
"associatedSites",
"totalAssociatedSites",
"availableAssociatedSites",
"accountLocked",
"accountDisabled"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
403Headers
Content-Type: application/jsonBody
{
"data": {
"licences": [
{
"data": {
"id": "EULA_POWERTOOLS_OCT_2016",
"text": "EULA PowerTools Oct 2016",
"accepted": false,
"agreeDatetime": "null",
"link": "/terms/Candi_Controls_PowerTools_EULA_2016.html",
"html": "``"
}
}
]
},
"meta": {
"responseCode": 13,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 403,
"messages": [
{
"id": "errorEULARequired",
"text": "Agreeing to the following licenses is required before logging in."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"licences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"EULA_POWERTOOLS_OCT_2016"
],
"description": "License ID"
},
"text": {
"type": "string",
"enum": [
"EULA PowerTools Oct 2016"
],
"description": "License description"
},
"accepted": {
"type": "boolean",
"enum": [
false
],
"description": "Has the license been accepted?"
},
"agreeDatetime": {
"type": "string",
"enum": [
"null"
],
"description": "Date the license was accepted"
},
"link": {
"type": "string",
"enum": [
"/terms/Candi_Controls_PowerTools_EULA_2016.html"
],
"description": "URI for the license HTML page"
},
"html": {
"type": "string",
"enum": [
"``"
],
"description": "Full HTML of the license"
}
},
"required": [
"id",
"text",
"accepted",
"link",
"html"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
},
"description": "The licenses that need to be accepted"
}
},
"required": [
"licences"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"enum": [
13,
1002
],
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorEULARequired"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Agreeing to the following licenses is required before logging in."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}LogoutGET/api/v3.1/logout
Example URI
GET https://altairsmartedge.com/api/v3.1/logout
Response
200Headers
Content-Type: application/jsonBody
{
"data": "OK",
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "LOGOUT",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Login as UserGET/api/v3.1/users/{userCd}/actions/loginAs
The current user needs to be logged in, have the appropriate right and access to the user he/she wants to login as.
Example URI
GET https://altairsmartedge.com/api/v3.1/users/aoJ2D5i4t4yTL3lO6L45/actions/loginAs
URI Parameters
- userCd
string(required) Example: aoJ2D5i4t4yTL3lO6L45The unique identifier of the user
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"userCd": "aoJ2D5i4t4yTL3lO6L45",
"firstName": "John",
"lastName": "Smith",
"fullName": "John Smith",
"login": "johns",
"email": "johns@SoccerGreats.com",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"companyTree": {},
"phone1": "333-222-3333",
"phone2": "333-222-3334",
"fax": "333-222-3334",
"sms": "2223331234@att.smstext.net",
"title": "``",
"department": "``",
"reportsTo": {
"userCd": "D5i4t4yTL3aoJ2lO6L45",
"firstName": "Jane",
"lastName": "Jones",
"fullName": "Jane Jones"
},
"licenses": [
{
"id": "EULA_POWERTOOLS_OCT_2016",
"accepted": true
}
],
"maxEmailPerHour": "20",
"roles": [
{
"roleCd": "lCp7Lnsfc34kgytN5Cl8",
"name": "Partner Admin Role"
}
],
"rights": [
"RIGHT_DEVICE_READ"
],
"apiKey": "dsfds77df.fgfd7sdg",
"primarySites": [
{
"siteCd": "eC2L8TZ5z8rp8mKPne35",
"name": "Test Site"
}
],
"totalPrimarySites": 7,
"availablePrimarySites": 7,
"associatedSites": [
{
"siteCd": "eC2L8TZ5z8rp8mKPne35",
"name": "Test Site"
}
],
"totalAssociatedSites": 7,
"availableAssociatedSites": 7,
"accountLocked": true,
"accountDisabled": true
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_USER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for a User"
},
"firstName": {
"type": "string",
"description": "First name of the User"
},
"lastName": {
"type": "string",
"description": "Last name of the User"
},
"fullName": {
"type": "string",
"description": "First Name concatenated with Last Name"
},
"login": {
"type": "string",
"description": "Login for this Uuser"
},
"email": {
"type": "string",
"description": "Email of User, must be Unique"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"description": "Company this user is assigned to"
},
"companyTree": {
"type": "object",
"properties": {},
"description": "Hierarchy of company tree"
},
"phone1": {
"type": "string",
"description": "Phone of the User"
},
"phone2": {
"type": "string",
"description": "Phone2 of the User"
},
"fax": {
"type": "string",
"description": "Fax of the User"
},
"sms": {
"type": "string",
"description": "SMS email to use"
},
"title": {
"type": "string",
"description": "Title of the User"
},
"department": {
"type": "string",
"description": "Department of the User"
},
"reportsTo": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for a User"
},
"firstName": {
"type": "string",
"description": "First name of the User"
},
"lastName": {
"type": "string",
"description": "Last name of the User"
},
"fullName": {
"type": "string",
"description": "First Name concatenated with Last Name"
}
},
"required": [
"userCd",
"lastName"
],
"description": "Details of other User this User reports to"
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"EULA_POWERTOOLS_OCT_2016"
],
"description": "ID of the EULA"
},
"accepted": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Has EULA been accepted"
}
},
"required": [
"id",
"accepted"
],
"additionalProperties": false
},
"description": "List of EULAs"
},
"maxEmailPerHour": {
"type": "string",
"description": "Max number of Emails User is allowed to send"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"enum": [
"lCp7Lnsfc34kgytN5Cl8"
],
"description": "Unique identifier for a Role"
},
"name": {
"type": "string",
"enum": [
"Partner Admin Role"
],
"description": "Name of the Role"
}
},
"required": [
"roleCd",
"name"
],
"additionalProperties": false
},
"description": "List of Roles for this User"
},
"rights": {
"type": "array",
"description": "List of Right LCDs for this User"
},
"apiKey": {
"type": "string",
"description": "Authorization Key for API"
},
"primarySites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"eC2L8TZ5z8rp8mKPne35"
],
"description": "Unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "Name for the Site"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"description": "List of Primary Sites for this User"
},
"totalPrimarySites": {
"type": "number",
"description": "Total number of Primary Sites for this User"
},
"availablePrimarySites": {
"type": "number",
"description": "Total number of Primary Sites available to this User"
},
"associatedSites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"eC2L8TZ5z8rp8mKPne35"
],
"description": "Unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "Name for the Site"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"description": "List of Associated Sites for this User"
},
"totalAssociatedSites": {
"type": "number",
"description": "Total number of Associated Sites for this User"
},
"availableAssociatedSites": {
"type": "number",
"description": "Total number of Associated Sites available to this User"
},
"accountLocked": {
"type": "boolean",
"description": "Account has been locked?"
},
"accountDisabled": {
"type": "boolean",
"description": "Account has been disabled?"
}
},
"required": [
"userCd",
"lastName",
"login",
"email",
"licenses",
"roles",
"primarySites",
"totalPrimarySites",
"availablePrimarySites",
"associatedSites",
"totalAssociatedSites",
"availableAssociatedSites",
"accountLocked",
"accountDisabled"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}User List ¶
User ListGET/api/v3.1/users{?editParameters,limit,page,orderBy,direction,filter}
Get User List
Example URI
GET https://altairsmartedge.com/api/v3.1/users?editParameters=false&limit=100&page=1&orderBy=lastname&direction=asc&filter=text
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: lastname Example: lastnameField to order results by
Choices:
lastnamefirstnameloginemail- direction
string(optional) Default: asc Example: ascSort direction for the results list
Choices:
ascdesc- filter
string(optional) Example: textFilters results by matching text in fields: Name, Email, Company Name
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"userCd": "aoJ2D5i4t4yTL3lO6L45",
"firstName": "John",
"lastName": "Smith",
"fullName": "John Smith",
"login": "johns",
"email": "johns@SoccerGreats.com",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"companyTree": {},
"phone1": "333-222-3333",
"phone2": "333-222-3334",
"fax": "333-222-3334",
"sms": "2223331234@att.smstext.net",
"title": "``",
"department": "``",
"reportsTo": {
"userCd": "D5i4t4yTL3aoJ2lO6L45",
"firstName": "Jane",
"lastName": "Jones",
"fullName": "Jane Jones"
},
"licenses": [
{
"id": "EULA_POWERTOOLS_OCT_2016",
"accepted": true
}
],
"maxEmailPerHour": "20",
"roles": [
{
"roleCd": "lCp7Lnsfc34kgytN5Cl8",
"name": "Partner Admin Role"
}
],
"rights": [
"RIGHT_DEVICE_READ"
],
"apiKey": "dsfds77df.fgfd7sdg",
"primarySites": [
{
"siteCd": "eC2L8TZ5z8rp8mKPne35",
"name": "Test Site"
}
],
"totalPrimarySites": 7,
"availablePrimarySites": 7,
"associatedSites": [
{
"siteCd": "eC2L8TZ5z8rp8mKPne35",
"name": "Test Site"
}
],
"totalAssociatedSites": 7,
"availableAssociatedSites": 7,
"accountLocked": true,
"accountDisabled": true
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_USER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"aoJ2D5i4t4yTL3lO6L45"
],
"description": "Unique identifier for a User"
},
"firstName": {
"type": "string",
"enum": [
"John"
],
"description": "First name of the User"
},
"lastName": {
"type": "string",
"enum": [
"Smith"
],
"description": "Last name of the User"
},
"fullName": {
"type": "string",
"enum": [
"John Smith"
],
"description": "First Name concatenated with Last Name"
},
"login": {
"type": "string",
"enum": [
"johns"
],
"description": "Login for this Uuser"
},
"email": {
"type": "string",
"enum": [
"johns@SoccerGreats.com"
],
"description": "Email of User, must be Unique"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this user is assigned to"
},
"companyTree": {
"type": "object",
"properties": {},
"additionalProperties": false,
"description": "Hierarchy of company tree"
},
"phone1": {
"type": "string",
"enum": [
"333-222-3333"
],
"description": "Phone of the User"
},
"phone2": {
"type": "string",
"enum": [
"333-222-3334"
],
"description": "Phone2 of the User"
},
"fax": {
"type": "string",
"enum": [
"333-222-3334"
],
"description": "Fax of the User"
},
"sms": {
"type": "string",
"enum": [
"2223331234@att.smstext.net"
],
"description": "SMS email to use"
},
"title": {
"type": "string",
"enum": [
"``"
],
"description": "Title of the User"
},
"department": {
"type": "string",
"enum": [
"``"
],
"description": "Department of the User"
},
"reportsTo": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"D5i4t4yTL3aoJ2lO6L45"
],
"description": "Unique identifier for a User"
},
"firstName": {
"type": "string",
"enum": [
"Jane"
],
"description": "First name of the User"
},
"lastName": {
"type": "string",
"enum": [
"Jones"
],
"description": "Last name of the User"
},
"fullName": {
"type": "string",
"enum": [
"Jane Jones"
],
"description": "First Name concatenated with Last Name"
}
},
"required": [
"userCd",
"lastName"
],
"additionalProperties": false,
"description": "Details of other User this User reports to"
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"EULA_POWERTOOLS_OCT_2016"
],
"description": "ID of the EULA"
},
"accepted": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Has EULA been accepted"
}
},
"required": [
"id",
"accepted"
],
"additionalProperties": false
},
"description": "List of EULAs"
},
"maxEmailPerHour": {
"type": "string",
"enum": [
"20"
],
"description": "Max number of Emails User is allowed to send"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"enum": [
"lCp7Lnsfc34kgytN5Cl8"
],
"description": "Unique identifier for a Role"
},
"name": {
"type": "string",
"enum": [
"Partner Admin Role"
],
"description": "Name of the Role"
}
},
"required": [
"roleCd",
"name"
],
"additionalProperties": false
},
"description": "List of Roles for this User"
},
"rights": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RIGHT_DEVICE_READ"
]
},
"description": "List of Right LCDs for this User"
},
"apiKey": {
"type": "string",
"enum": [
"dsfds77df.fgfd7sdg"
],
"description": "Authorization Key for API"
},
"primarySites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"eC2L8TZ5z8rp8mKPne35"
],
"description": "Unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "Name for the Site"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"description": "List of Primary Sites for this User"
},
"totalPrimarySites": {
"type": "number",
"enum": [
7
],
"description": "Total number of Primary Sites for this User"
},
"availablePrimarySites": {
"type": "number",
"enum": [
7
],
"description": "Total number of Primary Sites available to this User"
},
"associatedSites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"eC2L8TZ5z8rp8mKPne35"
],
"description": "Unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "Name for the Site"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"description": "List of Associated Sites for this User"
},
"totalAssociatedSites": {
"type": "number",
"enum": [
7
],
"description": "Total number of Associated Sites for this User"
},
"availableAssociatedSites": {
"type": "number",
"enum": [
7
],
"description": "Total number of Associated Sites available to this User"
},
"accountLocked": {
"type": "boolean",
"enum": [
true
],
"description": "Account has been locked?"
},
"accountDisabled": {
"type": "boolean",
"enum": [
true
],
"description": "Account has been disabled?"
}
},
"required": [
"userCd",
"lastName",
"login",
"email",
"company",
"companyTree",
"licenses",
"roles",
"rights",
"primarySites",
"totalPrimarySites",
"availablePrimarySites",
"associatedSites",
"totalAssociatedSites",
"availableAssociatedSites",
"accountLocked",
"accountDisabled"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Response
403Headers
Content-Type: application/jsonBody
{
"data": {
"licences": [
{
"data": {
"id": "EULA_POWERTOOLS_OCT_2016",
"text": "EULA PowerTools Oct 2016",
"accepted": false,
"agreeDatetime": "null",
"link": "/terms/Candi_Controls_PowerTools_EULA_2016.html",
"html": "``"
}
}
]
},
"meta": {
"responseCode": 13,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 403,
"messages": [
{
"id": "errorEULARequired",
"text": "Agreeing to the following licenses is required before logging in."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"licences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"EULA_POWERTOOLS_OCT_2016"
],
"description": "License ID"
},
"text": {
"type": "string",
"enum": [
"EULA PowerTools Oct 2016"
],
"description": "License description"
},
"accepted": {
"type": "boolean",
"enum": [
false
],
"description": "Has the license been accepted?"
},
"agreeDatetime": {
"type": "string",
"enum": [
"null"
],
"description": "Date the license was accepted"
},
"link": {
"type": "string",
"enum": [
"/terms/Candi_Controls_PowerTools_EULA_2016.html"
],
"description": "URI for the license HTML page"
},
"html": {
"type": "string",
"enum": [
"``"
],
"description": "Full HTML of the license"
}
},
"required": [
"id",
"text",
"accepted",
"link",
"html"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
},
"description": "The licenses that need to be accepted"
}
},
"required": [
"licences"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"enum": [
13,
1002
],
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorEULARequired"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Agreeing to the following licenses is required before logging in."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Bulk Update UsersPUT/api/v3.1/users
Multiple users can be updated in a single batch API call. The userCds need to be passed in as an array in the request body. A maximum of 500 users is allowed in one go. Only “general” properties can be updated. If a property is user specific then it can not be updated in this bulk call.
A user will only get updated if the user has the setting specified in the request body, otherwise it will fail silently.
- Types of Responses
- Response 200 - Update successful - body with userCd and name objects returned for the updated users
- Response 409 - Conflict - If the update would validate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/users
Request
Body
{
"userCds": [
"aoJ2D5i4t4yTL3lO6L45"
],
"customFields": {
"organizationHierarchy": [
"102"
]
}
}Schema
{
"type": "object",
"properties": {
"userCds": {
"type": "array",
"items": {
"type": "string"
},
"description": "This is array of userCds for users you want to update."
},
"customFields": {
"type": "object",
"properties": {
"organizationHierarchy": {
"type": "array",
"items": {
"type": "string"
},
"description": "Example of a user setting to update"
}
}
}
},
"required": [
"userCds"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"userCd": "72TYucK4U3unbae7DJDr",
"name": "Name of Updated User"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_UPDATE_USERS",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"72TYucK4U3unbae7DJDr"
],
"description": "CD of the User"
},
"name": {
"type": "string",
"enum": [
"Name of Updated User"
],
"description": "Name of the User"
}
},
"required": [
"userCd",
"name"
],
"additionalProperties": false
},
"description": "Array of updated users"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}User ¶
Manage a User
Rules around saving user info:
-
Text field character set
- Fields: firstName, lastName, fullName, …
- TBD - character set
-
Password
- Inbound requests only have 1 password field. Using standard convention, this requires the send to validate it (possibly against a confirmation password.
-
Roles and Rights
Get UserGET/api/v3.1/users/{userCd}{?editParameters}
Get User
Example URI
GET https://altairsmartedge.com/api/v3.1/users/aoJ2D5i4t4yTL3lO6L45?editParameters=false
URI Parameters
- userCd
string(required) Example: aoJ2D5i4t4yTL3lO6L45The unique identifier of the user
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"userCd": "aoJ2D5i4t4yTL3lO6L45",
"firstName": "John",
"lastName": "Smith",
"fullName": "John Smith",
"login": "johns",
"email": "johns@SoccerGreats.com",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"companyTree": {},
"phone1": "333-222-3333",
"phone2": "333-222-3334",
"fax": "333-222-3334",
"sms": "2223331234@att.smstext.net",
"title": "``",
"department": "``",
"reportsTo": {
"userCd": "D5i4t4yTL3aoJ2lO6L45",
"firstName": "Jane",
"lastName": "Jones",
"fullName": "Jane Jones"
},
"licenses": [
{
"id": "EULA_POWERTOOLS_OCT_2016",
"accepted": true
}
],
"maxEmailPerHour": "20",
"roles": [
{
"roleCd": "lCp7Lnsfc34kgytN5Cl8",
"name": "Partner Admin Role"
}
],
"rights": [
"RIGHT_DEVICE_READ"
],
"apiKey": "dsfds77df.fgfd7sdg",
"primarySites": [
{
"siteCd": "eC2L8TZ5z8rp8mKPne35",
"name": "Test Site"
}
],
"totalPrimarySites": 7,
"availablePrimarySites": 7,
"associatedSites": [
{
"siteCd": "eC2L8TZ5z8rp8mKPne35",
"name": "Test Site"
}
],
"totalAssociatedSites": 7,
"availableAssociatedSites": 7,
"accountLocked": true,
"accountDisabled": true
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_USER",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for a User"
},
"firstName": {
"type": "string",
"description": "First name of the User"
},
"lastName": {
"type": "string",
"description": "Last name of the User"
},
"fullName": {
"type": "string",
"description": "First Name concatenated with Last Name"
},
"login": {
"type": "string",
"description": "Login for this Uuser"
},
"email": {
"type": "string",
"description": "Email of User, must be Unique"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"description": "Company this user is assigned to"
},
"companyTree": {
"type": "object",
"properties": {},
"description": "Hierarchy of company tree"
},
"phone1": {
"type": "string",
"description": "Phone of the User"
},
"phone2": {
"type": "string",
"description": "Phone2 of the User"
},
"fax": {
"type": "string",
"description": "Fax of the User"
},
"sms": {
"type": "string",
"description": "SMS email to use"
},
"title": {
"type": "string",
"description": "Title of the User"
},
"department": {
"type": "string",
"description": "Department of the User"
},
"reportsTo": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for a User"
},
"firstName": {
"type": "string",
"description": "First name of the User"
},
"lastName": {
"type": "string",
"description": "Last name of the User"
},
"fullName": {
"type": "string",
"description": "First Name concatenated with Last Name"
}
},
"required": [
"userCd",
"lastName"
],
"description": "Details of other User this User reports to"
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"EULA_POWERTOOLS_OCT_2016"
],
"description": "ID of the EULA"
},
"accepted": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Has EULA been accepted"
}
},
"required": [
"id",
"accepted"
],
"additionalProperties": false
},
"description": "List of EULAs"
},
"maxEmailPerHour": {
"type": "string",
"description": "Max number of Emails User is allowed to send"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"enum": [
"lCp7Lnsfc34kgytN5Cl8"
],
"description": "Unique identifier for a Role"
},
"name": {
"type": "string",
"enum": [
"Partner Admin Role"
],
"description": "Name of the Role"
}
},
"required": [
"roleCd",
"name"
],
"additionalProperties": false
},
"description": "List of Roles for this User"
},
"rights": {
"type": "array",
"description": "List of Right LCDs for this User"
},
"apiKey": {
"type": "string",
"description": "Authorization Key for API"
},
"primarySites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"eC2L8TZ5z8rp8mKPne35"
],
"description": "Unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "Name for the Site"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"description": "List of Primary Sites for this User"
},
"totalPrimarySites": {
"type": "number",
"description": "Total number of Primary Sites for this User"
},
"availablePrimarySites": {
"type": "number",
"description": "Total number of Primary Sites available to this User"
},
"associatedSites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"eC2L8TZ5z8rp8mKPne35"
],
"description": "Unique CD for the Site"
},
"name": {
"type": "string",
"enum": [
"Test Site"
],
"description": "Name for the Site"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
},
"description": "List of Associated Sites for this User"
},
"totalAssociatedSites": {
"type": "number",
"description": "Total number of Associated Sites for this User"
},
"availableAssociatedSites": {
"type": "number",
"description": "Total number of Associated Sites available to this User"
},
"accountLocked": {
"type": "boolean",
"description": "Account has been locked?"
},
"accountDisabled": {
"type": "boolean",
"description": "Account has been disabled?"
}
},
"required": [
"userCd",
"lastName",
"login",
"email",
"licenses",
"roles",
"primarySites",
"totalPrimarySites",
"availablePrimarySites",
"associatedSites",
"totalAssociatedSites",
"availableAssociatedSites",
"accountLocked",
"accountDisabled"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
403Headers
Content-Type: application/jsonBody
{
"data": {
"licences": [
{
"data": {
"id": "EULA_POWERTOOLS_OCT_2016",
"text": "EULA PowerTools Oct 2016",
"accepted": false,
"agreeDatetime": "null",
"link": "/terms/Candi_Controls_PowerTools_EULA_2016.html",
"html": "``"
}
}
]
},
"meta": {
"responseCode": 13,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 403,
"messages": [
{
"id": "errorEULARequired",
"text": "Agreeing to the following licenses is required before logging in."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"licences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"EULA_POWERTOOLS_OCT_2016"
],
"description": "License ID"
},
"text": {
"type": "string",
"enum": [
"EULA PowerTools Oct 2016"
],
"description": "License description"
},
"accepted": {
"type": "boolean",
"enum": [
false
],
"description": "Has the license been accepted?"
},
"agreeDatetime": {
"type": "string",
"enum": [
"null"
],
"description": "Date the license was accepted"
},
"link": {
"type": "string",
"enum": [
"/terms/Candi_Controls_PowerTools_EULA_2016.html"
],
"description": "URI for the license HTML page"
},
"html": {
"type": "string",
"enum": [
"``"
],
"description": "Full HTML of the license"
}
},
"required": [
"id",
"text",
"accepted",
"link",
"html"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
},
"description": "The licenses that need to be accepted"
}
},
"required": [
"licences"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"enum": [
13,
1002
],
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorEULARequired"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Agreeing to the following licenses is required before logging in."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Update UserPUT/api/v3.1/users/{userCd}
Update User
When a User is assigned to a different Company the User will lose all mappings to the Roles of the previous Company and Sub Companies. After having been assigned to a different Company, Roles will have to be assigned again to the User.
When a User is assigned to a different Company the User will lose all mappings to the Sites of the previous Company and Sub Companies. After having been assigned to a different Company, Sites will have to be assigned again to the User.
Example URI
PUT https://altairsmartedge.com/api/v3.1/users/aoJ2D5i4t4yTL3lO6L45
URI Parameters
- userCd
string(required) Example: aoJ2D5i4t4yTL3lO6L45The unique identifier of the user
Request
Body
{
"firstName": "New Name"
}Schema
{
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "This is the fieldName you are wanting to change, and the value you are changing it to."
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"userCd": "ez8rp8mKPne35C2L8TZ5"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_USER",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for the User"
}
},
"required": [
"userCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Create UserPOST/api/v3.1/users/
Create a User
Example URI
POST https://altairsmartedge.com/api/v3.1/users/
Request
Body
{
"email": "test@altairsmartedge.com",
"firstName": "Testy",
"lastName": "Testerson",
"login": "stever22",
"password": "Example01!",
"company": {
"companyCd": "4fs44gtrgaer4t"
},
"roleCd": [
"4ty5hthjyuyutu"
]
}Schema
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address"
},
"firstName": {
"type": "string",
"description": "First name"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"login": {
"type": "string",
"description": "Login / username"
},
"password": {
"type": "string",
"description": "Password"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "CD of the Company"
}
},
"required": [
"companyCd"
]
},
"roleCd": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of Role CDs"
}
},
"required": [
"email",
"firstName",
"lastName",
"login",
"password",
"company",
"roleCd"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"userCd": "ez8rp8mKPne35C2L8TZ5"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_USER",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for the User"
}
},
"required": [
"userCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Delete UserDELETE/api/v3.1/users/{userCd}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/users/aoJ2D5i4t4yTL3lO6L45
URI Parameters
- userCd
string(required) Example: aoJ2D5i4t4yTL3lO6L45The unique identifier of the user
Response
204Headers
Content-Type: application/jsonUser Actions ¶
Action Commands
Find User Roles ¶
Find User RolesGET/api/v3.1/users/{userCd}/actions/findRoles{?rightLcd,companyCd}
This endpoint returns all available roles that can be assigned to a user which would give that user the right with “rightLcd” at company with “companyCd”.
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/users/72TYuDJDrcK4Uae73unb/actions/findRoles?rightLcd=RIGHT_SITE_READ&companyCd=H6Z5Ea1psSe449Kg3968
URI Parameters
- userCd
string(required) Example: 72TYuDJDrcK4Uae73unbCD of the User
- rightLcd
string(required) Example: RIGHT_SITE_READThe LCD of the Right required
- companyCd
string(required) Example: H6Z5Ea1psSe449Kg3968The CD of the Company where the User needs the required Right
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"roleCd": "SKxM2rh6d35AO4oyfjfb",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "Role Name",
"description": "Role Description"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_ROLE",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"enum": [
"SKxM2rh6d35AO4oyfjfb"
],
"description": "Unique identifier for the Role"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this Role is assigned to"
},
"name": {
"type": "string",
"enum": [
"Role Name"
],
"description": "Name of the Role"
},
"description": {
"type": "string",
"enum": [
"Role Description"
],
"description": "Description of the Role"
}
},
"required": [
"roleCd",
"company",
"name",
"description"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Add User Role ¶
Add User RolePOST/api/v3.1/users/{userCd}/actions/addRole{?companyCd}
This endpoint adds a role to a user.
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/users/72TYuDJDrcK4Uae73unb/actions/addRole?companyCd=H6Z5Ea1psSe449Kg3968
URI Parameters
- userCd
string(required) Example: 72TYuDJDrcK4Uae73unbCD of the User
- companyCd
string(required) Example: H6Z5Ea1psSe449Kg3968The CD of the Company where the User needs the required Right
Request
Body
{
"roleCd": "AO4oyfjfbSKxM2rh6d35"
}Schema
{
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"description": "Unique identifier for the Role"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"userCd": "72TYuDJDrcK4Uae73unb"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_USER",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for the User"
}
},
"required": [
"userCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Reassign User ¶
Reassign UserGET/api/v3.1/users/{sourceUserCd}/actions/reassign{?userCd}
This will reassign all primary user and site user mappings from the source userCd to the target userCd. The logged in user can only reassign for sites he/she has access to and the right to edit.
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/users/72TYuDJDrcK4Uae73unb/actions/reassign?userCd=DrcK4Uae7372TYuDJunb
URI Parameters
- sourceUserCd
string(required) Example: 72TYuDJDrcK4Uae73unbCD of the Source User
- userCd
string(required) Example: DrcK4Uae7372TYuDJunbCD of the Target User
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"sites": {
"primaryUser": {
"success": [
{
"siteCd": "a1psSe4H6Z5E49Kg3968",
"name": "Site Name 1"
}
],
"failed": [
{
"siteCd": "Kg39684H6Z5Ea1psSe49",
"name": "Site Name 2"
}
],
"noaccess": [
{
"siteCd": "a14H6ZpsSe5E49Kg3968",
"name": "Site Name 3"
}
]
},
"users": {
"success": [
{
"siteCd": "H6Za1psSe45E49Kg3968",
"name": "Site Name 4"
}
],
"failed": [
{
"siteCd": "E49Kg39a1psSe4H6Z568",
"name": "Site Name 5"
}
],
"noaccess": [
{
"siteCd": "aH6Z5E49Kg391psSe468",
"name": "Site Name 6"
}
]
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_REASSIGN_USER",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"sites": {
"type": "object",
"properties": {
"primaryUser": {
"type": "object",
"properties": {
"success": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"a1psSe4H6Z5E49Kg3968"
],
"description": "Site CD"
},
"name": {
"type": "string",
"enum": [
"Site Name 1"
],
"description": "Site Name"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
}
},
"failed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"Kg39684H6Z5Ea1psSe49"
],
"description": "Site CD"
},
"name": {
"type": "string",
"enum": [
"Site Name 2"
],
"description": "Site Name"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
}
},
"noaccess": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"a14H6ZpsSe5E49Kg3968"
],
"description": "Site CD"
},
"name": {
"type": "string",
"enum": [
"Site Name 3"
],
"description": "Site Name"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"success",
"failed",
"noaccess"
]
},
"users": {
"type": "object",
"properties": {
"success": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"H6Za1psSe45E49Kg3968"
],
"description": "Site CD"
},
"name": {
"type": "string",
"enum": [
"Site Name 4"
],
"description": "Site Name"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
}
},
"failed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"E49Kg39a1psSe4H6Z568"
],
"description": "Site CD"
},
"name": {
"type": "string",
"enum": [
"Site Name 5"
],
"description": "Site Name"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
}
},
"noaccess": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteCd": {
"type": "string",
"enum": [
"aH6Z5E49Kg391psSe468"
],
"description": "Site CD"
},
"name": {
"type": "string",
"enum": [
"Site Name 6"
],
"description": "Site Name"
}
},
"required": [
"siteCd",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"success",
"failed",
"noaccess"
]
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}API Key ¶
Generate API KeyPOST/api/v3.1/users/{userCd}/actions/generateApiKey{?force}
- Types of Responses
- Response 200 - API Key generation successful
- Response 403 - Forbidden - Login failed
- Response 409 - Command Abandoned
Example URI
POST https://altairsmartedge.com/api/v3.1/users/72TYuDJDrcK4Uae73unb/actions/generateApiKey?force=false
URI Parameters
- userCd
string(required) Example: 72TYuDJDrcK4Uae73unbCD of the User
- force
string(optional) Default: false Example: falsetrue/false, generate new key even if one already exists
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"apiKey": "cK4Uae73unb.72TYuDJDr"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_API_KEY",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"apiKey": {
"type": "string",
"description": "API Key to be used as Bearer token"
}
},
"required": [
"apiKey"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
403Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 10002,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 401,
"messages": [
{
"id": "responseLoginRequired",
"text": "Command failed. Login required."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"enum": [
10002
],
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"responseLoginRequired"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Command failed. Login required."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}Delete API KeyDELETE/api/v3.1/users/{userCd}/actions/deleteApiKey
- Types of Responses
- Response 204 - API Key deletion successful
- Response 403 - Forbidden - Login failed
- Response 409 - Command Abandoned
Example URI
DELETE https://altairsmartedge.com/api/v3.1/users/72TYuDJDrcK4Uae73unb/actions/deleteApiKey
URI Parameters
- userCd
string(required) Example: 72TYuDJDrcK4Uae73unbCD of the User
Response
204Headers
Content-Type: application/jsonResponse
403Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 10002,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 401,
"messages": [
{
"id": "responseLoginRequired",
"text": "Command failed. Login required."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"enum": [
10002
],
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"responseLoginRequired"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Command failed. Login required."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
}
}User Rights ¶
Get User Rights ¶
Get User RightsGET/api/v3.1/users/{userCd}/actions/getRights{?companyCd}
Get list of User Rights at Company. Returns role at the requested company, if user has any. If no role at company then rights are inherited from a role at a parent company, if the user has any.
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/users/72TYuDJDrcK4Uae73unb/actions/getRights?companyCd=DJDrcK4U72TYuae73unb
URI Parameters
- userCd
string(required) Example: 72TYuDJDrcK4Uae73unbCD of the User
- companyCd
string(required) Example: DJDrcK4U72TYuae73unbCD of the Company (if not provided, presumes user’s company)
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"userCd": "72TYuDJDrcK4Uae73unb",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"role": {
"roleCd": "lCp7Lnsfc34kgytN5Cl8",
"name": "Partner Admin Role"
},
"rights": [
"RIGHT_DEVICE_READ"
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_USER_RIGHTS_AT_COMPANY",
"httpStatus": 200,
"timeStamp": "2017-09-03T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "The User CD"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"description": "Company for which User Rights are requested"
},
"role": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"description": "Unique identifier for a Role"
},
"name": {
"type": "string",
"description": "Name of the Role"
}
},
"required": [
"roleCd",
"name"
],
"description": "Role at Company for which User Rights are requested"
},
"rights": {
"type": "array",
"description": "Array of Rights at Company"
}
},
"required": [
"userCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}User Activity Data ¶
We track activity data for users in bucketized intervals. The following data is tracked:
-
the number of API requests for the logged in user
-
the number of usage data points (meter) returned for the logged in user
The data is stored in UTC time.
Get User Activity Data ¶
Get User Activity DataGET/api/v3.1/users/{userCd}/actions/getActivityData{?activityType,increment,startDateTime,endDateTime}
See also: Global Failures
- activityType - as per table below
| Activity Type LCD | Description |
|---|---|
| BDC_API_REQUEST | API Request Count |
| BDC_DATA_POINTS | API Data Points Returned Count |
- incrementType - as per table below
| Increment LCD | Description |
|---|---|
| UD_INC_15MIN | 15 Minutes |
| UD_INC_HOUR | Hourly |
| UD_INC_DAY | Daily |
| UD_INC_MONTH | Monthly |
Example URI
GET https://altairsmartedge.com/api/v3.1/users/72TYuDJDrcK4Uae73unb/actions/getActivityData?activityType=BDC_API_REQUEST&increment=UD_INC_15MIN&startDateTime=2017-09-01T00:00:00-00:00&endDateTime=2017-09-02T00:00:00-00:00
URI Parameters
- userCd
string(required) Example: 72TYuDJDrcK4Uae73unbCD of the User
- activityType
string(required) Example: BDC_API_REQUESTThe LCD of the activity type being sought
- increment
string(required) Example: UD_INC_15MINThe LCD of the increment desired
- startDateTime
string(required) Example: 2017-09-01T00:00:00-00:00The Start Date and Time of the Events being sought
- endDateTime
string(optional) Example: 2017-09-02T00:00:00-00:00The End Date and Time of the Events being sought. If not provided, presumes now.
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"userCd": "72TYuDJDrcK4Uae73unb",
"fullName": "First Last",
"values": [
{
"startDateTime": "2017-09-01T10:15:00-07:00",
"value": 221
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_ACTIVITY_DATA",
"httpStatus": 200,
"timeStamp": "2017-09-03T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "The User CD"
},
"fullName": {
"type": "string",
"description": "The full name of the User"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startDateTime": {
"type": "string",
"enum": [
"2017-09-01T10:15:00-07:00"
],
"description": "The start dateTime of this value."
},
"value": {
"type": "number",
"enum": [
221
],
"description": "The value for this dateTime"
}
},
"required": [
"startDateTime",
"value"
],
"additionalProperties": false
},
"description": "Array of Activity Data"
}
},
"required": [
"userCd",
"fullName",
"values"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Roles and Rights ¶
Introduction
A User can be assigned to multiple Roles.
Rights enable functionality or define scope for a User. All Rights for particular features default to OFF and must be explicitly enabled. A User with no Role or Rights can only log in, and that’s it. Features managed by a Right include: Can create a new User; Can see all Users within a Users Company; Can Update a Site.
Roles are defined by the Administrator (“System Admin”), and contain Rights. EX: Role is “Installer”, and this User can manage Devices, but has very select list of Sites they can see.
Roles are assigned to a User. And Rights can be individually revoked or added beyond the Role assignment for a User.
Combing the Rights associated with a Role with the Rights they are added or revoked individually, creates the full list of the Rights list for this User - basically defining all the things they can do.
Roles
Roles are defined on a company level and a role inherits all rights from its parent role which is defined at the global level.
There are four (4) global roles:
-
“User”
-
“Installer” (includes all rights from “User”)
-
“Company Manager” (includes all rights from “Installer”)
-
“System Admin” (includes all rights from “Company Manager”)
Example of rights at the company level:
-
“User - CompanyName” (inherits from global “User”)
-
“Installer - CompanyName” (inherits from global “Installer”)
-
“Company Manager - CompanyName” (inherits from global “Company Manager”)
A User can only be assigned Roles of the Company the User belongs to.
Rights
Acces to features is managed by Rights. There are four (4) types of Rights:
-
View only (ex, is the User allowed to view a Device)
-
Edit full(ex, is the User allowed to edit a Device)
-
Add (ex, is the User allowed to add a Device to a Site)
-
Delete (ex, is the User allowed to delete a Device from a Site)
All API endpoints require the appropriate Right(s). If the User does not have sufficient Rights then the command is abandoned with an error message returned.
An overview of Rights for the different Roles can be found here.
Examples
The role(s) a user has can be found in the return from Get User
{
"data": {
...
"roles": [
{
"roleCd": "lCp7Lnsfc34kgytN5Cl8",
"name": "Partner Admin Role"
}
],
...
}
}The role(s) that can be assigned to a user can be found in the editParameters section of the return from Get User
{
"data": {
...
"editParameters": {
...
"roles": {
"fieldName": "role",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Role",
"labelPlural": "Role",
"help": "",
"options": [
{
"text": "System Admin",
"value": "sODrY3LXeT1g00OZ72bm"
},
{
"text": "Company Manager",
"value": "hxPiN6Br0LfZ2p1dfa0E"
},
{
"text": "Installer",
"value": "q8o3eeo6l1D1TNZZmQbb"
},
{
"text": "User",
"value": "AaJTQK145RSxUW6Sw8p7"
}
]
},
...
}
...
}
}When creating a new user a role from the editParameters section of the logged in user can be used to pass in. See Create User for how to pass in a Role CD when creating a user. The format is the same when updating a user.
Roles ¶
Roles List ¶
Get Roles ListGET/api/v3.1/roles{?companyCd,editParameters}
Get the Roles list. This will return the list of all Roles accessible to the logged in user. To limit to Roles of a specific company, pass the companyCd as a URL parameter.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Roles accessible to the user
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/roles?companyCd=45gfdhfgyryg&editParameters=false
URI Parameters
- companyCd
string(optional) Example: 45gfdhfgyrygIf specified, limit to Roles of the company
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"roleCd": "SKxM2rh6d35AO4oyfjfb",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "Role Name",
"description": "Role Description",
"parentRoleCd": "AO4oyfjfbSKxM2rh6d35",
"rights": {
"inherited": [
"RIGHT_USER_READ",
"RIGHT_SITE_READ",
"RIGHT_PRODUCT_WRITE"
],
"added": [
"RIGHT_USER_WRITE",
"RIGHT_SITE_WRITE"
],
"removed": [
"RIGHT_PRODUCT_WRITE"
],
"all": [
"RIGHT_USER_READ",
"RIGHT_SITE_READ",
"RIGHT_USER_WRITE",
"RIGHT_SITE_WRITE"
]
},
"editParameters": {
"roleCd": {
"fieldName": "roleCd",
"view": "read",
"type": "string",
"required": true,
"label": "Role CD",
"labelPlural": "Role CDs",
"help": "Unique identifier for the Role."
},
"company": {
"companyCd": {
"fieldName": "companyCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": true,
"label": "Company Name",
"labelPlural": "Company Names",
"help": "Name of the Company"
}
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Role Name",
"labelPlural": "Role Names",
"help": "Role name is used for identification"
},
"description": {
"fieldName": "description",
"view": "write",
"type": "string",
"required": true,
"label": "Role Description",
"labelPlural": "Role Descriptions",
"help": "Description of the Role"
},
"parentRoleCd": {
"fieldName": "parentRoleCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Parent Role CD",
"labelPlural": "Parent Role CDs",
"help": "CD of the Parent Role"
},
"rights": {
"inherited": {
"fieldName": "inherited",
"view": "read",
"type": "array",
"required": true,
"label": "Inherited Right",
"labelPlural": "Inherited Rights",
"help": "Rights inherited from Parent Role"
},
"added": {
"fieldName": "added",
"view": "read",
"type": "array",
"required": true,
"label": "Added Right",
"labelPlural": "Added Rights",
"help": "Rights added to Role"
},
"removed": {
"fieldName": "removed",
"view": "read",
"type": "array",
"required": true,
"label": "Removed Right",
"labelPlural": "Removed Rights",
"help": "Rights removed from Role"
},
"all": {
"fieldName": "all",
"view": "read",
"type": "array",
"required": true,
"label": "All Rights",
"labelPlural": "All Rights",
"help": "All Rights for Role"
},
"add": {
"fieldName": "add",
"view": "write",
"type": "anyOf",
"required": true,
"label": "Right to Add",
"labelPlural": "Rights to Add",
"help": "Rights to add to Role"
},
"remove": {
"fieldName": "remove",
"view": "write",
"type": "anyOf",
"required": true,
"label": "Right to Remove",
"labelPlural": "Rights to Remove",
"help": "Rights to remove from Role"
}
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_ROLE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"enum": [
"SKxM2rh6d35AO4oyfjfb"
],
"description": "Unique identifier for the Role"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this Role is assigned to"
},
"name": {
"type": "string",
"enum": [
"Role Name"
],
"description": "Name of the Role"
},
"description": {
"type": "string",
"enum": [
"Role Description"
],
"description": "Description of the Role"
},
"parentRoleCd": {
"type": "string",
"enum": [
"AO4oyfjfbSKxM2rh6d35"
],
"description": "Unique identifier for the Parent Role"
},
"rights": {
"type": "object",
"properties": {
"inherited": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"RIGHT_USER_READ"
]
},
{
"type": "string",
"enum": [
"RIGHT_SITE_READ"
]
},
{
"type": "string",
"enum": [
"RIGHT_PRODUCT_WRITE"
]
}
],
"description": "Right LCDs inherited from Parent Role"
},
"added": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"RIGHT_USER_WRITE"
]
},
{
"type": "string",
"enum": [
"RIGHT_SITE_WRITE"
]
}
],
"description": "Right LCDs added to Role"
},
"removed": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RIGHT_PRODUCT_WRITE"
]
},
"description": "Right LCDs removed from Role"
},
"all": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"RIGHT_USER_READ"
]
},
{
"type": "string",
"enum": [
"RIGHT_SITE_READ"
]
},
{
"type": "string",
"enum": [
"RIGHT_USER_WRITE"
]
},
{
"type": "string",
"enum": [
"RIGHT_SITE_WRITE"
]
}
],
"description": "All Right LCDs for Role"
}
},
"additionalProperties": false
},
"editParameters": {
"type": "object",
"properties": {
"roleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"roleCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Role CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Role CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Role."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"companyCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Company CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Company CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Company."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Company Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Company Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name of the Company"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Role Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Role Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Role name is used for identification"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"description": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"description"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Role Description"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Role Descriptions"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Description of the Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"parentRoleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"parentRoleCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Parent Role CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Parent Role CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"CD of the Parent Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"rights": {
"type": "object",
"properties": {
"inherited": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"inherited"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Inherited Right"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Inherited Rights"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights inherited from Parent Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"added": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"added"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Added Right"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Added Rights"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights added to Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"removed": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"removed"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Removed Right"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Removed Rights"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights removed from Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"all": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"all"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"All Rights"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"All Rights"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"All Rights for Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"add": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"add"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Right to Add"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Rights to Add"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights to add to Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"remove": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"remove"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Right to Remove"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Rights to Remove"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights to remove from Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
}
},
"required": [
"inherited",
"added",
"removed",
"all",
"add",
"remove"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"roleCd",
"company",
"name",
"description",
"parentRoleCd",
"rights"
],
"additionalProperties": false,
"description": "Fields will contain arrays of any of the following types"
}
},
"required": [
"roleCd",
"company",
"name",
"description",
"rights",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Role ¶
Get RoleGET/api/v3.1/roles/{roleCd}{?editParameters}
- Types of Responses
- Response 200 - Retrieval successful - body included with any extra changes
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/roles/SKxM2rh6d35AO4oyfjfb?editParameters=false
URI Parameters
- roleCd
string(required) Example: SKxM2rh6d35AO4oyfjfb- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"roleCd": "SKxM2rh6d35AO4oyfjfb",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "Role Name",
"description": "Role Description",
"parentRoleCd": "AO4oyfjfbSKxM2rh6d35",
"rights": {
"inherited": [
"RIGHT_USER_READ",
"RIGHT_SITE_READ",
"RIGHT_PRODUCT_WRITE"
],
"added": [
"RIGHT_USER_WRITE",
"RIGHT_SITE_WRITE"
],
"removed": [
"RIGHT_PRODUCT_WRITE"
],
"all": [
"RIGHT_USER_READ",
"RIGHT_SITE_READ",
"RIGHT_USER_WRITE",
"RIGHT_SITE_WRITE"
]
},
"editParameters": {
"roleCd": {
"fieldName": "roleCd",
"view": "read",
"type": "string",
"required": true,
"label": "Role CD",
"labelPlural": "Role CDs",
"help": "Unique identifier for the Role."
},
"company": {
"companyCd": {
"fieldName": "companyCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": true,
"label": "Company Name",
"labelPlural": "Company Names",
"help": "Name of the Company"
}
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Role Name",
"labelPlural": "Role Names",
"help": "Role name is used for identification"
},
"description": {
"fieldName": "description",
"view": "write",
"type": "string",
"required": true,
"label": "Role Description",
"labelPlural": "Role Descriptions",
"help": "Description of the Role"
},
"parentRoleCd": {
"fieldName": "parentRoleCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Parent Role CD",
"labelPlural": "Parent Role CDs",
"help": "CD of the Parent Role"
},
"rights": {
"inherited": {
"fieldName": "inherited",
"view": "read",
"type": "array",
"required": true,
"label": "Inherited Right",
"labelPlural": "Inherited Rights",
"help": "Rights inherited from Parent Role"
},
"added": {
"fieldName": "added",
"view": "read",
"type": "array",
"required": true,
"label": "Added Right",
"labelPlural": "Added Rights",
"help": "Rights added to Role"
},
"removed": {
"fieldName": "removed",
"view": "read",
"type": "array",
"required": true,
"label": "Removed Right",
"labelPlural": "Removed Rights",
"help": "Rights removed from Role"
},
"all": {
"fieldName": "all",
"view": "read",
"type": "array",
"required": true,
"label": "All Rights",
"labelPlural": "All Rights",
"help": "All Rights for Role"
},
"add": {
"fieldName": "add",
"view": "write",
"type": "anyOf",
"required": true,
"label": "Right to Add",
"labelPlural": "Rights to Add",
"help": "Rights to add to Role"
},
"remove": {
"fieldName": "remove",
"view": "write",
"type": "anyOf",
"required": true,
"label": "Right to Remove",
"labelPlural": "Rights to Remove",
"help": "Rights to remove from Role"
}
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_ROLE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"enum": [
"SKxM2rh6d35AO4oyfjfb"
],
"description": "Unique identifier for the Role"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this Role is assigned to"
},
"name": {
"type": "string",
"enum": [
"Role Name"
],
"description": "Name of the Role"
},
"description": {
"type": "string",
"enum": [
"Role Description"
],
"description": "Description of the Role"
},
"parentRoleCd": {
"type": "string",
"enum": [
"AO4oyfjfbSKxM2rh6d35"
],
"description": "Unique identifier for the Parent Role"
},
"rights": {
"type": "object",
"properties": {
"inherited": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"RIGHT_USER_READ"
]
},
{
"type": "string",
"enum": [
"RIGHT_SITE_READ"
]
},
{
"type": "string",
"enum": [
"RIGHT_PRODUCT_WRITE"
]
}
],
"description": "Right LCDs inherited from Parent Role"
},
"added": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"RIGHT_USER_WRITE"
]
},
{
"type": "string",
"enum": [
"RIGHT_SITE_WRITE"
]
}
],
"description": "Right LCDs added to Role"
},
"removed": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RIGHT_PRODUCT_WRITE"
]
},
"description": "Right LCDs removed from Role"
},
"all": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"RIGHT_USER_READ"
]
},
{
"type": "string",
"enum": [
"RIGHT_SITE_READ"
]
},
{
"type": "string",
"enum": [
"RIGHT_USER_WRITE"
]
},
{
"type": "string",
"enum": [
"RIGHT_SITE_WRITE"
]
}
],
"description": "All Right LCDs for Role"
}
},
"additionalProperties": false
},
"editParameters": {
"type": "object",
"properties": {
"roleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"roleCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Role CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Role CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Role."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"companyCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Company CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Company CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Company."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Company Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Company Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name of the Company"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Role Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Role Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Role name is used for identification"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"description": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"description"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Role Description"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Role Descriptions"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Description of the Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"parentRoleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"parentRoleCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Parent Role CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Parent Role CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"CD of the Parent Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"rights": {
"type": "object",
"properties": {
"inherited": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"inherited"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Inherited Right"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Inherited Rights"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights inherited from Parent Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"added": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"added"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Added Right"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Added Rights"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights added to Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"removed": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"removed"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Removed Right"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Removed Rights"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights removed from Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"all": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"all"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"All Rights"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"All Rights"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"All Rights for Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"add": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"add"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Right to Add"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Rights to Add"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights to add to Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
},
"remove": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"remove"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Right to Remove"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Rights to Remove"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Rights to remove from Role"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit Info"
}
},
"required": [
"inherited",
"added",
"removed",
"all",
"add",
"remove"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"roleCd",
"company",
"name",
"description",
"parentRoleCd",
"rights"
],
"additionalProperties": false,
"description": "Fields will contain arrays of any of the following types"
}
},
"required": [
"roleCd",
"company",
"name",
"description",
"rights",
"editParameters"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Create a new RolePOST/api/v3.1/roles/{?editParameters}
Process options for creating a new Role
- Types of Responses
- Response 200 - Creation successful - roleCd returned in body or full Role returned if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/roles/?editParameters=false
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"companyCd": "AxM2rh6d3O4oyfjfbSK5",
"name": "Role Name",
"description": "Role Description",
"parentRoleCd": "AO4oyfjfbSKxM2rh6d35",
"rights": {
"add": [
"RIGHT_USER_WRITE",
"RIGHT_SITE_WRITE"
],
"remove": [
"RIGHT_PRODUCT_WRITE"
]
}
}Schema
{
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "CD for the Company this Role is assigned to"
},
"name": {
"type": "string",
"description": "Name of the Role"
},
"description": {
"type": "string",
"description": "Description of the Role"
},
"parentRoleCd": {
"type": "string",
"description": "Unique identifier for the Parent Role"
},
"rights": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
},
"description": "Right LCDs to add to Role"
},
"remove": {
"type": "array",
"items": {
"type": "string"
},
"description": "Right LCDs to remove from Role"
}
}
}
},
"required": [
"companyCd",
"name",
"description"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"roleCd": "aCe1Tx8GVmN8E7o6JLNG"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_ROLE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"description": "The Role CD"
}
},
"required": [
"roleCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"roleCd": "SKxM2rh6d35AO4oyfjfb",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "Role Name",
"description": "Role Description",
"parentRoleCd": "AO4oyfjfbSKxM2rh6d35",
"rights": {
"inherited": [
"RIGHT_USER_READ",
"RIGHT_SITE_READ",
"RIGHT_PRODUCT_WRITE"
],
"added": [
"RIGHT_USER_WRITE",
"RIGHT_SITE_WRITE"
],
"removed": [
"RIGHT_PRODUCT_WRITE"
],
"all": [
"RIGHT_USER_READ",
"RIGHT_SITE_READ",
"RIGHT_USER_WRITE",
"RIGHT_SITE_WRITE"
]
},
"editParameters": {
"roleCd": {
"fieldName": "roleCd",
"view": "read",
"type": "string",
"required": true,
"label": "Role CD",
"labelPlural": "Role CDs",
"help": "Unique identifier for the Role."
},
"company": {
"companyCd": {
"fieldName": "companyCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": true,
"label": "Company Name",
"labelPlural": "Company Names",
"help": "Name of the Company"
}
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Role Name",
"labelPlural": "Role Names",
"help": "Role name is used for identification"
},
"description": {
"fieldName": "description",
"view": "write",
"type": "string",
"required": true,
"label": "Role Description",
"labelPlural": "Role Descriptions",
"help": "Description of the Role"
},
"parentRoleCd": {
"fieldName": "parentRoleCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Parent Role CD",
"labelPlural": "Parent Role CDs",
"help": "CD of the Parent Role"
},
"rights": {
"inherited": {
"fieldName": "inherited",
"view": "read",
"type": "array",
"required": true,
"label": "Inherited Right",
"labelPlural": "Inherited Rights",
"help": "Rights inherited from Parent Role"
},
"added": {
"fieldName": "added",
"view": "read",
"type": "array",
"required": true,
"label": "Added Right",
"labelPlural": "Added Rights",
"help": "Rights added to Role"
},
"removed": {
"fieldName": "removed",
"view": "read",
"type": "array",
"required": true,
"label": "Removed Right",
"labelPlural": "Removed Rights",
"help": "Rights removed from Role"
},
"all": {
"fieldName": "all",
"view": "read",
"type": "array",
"required": true,
"label": "All Rights",
"labelPlural": "All Rights",
"help": "All Rights for Role"
},
"add": {
"fieldName": "add",
"view": "write",
"type": "anyOf",
"required": true,
"label": "Right to Add",
"labelPlural": "Rights to Add",
"help": "Rights to add to Role"
},
"remove": {
"fieldName": "remove",
"view": "write",
"type": "anyOf",
"required": true,
"label": "Right to Remove",
"labelPlural": "Rights to Remove",
"help": "Rights to remove from Role"
}
}
}
},
"meta": {
"responseCode": 409,
"responseType": "JSON",
"responseDataType": "ALTAIR_ROLE",
"httpStatus": 409,
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"description": "Unique identifier for the Role"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"description": "Company this Role is assigned to"
},
"name": {
"type": "string",
"description": "Name of the Role"
},
"description": {
"type": "string",
"description": "Description of the Role"
},
"parentRoleCd": {
"type": "string",
"description": "Unique identifier for the Parent Role"
},
"rights": {
"type": "object",
"properties": {
"inherited": {
"type": "array",
"description": "Right LCDs inherited from Parent Role"
},
"added": {
"type": "array",
"description": "Right LCDs added to Role"
},
"removed": {
"type": "array",
"description": "Right LCDs removed from Role"
},
"all": {
"type": "array",
"description": "All Right LCDs for Role"
}
}
},
"editParameters": {
"type": "object",
"properties": {
"roleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
}
},
"required": [
"companyCd",
"name"
]
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"description": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"parentRoleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"rights": {
"type": "object",
"properties": {
"inherited": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"added": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"removed": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"all": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"add": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"remove": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
}
},
"required": [
"inherited",
"added",
"removed",
"all",
"add",
"remove"
],
"description": "Edit info"
}
},
"required": [
"roleCd",
"name",
"description",
"parentRoleCd",
"rights"
],
"description": "Fields will contain arrays of any of the following types"
}
},
"required": [
"roleCd",
"name",
"description"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Update a RolePUT/api/v3.1/roles/{roleCd}{?editParameters}
Only send in data that is changed
- Types of Responses
- Response 200 - Update successful - roleCd returned in body or full Role return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/roles/SKxM2rh6d35AO4oyfjfb?editParameters=false
URI Parameters
- roleCd
string(required) Example: SKxM2rh6d35AO4oyfjfbThe Role CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"name": "New Role Name",
"rights": {
"add": [
"RIGHT_USER_DELETE",
"RIGHT_SITE_DELETE"
]
}
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Role"
},
"rights": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
},
"description": "Right LCDs to add to Role"
}
}
}
},
"required": [
"name"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"roleCd": "aCe1Tx8GVmN8E7o6JLNG"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_ROLE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"description": "The Role CD"
}
},
"required": [
"roleCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"roleCd": "SKxM2rh6d35AO4oyfjfb",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"name": "Role Name",
"description": "Role Description",
"parentRoleCd": "AO4oyfjfbSKxM2rh6d35",
"rights": {
"inherited": [
"RIGHT_USER_READ",
"RIGHT_SITE_READ",
"RIGHT_PRODUCT_WRITE"
],
"added": [
"RIGHT_USER_WRITE",
"RIGHT_SITE_WRITE"
],
"removed": [
"RIGHT_PRODUCT_WRITE"
],
"all": [
"RIGHT_USER_READ",
"RIGHT_SITE_READ",
"RIGHT_USER_WRITE",
"RIGHT_SITE_WRITE"
]
},
"editParameters": {
"roleCd": {
"fieldName": "roleCd",
"view": "read",
"type": "string",
"required": true,
"label": "Role CD",
"labelPlural": "Role CDs",
"help": "Unique identifier for the Role."
},
"company": {
"companyCd": {
"fieldName": "companyCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": true,
"label": "Company Name",
"labelPlural": "Company Names",
"help": "Name of the Company"
}
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Role Name",
"labelPlural": "Role Names",
"help": "Role name is used for identification"
},
"description": {
"fieldName": "description",
"view": "write",
"type": "string",
"required": true,
"label": "Role Description",
"labelPlural": "Role Descriptions",
"help": "Description of the Role"
},
"parentRoleCd": {
"fieldName": "parentRoleCd",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Parent Role CD",
"labelPlural": "Parent Role CDs",
"help": "CD of the Parent Role"
},
"rights": {
"inherited": {
"fieldName": "inherited",
"view": "read",
"type": "array",
"required": true,
"label": "Inherited Right",
"labelPlural": "Inherited Rights",
"help": "Rights inherited from Parent Role"
},
"added": {
"fieldName": "added",
"view": "read",
"type": "array",
"required": true,
"label": "Added Right",
"labelPlural": "Added Rights",
"help": "Rights added to Role"
},
"removed": {
"fieldName": "removed",
"view": "read",
"type": "array",
"required": true,
"label": "Removed Right",
"labelPlural": "Removed Rights",
"help": "Rights removed from Role"
},
"all": {
"fieldName": "all",
"view": "read",
"type": "array",
"required": true,
"label": "All Rights",
"labelPlural": "All Rights",
"help": "All Rights for Role"
},
"add": {
"fieldName": "add",
"view": "write",
"type": "anyOf",
"required": true,
"label": "Right to Add",
"labelPlural": "Rights to Add",
"help": "Rights to add to Role"
},
"remove": {
"fieldName": "remove",
"view": "write",
"type": "anyOf",
"required": true,
"label": "Right to Remove",
"labelPlural": "Rights to Remove",
"help": "Rights to remove from Role"
}
}
}
},
"meta": {
"responseCode": 409,
"responseType": "JSON",
"responseDataType": "ALTAIR_ROLE",
"httpStatus": 409,
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"roleCd": {
"type": "string",
"description": "Unique identifier for the Role"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"description": "Company this Role is assigned to"
},
"name": {
"type": "string",
"description": "Name of the Role"
},
"description": {
"type": "string",
"description": "Description of the Role"
},
"parentRoleCd": {
"type": "string",
"description": "Unique identifier for the Parent Role"
},
"rights": {
"type": "object",
"properties": {
"inherited": {
"type": "array",
"description": "Right LCDs inherited from Parent Role"
},
"added": {
"type": "array",
"description": "Right LCDs added to Role"
},
"removed": {
"type": "array",
"description": "Right LCDs removed from Role"
},
"all": {
"type": "array",
"description": "All Right LCDs for Role"
}
}
},
"editParameters": {
"type": "object",
"properties": {
"roleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
}
},
"required": [
"companyCd",
"name"
]
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"description": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"parentRoleCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"rights": {
"type": "object",
"properties": {
"inherited": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"added": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"removed": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"all": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"add": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
},
"remove": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"string",
"onePlusOf",
"number",
"oneOf",
"object",
"array"
],
"default": "anyOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit Info"
}
},
"required": [
"inherited",
"added",
"removed",
"all",
"add",
"remove"
],
"description": "Edit info"
}
},
"required": [
"roleCd",
"name",
"description",
"parentRoleCd",
"rights"
],
"description": "Fields will contain arrays of any of the following types"
}
},
"required": [
"roleCd",
"name",
"description"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"messages",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Delete a RoleDELETE/api/v3.1/roles/{roleCd}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/roles/SKxM2rh6d35AO4oyfjfb
URI Parameters
- roleCd
string(required) Example: SKxM2rh6d35AO4oyfjfbThe Role CD
Response
204Headers
Content-Type: application/jsonLookups ¶
Lookup Commands
Lookup List ¶
Lookup list description
Get Lookup ListGET/api/v3.1/lookups/{?parentLcd}{?limit}{?page}
Get a list of Lookups
Notice the limit and page parameters for limiting and paging through a potentially large Lookup list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Lookups
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/lookups/?parentLcd=!_TOP_INFO_TYPE_!?limit=100?page=1
URI Parameters
- parentLcd
string(required) Example: !_TOP_INFO_TYPE_!Providing this will return all Lookups that are children of this Parent
- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
Response
200Headers
Content-Type: application/jsonBody
[
{
"lookupLcd": "IT_IP_ADDRESS",
"parentLookupLcd": "!_TOP_INFO_TYPE_!",
"value": "``",
"description": "IP Address",
"orderBy": "12"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"lookupLcd": {
"type": "string",
"enum": [
"IT_IP_ADDRESS"
],
"description": "Unique lookup code"
},
"parentLookupLcd": {
"type": "string",
"enum": [
"!_TOP_INFO_TYPE_!"
],
"description": "Parent level for this Lookup"
},
"value": {
"type": "string",
"enum": [
"``"
],
"description": "A string, but is usually a number. Used in place of the LOOKUP_LCD in the database sometimes."
},
"description": {
"type": "string",
"enum": [
"IP Address"
],
"description": "Description of this Lookup"
},
"orderBy": {
"type": "string",
"enum": [
"12"
],
"description": "The Order by which these Lookups are supplied"
}
},
"required": [
"lookupLcd",
"parentLookupLcd",
"value",
"description",
"orderBy"
],
"additionalProperties": false
}
}Get Lookup ¶
Lookup description
Get LookupGET/api/v3.1/lookups/{lookupLcd}
Get a single Lookup.
- Types of Responses
- Response 200 - Retrieval successful - body contains Lookup
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/lookups/IT_IP_ADDRESS
URI Parameters
- lookupLcd
string(required) Example: IT_IP_ADDRESSThe LookupLcd code
Response
200Headers
Content-Type: application/jsonBody
{
"lookupLcd": "IT_IP_ADDRESS",
"parentLookupLcd": "!_TOP_INFO_TYPE_!",
"value": "``",
"description": "IP Address",
"orderBy": "12"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"lookupLcd": {
"type": "string",
"description": "Unique lookup code"
},
"parentLookupLcd": {
"type": "string",
"description": "Parent level for this Lookup"
},
"value": {
"type": "string",
"description": "A string, but is usually a number. Used in place of the LOOKUP_LCD in the database sometimes."
},
"description": {
"type": "string",
"description": "Description of this Lookup"
},
"orderBy": {
"type": "string",
"description": "The Order by which these Lookups are supplied"
}
}
}Custom Data ¶
Custom Data is a place of storage that can contain data the user needs to store. Custom Data requires a type (site or user) and three keys, an siteOrUserCd, objectCd, name. The 2nd 2 keys can be anything the API User desires. Inbound data must be accepted JSON formatted data. Examples include:
-
Application needs to store the Users language preferences, last signin date, etc. (Ex: ObjectCd={UserCd}, name=‘app_pref’)
-
App needs to store extra information about a Device (2nd location, installer, …) (Ex: ObjectCd={deviceCd}, name=‘installer_info’)
Custom Data supports the storage of text data.
If the type is ‘site’ then a ‘siteCd’ will be returned in the response. If ‘user’ then ‘userCd’ will be returned.
CustomData ¶
Store CustomData into the database for later use.
Get CustomDataGET/api/v3.1/customData/{type}/{siteOrUserCd}/{objectCd}/{name}
Example URI
GET https://altairsmartedge.com/api/v3.1/customData/site/cK4Uae73unb72TYuDJDr/BillsCustomApp/USER_DATA
URI Parameters
- type
string(required) Example: siteType of Custom Data
- siteOrUserCd
string(required) Example: cK4Uae73unb72TYuDJDrSite or User CD depending on type
- objectCd
string(required) Example: BillsCustomAppAny string the User desires to use to store the data
- name
string(required) Example: USER_DATAA 2nd string the User desires to use to store the data
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"type": "site",
"siteCd": "cK4Uae73unb72TYuDJDr",
"objectCd": "PccGk7RHnf7NHcuFYXLd",
"name": "AppSpecificName",
"data": "Hello World!",
"expireDatetime": "2017-12-01 00:00:00"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_DATA",
"status": "200 OK",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"site",
"user"
],
"description": "Type of Custom Data"
},
"siteCd": {
"type": "string",
"description": "The Site or User CD associated with this CustomData"
},
"objectCd": {
"type": "string",
"description": "A made up unique identifier"
},
"name": {
"type": "string",
"description": "Another unique identifier."
},
"data": {
"type": "string",
"description": "String of custom data saved."
},
"expireDatetime": {
"type": "string",
"description": "Datetime when the custom data expires"
}
},
"required": [
"type",
"siteCd",
"objectCd",
"name",
"data",
"expireDatetime"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"status": {
"type": "string",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"status",
"messages",
"timeStamp",
"server"
]
}
}
}Create a new Custom DataPOST/api/v3.1/customData/{type}/{siteOrUserCd}/{objectCd}/{name}{?expireDatetime}
The expireDatetime URL parameter is required. It can not be more than one year in the future.
Example URI
POST https://altairsmartedge.com/api/v3.1/customData/site/cK4Uae73unb72TYuDJDr/BillsCustomApp/USER_DATA?expireDatetime=2017-12-01 00:00:00
URI Parameters
- type
string(required) Example: siteType of Custom Data
- siteOrUserCd
string(required) Example: cK4Uae73unb72TYuDJDrSite or User CD depending on type
- objectCd
string(required) Example: BillsCustomAppAny string the User desires to use to store the data
- name
string(required) Example: USER_DATAA 2nd string the User desires to use to store the data
- expireDatetime
string(required) Example: 2017-12-01 00:00:00Datetime when the custom data expires
Request
Body
"Hello, world!"Schema
{
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"type": "site",
"siteCd": "cK4Uae73unb72TYuDJDr",
"objectCd": "PccGk7RHnf7NHcuFYXLd",
"name": "AppSpecificName",
"data": "Hello World!",
"expireDatetime": "2017-12-01 00:00:00"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_DATA",
"status": "200 OK",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"site",
"user"
],
"description": "Type of Custom Data"
},
"siteCd": {
"type": "string",
"description": "The Site or User CD associated with this CustomData"
},
"objectCd": {
"type": "string",
"description": "A made up unique identifier"
},
"name": {
"type": "string",
"description": "Another unique identifier."
},
"data": {
"type": "string",
"description": "String of custom data saved."
},
"expireDatetime": {
"type": "string",
"description": "Datetime when the custom data expires"
}
},
"required": [
"type",
"siteCd",
"objectCd",
"name",
"data",
"expireDatetime"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"status": {
"type": "string",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"status",
"messages",
"timeStamp",
"server"
]
}
}
}Response
403Forbidden
Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 34003,
"responseType": "JSON",
"responseDataType": "ALTAIR_ADD_CUSTOM_DATA_FAIL",
"status": "403 FORBIDDEN",
"messages": [
{
"id": "responseCustomDataNotFound",
"text": "Custom Data not found, or unauthorized access requested."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"status": {
"type": "string",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"responseCustomDataNotFound"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Custom Data not found, or unauthorized access requested."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"status",
"messages",
"timeStamp",
"server"
]
}
}
}Update a CustomDataPUT/api/v3.1/customData/{type}/{siteOrUserCd}/{objectCd}/{name}{?expireDatetime}
Example URI
PUT https://altairsmartedge.com/api/v3.1/customData/site/cK4Uae73unb72TYuDJDr/BillsCustomApp/USER_DATA?expireDatetime=2017-12-01 00:00:00
URI Parameters
- type
string(required) Example: siteType of Custom Data
- siteOrUserCd
string(required) Example: cK4Uae73unb72TYuDJDrSite or User CD depending on type
- objectCd
string(required) Example: BillsCustomAppAny string the User desires to use to store the data
- name
string(required) Example: USER_DATAA 2nd string the User desires to use to store the data
- expireDatetime
string(required) Example: 2017-12-01 00:00:00Datetime when the custom data expires
Request
Body
"Hello, world!"Schema
{
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"type": "site",
"siteCd": "cK4Uae73unb72TYuDJDr",
"objectCd": "PccGk7RHnf7NHcuFYXLd",
"name": "AppSpecificName",
"data": "Hello World!",
"expireDatetime": "2017-12-01 00:00:00"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_DATA",
"status": "200 OK",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"site",
"user"
],
"description": "Type of Custom Data"
},
"siteCd": {
"type": "string",
"description": "The Site or User CD associated with this CustomData"
},
"objectCd": {
"type": "string",
"description": "A made up unique identifier"
},
"name": {
"type": "string",
"description": "Another unique identifier."
},
"data": {
"type": "string",
"description": "String of custom data saved."
},
"expireDatetime": {
"type": "string",
"description": "Datetime when the custom data expires"
}
},
"required": [
"type",
"siteCd",
"objectCd",
"name",
"data",
"expireDatetime"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"status": {
"type": "string",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"status",
"messages",
"timeStamp",
"server"
]
}
}
}Response
403Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 34003,
"responseType": "JSON",
"responseDataType": "ALTAIR_ADD_CUSTOM_DATA_FAIL",
"status": "403 FORBIDDEN",
"messages": [
{
"id": "responseCustomDataNotFound",
"text": "Custom Data not found, or unauthorized access requested."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"status": {
"type": "string",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"responseCustomDataNotFound"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Custom Data not found, or unauthorized access requested."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"status",
"messages",
"timeStamp",
"server"
]
}
}
}Delete a CustomDataDELETE/api/v3.1/customData/{type}/{siteOrUserCd}/{objectCd}/{name}
Example URI
DELETE https://altairsmartedge.com/api/v3.1/customData/site/cK4Uae73unb72TYuDJDr/BillsCustomApp/USER_DATA
URI Parameters
- type
string(required) Example: siteType of Custom Data
- siteOrUserCd
string(required) Example: cK4Uae73unb72TYuDJDrSite or User CD depending on type
- objectCd
string(required) Example: BillsCustomAppAny string the User desires to use to store the data
- name
string(required) Example: USER_DATAA 2nd string the User desires to use to store the data
Response
204Headers
Content-Type: application/jsonResponse
403Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 34003,
"responseType": "JSON",
"responseDataType": "ALTAIR_ADD_CUSTOM_DATA_FAIL",
"status": "403 FORBIDDEN",
"messages": [
{
"id": "responseCustomDataNotFound",
"text": "Custom Data not found, or unauthorized access requested."
}
],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"status": {
"type": "string",
"description": "HTTP status code that was returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"responseCustomDataNotFound"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"Custom Data not found, or unauthorized access requested."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"status",
"messages",
"timeStamp",
"server"
]
}
}
}Custom Fields ¶
Custom Fields List ¶
Get Custom Fields ListGET/api/v3.1/companies/{companyCd}/customFields/{?editParameters,limit,page,fieldType,filter}
Get the Custom Fields list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Custom Fields
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/?editParameters=false&limit=100&page=1&fieldType=CFT_CUSTOM_LABEL&filter=text
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- fieldType
string(optional) Example: CFT_CUSTOM_LABELFilters results by Field Type
- filter
string(optional) Example: textFilters results by matching text in fields: Label
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"customFieldCd": "a1psH6Z5g3968ESe449K",
"companyCd": "H6Z5Ea1psSe449Kg3968",
"target": {
"type": "OT_PRODUCT_TYPE",
"cd": "68ESe449Ka1psH6Z5g39"
},
"field": {
"type": "CFT_STRING",
"defaultValue": "myValue",
"validation": "/^[a-z]{0,6}$/",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false,
"editParameters": {
"customFieldCd": {
"fieldName": "customFieldCd",
"view": "read",
"type": "string",
"required": false,
"label": "Custom Field CD",
"labelPlural": "Custom Field CDs",
"help": "Unique identifier for the Custom Field."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"target": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Target Type",
"labelPlural": "Target Types",
"help": "Object Type of the Target."
},
"cd": {
"fieldName": "cd",
"view": "write",
"type": "string",
"required": false,
"label": "Target CD",
"labelPlural": "Target CDs",
"help": "Unique identifier of the Target Object."
}
},
"field": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Field Type",
"labelPlural": "Field Types",
"help": "Type of Field for the Custom Field."
},
"defaultValue": {
"fieldName": "defaultValue",
"view": "write",
"type": "string",
"required": false,
"label": "Default Value",
"labelPlural": "Default Values",
"help": "Default Value for the Custom Field."
},
"validation": {
"fieldName": "validation",
"view": "write",
"type": "string",
"required": false,
"label": "Validation Regex",
"labelPlural": "Validation Regex",
"help": "Validation Regex for the Custom Field."
},
"help": {
"fieldName": "help",
"view": "write",
"type": "string",
"required": false,
"label": "Help",
"labelPlural": "Help",
"help": "Help Text for the Custom Field."
}
},
"label": {
"fieldName": "label",
"view": "write",
"type": "string",
"required": true,
"label": "Label",
"labelPlural": "Labels",
"help": "Unique label for the Custom Field."
},
"labelPlural": {
"fieldName": "labelPlural",
"view": "write",
"type": "string",
"required": false,
"label": "Label Plural",
"labelPlural": "Label Plural",
"help": "Unique label in plural for the Custom Field."
},
"propertyName": {
"fieldName": "propertyName",
"view": "write",
"type": "string",
"required": true,
"label": "Property Name",
"labelPlural": "Property Names",
"help": "Unique property name for the Custom Field."
},
"required": {
"fieldName": "required",
"view": "write",
"type": "boolean",
"required": false,
"label": "Required",
"labelPlural": "Required",
"help": "Is the Custom Field required?"
}
}
},
{
"customFieldCd": "a1psH6Z5g3968ESe449K",
"companyCd": "H6Z5Ea1psSe449Kg3968",
"target": {
"type": "OT_PRODUCT_TYPE",
"cd": "68ESe449Ka1psH6Z5g39"
},
"field": {
"type": "CFT_ARRAY_ONE_OF",
"options": [
{
"value": "KEY1",
"text": "Display Text 1"
}
],
"defaultValue": "myValue",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false,
"editParameters": {
"customFieldCd": {
"fieldName": "customFieldCd",
"view": "read",
"type": "string",
"required": false,
"label": "Custom Field CD",
"labelPlural": "Custom Field CDs",
"help": "Unique identifier for the Custom Field."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"target": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Target Type",
"labelPlural": "Target Types",
"help": "Object Type of the Target."
},
"cd": {
"fieldName": "cd",
"view": "write",
"type": "string",
"required": false,
"label": "Target CD",
"labelPlural": "Target CDs",
"help": "Unique identifier of the Target Object."
}
},
"field": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Field Type",
"labelPlural": "Field Types",
"help": "Type of Field for the Custom Field."
},
"options": {
"fieldName": "options",
"view": "write",
"type": "array",
"required": false,
"label": "Options",
"labelPlural": "Options",
"help": "Options for Array Types."
},
"defaultValue": {
"fieldName": "defaultValue",
"view": "write",
"type": "string",
"required": false,
"label": "Default Value",
"labelPlural": "Default Values",
"help": "Default Value for the Custom Field."
},
"help": {
"fieldName": "help",
"view": "write",
"type": "string",
"required": false,
"label": "Help",
"labelPlural": "Help",
"help": "Help Text for the Custom Field."
}
},
"label": {
"fieldName": "label",
"view": "write",
"type": "string",
"required": true,
"label": "Label",
"labelPlural": "Labels",
"help": "Unique label for the Custom Field."
},
"labelPlural": {
"fieldName": "labelPlural",
"view": "write",
"type": "string",
"required": false,
"label": "Label Plural",
"labelPlural": "Label Plural",
"help": "Unique label in plural for the Custom Field."
},
"propertyName": {
"fieldName": "propertyName",
"view": "write",
"type": "string",
"required": true,
"label": "Property Name",
"labelPlural": "Property Names",
"help": "Unique property name for the Custom Field."
},
"required": {
"fieldName": "required",
"view": "write",
"type": "boolean",
"required": false,
"label": "Required",
"labelPlural": "Required",
"help": "Is the Custom Field required?"
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Clone Custom FieldsGET/api/v3.1/companies/{companyCd}/customFields/actions/clone{?customFieldCds,companyCds,number}
Clone specified Custom Fields to specified Companies.
- Types of Responses
- Response 200 - Clone successful - body contains array of Custom Field identifiers
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/actions/clone?customFieldCds=72TYuDJDrcK4Uae73unb&companyCds=b72TYuDJDrcK4Uae73un&number=1
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- customFieldCds
string(required) Example: 72TYuDJDrcK4Uae73unbComma separated list of Custom Field CDs to clone
- companyCds
string(required) Example: b72TYuDJDrcK4Uae73unComma separated list of Company CDs to clone to
- number
number(optional) Default: 1 Example: 1Number of times to clone per company
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"customFieldCd": "3unb72TYucK4Uae7DJDr",
"companyCd": "6hnb72K4Uadf4re7DJDr",
"label": "Cloned Custom Field Label",
"propertyName": "Cloned Custom Field Property Name"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_CUSTOM_FIELD_CLONE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"enum": [
"3unb72TYucK4Uae7DJDr"
],
"description": "CD of the Custom Field"
},
"companyCd": {
"type": "string",
"enum": [
"6hnb72K4Uadf4re7DJDr"
],
"description": "CD of the Company"
},
"label": {
"type": "string",
"enum": [
"Cloned Custom Field Label"
],
"description": "Label of the Custom Field"
},
"propertyName": {
"type": "string",
"enum": [
"Cloned Custom Field Property Name"
],
"description": "Property Name of the Custom Field"
}
},
"required": [
"customFieldCd",
"companyCd",
"label",
"propertyName"
],
"additionalProperties": false
},
"description": "Array of cloned custom fields"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Custom Field ¶
Get Custom FieldGET/api/v3.1/companies/{companyCd}/customFields/{customFieldCd}{?editParameters}
- Types of Responses
- Response 200 - If Custom Field is retrieved
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/a1psH6Z5g3968ESe449K?editParameters=false
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- customFieldCd
string(required) Example: a1psH6Z5g3968ESe449K- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Example CFT_STRING responseResponse
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K",
"companyCd": "H6Z5Ea1psSe449Kg3968",
"target": {
"type": "OT_PRODUCT_TYPE",
"cd": "68ESe449Ka1psH6Z5g39"
},
"field": {
"type": "CFT_STRING",
"defaultValue": "myValue",
"validation": "/^[a-z]{0,6}$/",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false,
"editParameters": {
"customFieldCd": {
"fieldName": "customFieldCd",
"view": "read",
"type": "string",
"required": false,
"label": "Custom Field CD",
"labelPlural": "Custom Field CDs",
"help": "Unique identifier for the Custom Field."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"target": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Target Type",
"labelPlural": "Target Types",
"help": "Object Type of the Target."
},
"cd": {
"fieldName": "cd",
"view": "write",
"type": "string",
"required": false,
"label": "Target CD",
"labelPlural": "Target CDs",
"help": "Unique identifier of the Target Object."
}
},
"field": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Field Type",
"labelPlural": "Field Types",
"help": "Type of Field for the Custom Field."
},
"defaultValue": {
"fieldName": "defaultValue",
"view": "write",
"type": "string",
"required": false,
"label": "Default Value",
"labelPlural": "Default Values",
"help": "Default Value for the Custom Field."
},
"validation": {
"fieldName": "validation",
"view": "write",
"type": "string",
"required": false,
"label": "Validation Regex",
"labelPlural": "Validation Regex",
"help": "Validation Regex for the Custom Field."
},
"help": {
"fieldName": "help",
"view": "write",
"type": "string",
"required": false,
"label": "Help",
"labelPlural": "Help",
"help": "Help Text for the Custom Field."
}
},
"label": {
"fieldName": "label",
"view": "write",
"type": "string",
"required": true,
"label": "Label",
"labelPlural": "Labels",
"help": "Unique label for the Custom Field."
},
"labelPlural": {
"fieldName": "labelPlural",
"view": "write",
"type": "string",
"required": false,
"label": "Label Plural",
"labelPlural": "Label Plural",
"help": "Unique label in plural for the Custom Field."
},
"propertyName": {
"fieldName": "propertyName",
"view": "write",
"type": "string",
"required": true,
"label": "Property Name",
"labelPlural": "Property Names",
"help": "Unique property name for the Custom Field."
},
"required": {
"fieldName": "required",
"view": "write",
"type": "boolean",
"required": false,
"label": "Required",
"labelPlural": "Required",
"help": "Is the Custom Field required?"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "Unique identifier assigned for a Custom Field"
},
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"OT_PRODUCT_TYPE",
"OT_COMPANY",
"OT_PRODUCT",
"OT_SITE",
"OT_USER",
"OT_DEVICE"
],
"description": "Target Object Type for this Custom Field"
},
"cd": {
"type": "string",
"description": "Unique indentifier of the Target Object"
}
},
"required": [
"type"
],
"description": "Custom Field target details"
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CFT_STRING",
"CFT_ARRAY_ANY_OF",
"CFT_ARRAY_ONE_OF",
"CFT_ARRAY_ONE_PLUS_OF",
"CFT_DATE",
"CFT_DATETIME",
"CFT_NUMBER",
"CFT_PASSWORD",
"CFT_READONLY",
"CFT_HIERARCHY",
"CFT_NUMBER_AUTO_INCREMENT"
],
"description": "Field Type for this Custom Field"
},
"defaultValue": {
"type": "string",
"description": "Default value for this Custom Field"
},
"validation": {
"type": "string",
"description": "Validation Regex for this Custom Field"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
],
"description": "Custom Field field details"
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
},
"required": {
"type": "boolean",
"description": "Is this field required?"
},
"editParameters": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"cd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"defaultValue": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"validation": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"help": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"label": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"labelPlural": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"propertyName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"required": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"customFieldCd"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"customFieldCd",
"companyCd",
"label",
"propertyName"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Request
Example CFT_ARRAY_ONE_OF responseResponse
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K",
"companyCd": "H6Z5Ea1psSe449Kg3968",
"target": {
"type": "OT_PRODUCT_TYPE",
"cd": "68ESe449Ka1psH6Z5g39"
},
"field": {
"type": "CFT_ARRAY_ONE_OF",
"options": [
{
"value": "KEY1",
"text": "Display Text 1"
}
],
"defaultValue": "myValue",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false,
"editParameters": {
"customFieldCd": {
"fieldName": "customFieldCd",
"view": "read",
"type": "string",
"required": false,
"label": "Custom Field CD",
"labelPlural": "Custom Field CDs",
"help": "Unique identifier for the Custom Field."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"target": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Target Type",
"labelPlural": "Target Types",
"help": "Object Type of the Target."
},
"cd": {
"fieldName": "cd",
"view": "write",
"type": "string",
"required": false,
"label": "Target CD",
"labelPlural": "Target CDs",
"help": "Unique identifier of the Target Object."
}
},
"field": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Field Type",
"labelPlural": "Field Types",
"help": "Type of Field for the Custom Field."
},
"options": {
"fieldName": "options",
"view": "write",
"type": "array",
"required": false,
"label": "Options",
"labelPlural": "Options",
"help": "Options for Array Types."
},
"defaultValue": {
"fieldName": "defaultValue",
"view": "write",
"type": "string",
"required": false,
"label": "Default Value",
"labelPlural": "Default Values",
"help": "Default Value for the Custom Field."
},
"help": {
"fieldName": "help",
"view": "write",
"type": "string",
"required": false,
"label": "Help",
"labelPlural": "Help",
"help": "Help Text for the Custom Field."
}
},
"label": {
"fieldName": "label",
"view": "write",
"type": "string",
"required": true,
"label": "Label",
"labelPlural": "Labels",
"help": "Unique label for the Custom Field."
},
"labelPlural": {
"fieldName": "labelPlural",
"view": "write",
"type": "string",
"required": false,
"label": "Label Plural",
"labelPlural": "Label Plural",
"help": "Unique label in plural for the Custom Field."
},
"propertyName": {
"fieldName": "propertyName",
"view": "write",
"type": "string",
"required": true,
"label": "Property Name",
"labelPlural": "Property Names",
"help": "Unique property name for the Custom Field."
},
"required": {
"fieldName": "required",
"view": "write",
"type": "boolean",
"required": false,
"label": "Required",
"labelPlural": "Required",
"help": "Is the Custom Field required?"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "Unique identifier assigned for a Custom Field"
},
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"OT_PRODUCT_TYPE",
"OT_COMPANY",
"OT_PRODUCT",
"OT_SITE",
"OT_USER",
"OT_DEVICE"
],
"description": "Target Object Type for this Custom Field"
},
"cd": {
"type": "string",
"description": "Unique indentifier of the Target Object"
}
},
"required": [
"type"
],
"description": "Custom Field target details"
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CFT_ARRAY_ONE_OF",
"CFT_STRING",
"CFT_ARRAY_ANY_OF",
"CFT_ARRAY_ONE_PLUS_OF",
"CFT_DATE",
"CFT_DATETIME",
"CFT_NUMBER",
"CFT_PASSWORD",
"CFT_READONLY",
"CFT_HIERARCHY",
"CFT_NUMBER_AUTO_INCREMENT"
],
"description": "Field Type for this Custom Field"
},
"options": {
"type": "array",
"description": "Options for Array Types"
},
"defaultValue": {
"type": "string",
"description": "Default value for this Custom Field"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
],
"description": "Custom Field field details"
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
},
"required": {
"type": "boolean",
"description": "Is this field required?"
},
"editParameters": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"cd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"options": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"defaultValue": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"help": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"label": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"labelPlural": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"propertyName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"required": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"customFieldCd"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"customFieldCd",
"companyCd",
"label",
"propertyName"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Request
Example CFT_HIERARCHY responseResponse
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K",
"companyCd": "H6Z5Ea1psSe449Kg3968",
"target": {
"type": "OT_DEVICE"
},
"field": {
"type": "CFT_HIERARCHY",
"levels": [
{
"id": "KEY1",
"name": "Display Text 1",
"parentId": "top"
},
{
"id": "KEY2",
"name": "Display Text 2",
"parentId": "top",
"level": [
{
"id": "KEY1-CHILD",
"name": "Display Text Child 1",
"parentId": "KEY1"
},
{
"id": "KEY2-CHILD",
"name": "Display Text Child 2",
"parentId": "KEY2"
}
]
},
{
"id": "KEY3",
"name": "Display Text 3",
"parentId": "top"
}
],
"defaultValue": "myValue",
"implementsSecurity": "false",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false,
"editParameters": {
"customFieldCd": {
"fieldName": "customFieldCd",
"view": "read",
"type": "string",
"required": false,
"label": "Custom Field CD",
"labelPlural": "Custom Field CDs",
"help": "Unique identifier for the Custom Field."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"target": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Target Type",
"labelPlural": "Target Types",
"help": "Object Type of the Target."
},
"cd": {
"fieldName": "cd",
"view": "write",
"type": "string",
"required": false,
"label": "Target CD",
"labelPlural": "Target CDs",
"help": "Unique identifier of the Target Object."
}
},
"field": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Field Type",
"labelPlural": "Field Types",
"help": "Type of Field for the Custom Field."
},
"levels": {
"fieldName": "levels",
"view": "write",
"type": "array",
"required": false,
"label": "Levels",
"labelPlural": "Levels",
"help": "Levels for Hierarchy Types."
},
"defaultValue": {
"fieldName": "defaultValue",
"view": "write",
"type": "string",
"required": false,
"label": "Default Value",
"labelPlural": "Default Values",
"help": "Default Value for the Custom Field."
},
"implementsSecurity": {
"fieldName": "implementsSecurity",
"view": "write",
"type": "boolean",
"required": false,
"label": "Implements Security",
"labelPlural": "Implements Security",
"help": "Does the Custom Field implement security."
},
"help": {
"fieldName": "help",
"view": "write",
"type": "string",
"required": false,
"label": "Help",
"labelPlural": "Help",
"help": "Help Text for the Custom Field."
}
},
"label": {
"fieldName": "label",
"view": "write",
"type": "string",
"required": true,
"label": "Label",
"labelPlural": "Labels",
"help": "Unique label for the Custom Field."
},
"labelPlural": {
"fieldName": "labelPlural",
"view": "write",
"type": "string",
"required": false,
"label": "Label Plural",
"labelPlural": "Label Plural",
"help": "Unique label in plural for the Custom Field."
},
"propertyName": {
"fieldName": "propertyName",
"view": "write",
"type": "string",
"required": true,
"label": "Property Name",
"labelPlural": "Property Names",
"help": "Unique property name for the Custom Field."
},
"required": {
"fieldName": "required",
"view": "write",
"type": "boolean",
"required": false,
"label": "Required",
"labelPlural": "Required",
"help": "Is the Custom Field required?"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "Unique identifier assigned for a Custom Field"
},
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"OT_DEVICE",
"OT_PRODUCT_TYPE",
"OT_COMPANY",
"OT_PRODUCT",
"OT_SITE",
"OT_USER"
],
"description": "Target Object Type for this Custom Field"
}
},
"required": [
"type"
],
"description": "Custom Field target details"
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CFT_HIERARCHY",
"CFT_ARRAY_ONE_OF",
"CFT_STRING",
"CFT_ARRAY_ANY_OF",
"CFT_ARRAY_ONE_PLUS_OF",
"CFT_DATE",
"CFT_DATETIME",
"CFT_NUMBER",
"CFT_PASSWORD",
"CFT_READONLY",
"CFT_NUMBER_AUTO_INCREMENT"
],
"description": "Field Type for this Custom Field"
},
"levels": {
"type": "array",
"description": "Options for Array Types"
},
"defaultValue": {
"type": "string",
"description": "Default value for this Custom Field"
},
"implementsSecurity": {
"type": "string",
"description": "Does this Custom Field implement Security?"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
],
"description": "Custom Field field details"
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
},
"required": {
"type": "boolean",
"description": "Is this field required?"
},
"editParameters": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"cd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"levels": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"defaultValue": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"implementsSecurity": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"help": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"label": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"labelPlural": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"propertyName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"required": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"customFieldCd"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"customFieldCd",
"companyCd",
"label",
"propertyName"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Create a new Custom FieldPOST/api/v3.1/companies/{companyCd}/customFields/{?editParameters}
When requesting editParameters in the return the complete Custom Field object will be returned.
The target object OT_DEVICE can only be used with the field type CFT_HIERARCHY and vice versa.
- Types of Responses
- Response 200 - Update successful - customFieldCd returned in body
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/?editParameters=false
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
String TypeBody
{
"target": {
"type": "OT_PRODUCT_TYPE",
"cd": "68ESe449Ka1psH6Z5g39"
},
"field": {
"type": "CFT_STRING",
"defaultValue": "myValue",
"validation": "/^[a-z]{0,6}$/",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false
}Schema
{
"type": "object",
"properties": {
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Target Object Type for this Custom Field"
},
"cd": {
"type": "string",
"description": "Unique indentifier of the Target Object"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Field Type for this Custom Field"
},
"defaultValue": {
"type": "string",
"description": "Default value for this Custom Field"
},
"validation": {
"type": "string",
"description": "Validation Regex for this Custom Field"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
]
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
},
"required": {
"type": "boolean",
"description": "Is this field required?"
}
},
"required": [
"label",
"propertyName"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "The Custom Field CD"
}
},
"required": [
"customFieldCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Request
Array TypeBody
{
"target": {
"type": "OT_PRODUCT_TYPE",
"cd": "68ESe449Ka1psH6Z5g39"
},
"field": {
"type": "CFT_ARRAY_ANY_OF",
"options": [
{
"value": "KEY1",
"text": "Display Text 1"
}
],
"defaultValue": "myValue",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false
}Schema
{
"type": "object",
"properties": {
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Target Object Type for this Custom Field"
},
"cd": {
"type": "string",
"description": "Unique indentifier of the Target Object"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Field Type for this Custom Field"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Option value"
},
"text": {
"type": "string",
"description": "Option text"
}
},
"required": [
"value",
"text"
]
},
"description": "Options for Array Types"
},
"defaultValue": {
"type": "string",
"description": "Default value for this Custom Field"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
]
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
},
"required": {
"type": "boolean",
"description": "Is this field required?"
}
},
"required": [
"label",
"propertyName"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "The Custom Field CD"
}
},
"required": [
"customFieldCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Request
Hierarchy TypeBody
{
"target": {
"type": "OT_DEVICE"
},
"field": {
"type": "CFT_HIERARCHY",
"levels": [
{
"id": "KEY1",
"name": "Display Text 1",
"parentId": "top"
},
{
"id": "KEY2",
"name": "Display Text 2",
"parentId": "top",
"level": [
{
"id": "KEY1-CHILD",
"name": "Display Text Child 1",
"parentId": "KEY1"
},
{
"id": "KEY2-CHILD",
"name": "Display Text Child 2",
"parentId": "KEY2"
}
]
},
{
"id": "KEY3",
"name": "Display Text 3",
"parentId": "top"
}
],
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false
}Schema
{
"type": "object",
"properties": {
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Target Object Type for this Custom Field"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Field Type for this Custom Field"
},
"levels": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Level id"
},
"name": {
"type": "string",
"description": "Level name"
},
"parentId": {
"type": "string",
"description": "Parent id"
}
},
"required": [
"id",
"name",
"parentId"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Level id"
},
"name": {
"type": "string",
"description": "Level name"
},
"parentId": {
"type": "string",
"description": "Parent id"
},
"level": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Level id"
},
"name": {
"type": "string",
"description": "Level name"
},
"parentId": {
"type": "string",
"description": "Parent id"
}
},
"required": [
"id",
"name",
"parentId"
]
},
"description": "Levels"
}
},
"required": [
"id",
"name",
"parentId"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Level id"
},
"name": {
"type": "string",
"description": "Level name"
},
"parentId": {
"type": "string",
"description": "Parent id"
}
},
"required": [
"id",
"name",
"parentId"
]
}
]
},
"description": "Levels for Hierarchy"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
]
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
},
"required": {
"type": "boolean",
"description": "Is this field required?"
}
},
"required": [
"label",
"propertyName"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "The Custom Field CD"
}
},
"required": [
"customFieldCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Request
Custom Product Template TypeBody
{
"target": {
"type": "OT_PRODUCT",
"cd": "psH6Z5g3968ESe449Ka1"
},
"field": {
"type": "CFT_CUSTOM_PRODUCT_TEMPLATE",
"customLabels": [
"49Ka139pH6Se4Z5gs68E",
"4aH6p819Se4Z5g3KsE96"
],
"globalLabels": [
"6Se4Z49Ka139pH5gs68E",
"Se4Z5g34aH6p819KsE96"
],
"vendorId": 500,
"modelNameRegex": "/pattern/",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels"
}Schema
{
"type": "object",
"properties": {
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Target Object Type for this Custom Field"
},
"cd": {
"type": "string",
"description": "Unique indentifier of the Target Object"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Field Type for this Custom Field"
},
"customLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom Labels to Add to Product"
},
"globalLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Global Labels to Add to Product"
},
"vendorId": {
"type": "number",
"description": "The BACnet Vendor ID"
},
"modelNameRegex": {
"type": "string",
"description": "Regular expression for matching BACnet model name"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
]
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
}
},
"required": [
"label"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "The Custom Field CD"
}
},
"required": [
"customFieldCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Request
Custom Label TypeBody
{
"dataLabel": "DL_CUSTOM_LABEL_1",
"type": "CFT_CUSTOM_LABEL",
"dataType": "FAHRENHEIT",
"dataTypeOption": [],
"help": "This field is for...",
"label": "My Field Label",
"labelPlural": "My Field Labels"
}Schema
{
"type": "object",
"properties": {
"dataLabel": {
"type": "string",
"description": "Custom Data Type Tag"
},
"type": {
"type": "string",
"description": "Field Type for this Custom Field"
},
"dataType": {
"enum": [
"FAHRENHEIT",
"STRING",
"FLOAT",
"INTEGER",
"BOOLEAN",
"PERCENT",
"CELSIUS",
"ENUM"
],
"description": "Data Type"
},
"dataTypeOption": {
"type": "array",
"description": "Data Type Option"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
}
},
"required": [
"dataLabel",
"type",
"label"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "The Custom Field CD"
}
},
"required": [
"customFieldCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Request
Number Auto Increment TypeBody
{
"target": {
"type": "OT_SITE",
"cd": "H6Ka196Z5g3e4498ESps"
},
"field": {
"type": "CFT_NUMBER_AUTO_INCREMENT",
"defaultValue": "0",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey"
}Schema
{
"type": "object",
"properties": {
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Target Object Type for this Custom Field"
},
"cd": {
"type": "string",
"description": "Unique indentifier of the Target Object"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Field Type for this Custom Field"
},
"defaultValue": {
"type": "string",
"description": "Default start value for this Custom Field"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
]
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
}
},
"required": [
"label",
"propertyName"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "The Custom Field CD"
}
},
"required": [
"customFieldCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Update a Custom FieldPUT/api/v3.1/companies/{companyCd}/customFields/{customFieldCd}{?editParameters}
Only send in data that is changed
When requesting editParameters in the return the complete Custom Field object will be returned.
- Types of Responses
- Response 200 - Update successful - customFieldCd returned in body
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/a1psH6Z5g3968ESe449K?editParameters=false
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- customFieldCd
string(required) Example: a1psH6Z5g3968ESe449K- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"label": "My New Field Label",
"propertyName": "myNewFieldKey"
}Schema
{
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
}
},
"required": [
"label",
"propertyName"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "The Custom Field CD"
}
},
"required": [
"customFieldCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Delete a Custom FieldDELETE/api/v3.1/companies/{companyCd}/customFields/{customFieldCd}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/a1psH6Z5g3968ESe449K
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- customFieldCd
string(required) Example: a1psH6Z5g3968ESe449K
Response
204Headers
Content-Type: application/jsonActions ¶
Clone Custom FieldGET/api/v3.1/companies/{companyCd}/customFields/{customFieldCd}/actions/clone{?companyCds,number}
Clone the Custom Field to specified Companies.
- Types of Responses
- Response 200 - Clone successful - body contains array of Custom Field identifiers
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/4Uae73unb72TYuDJDrcK/actions/clone?companyCds=b72TYuDJDrcK4Uae73un&number=1
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- customFieldCd
string(required) Example: 4Uae73unb72TYuDJDrcK- companyCds
string(required) Example: b72TYuDJDrcK4Uae73unComma separated list of Company CDs to clone to
- number
number(optional) Default: 1 Example: 1Number of times to clone
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"customFieldCd": "3unb72TYucK4Uae7DJDr",
"companyCd": "6hnb72K4Uadf4re7DJDr",
"label": "Cloned Custom Field Label",
"propertyName": "Cloned Custom Field Property Name"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_CUSTOM_FIELD_CLONE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"enum": [
"3unb72TYucK4Uae7DJDr"
],
"description": "CD of the Custom Field"
},
"companyCd": {
"type": "string",
"enum": [
"6hnb72K4Uadf4re7DJDr"
],
"description": "CD of the Company"
},
"label": {
"type": "string",
"enum": [
"Cloned Custom Field Label"
],
"description": "Label of the Custom Field"
},
"propertyName": {
"type": "string",
"enum": [
"Cloned Custom Field Property Name"
],
"description": "Property Name of the Custom Field"
}
},
"required": [
"customFieldCd",
"companyCd",
"label",
"propertyName"
],
"additionalProperties": false
},
"description": "Array of cloned custom fields"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Add Hierarchy LevelPOST/api/v3.1/companies/{companyCd}/customFields/{customFieldCd}/actions/addLevel
Add a Level to the Hierarchy.
- Types of Responses
- Response 200 - Successful
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/4Uae73unb72TYuDJDrcK/actions/addLevel
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- customFieldCd
string(required) Example: 4Uae73unb72TYuDJDrcK
Request
Body
{
"id": "newLevelId",
"name": "My New Level Name",
"parentId": "top"
}Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Level Id for Custom Field Hierarchy Level"
},
"name": {
"type": "string",
"description": "Level Name for Custom Field Hierarchy Level"
},
"parentId": {
"type": "string",
"description": "Parent Id for Custom Field Hierarchy Level"
}
},
"required": [
"id",
"name",
"parentId"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K",
"companyCd": "H6Z5Ea1psSe449Kg3968",
"target": {
"type": "OT_DEVICE"
},
"field": {
"type": "CFT_HIERARCHY",
"levels": [
{
"id": "KEY1",
"name": "Display Text 1",
"parentId": "top"
},
{
"id": "KEY2",
"name": "Display Text 2",
"parentId": "top",
"level": [
{
"id": "KEY1-CHILD",
"name": "Display Text Child 1",
"parentId": "KEY1"
},
{
"id": "KEY2-CHILD",
"name": "Display Text Child 2",
"parentId": "KEY2"
}
]
},
{
"id": "KEY3",
"name": "Display Text 3",
"parentId": "top"
}
],
"defaultValue": "myValue",
"implementsSecurity": "false",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false,
"editParameters": {
"customFieldCd": {
"fieldName": "customFieldCd",
"view": "read",
"type": "string",
"required": false,
"label": "Custom Field CD",
"labelPlural": "Custom Field CDs",
"help": "Unique identifier for the Custom Field."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"target": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Target Type",
"labelPlural": "Target Types",
"help": "Object Type of the Target."
},
"cd": {
"fieldName": "cd",
"view": "write",
"type": "string",
"required": false,
"label": "Target CD",
"labelPlural": "Target CDs",
"help": "Unique identifier of the Target Object."
}
},
"field": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Field Type",
"labelPlural": "Field Types",
"help": "Type of Field for the Custom Field."
},
"levels": {
"fieldName": "levels",
"view": "write",
"type": "array",
"required": false,
"label": "Levels",
"labelPlural": "Levels",
"help": "Levels for Hierarchy Types."
},
"defaultValue": {
"fieldName": "defaultValue",
"view": "write",
"type": "string",
"required": false,
"label": "Default Value",
"labelPlural": "Default Values",
"help": "Default Value for the Custom Field."
},
"implementsSecurity": {
"fieldName": "implementsSecurity",
"view": "write",
"type": "boolean",
"required": false,
"label": "Implements Security",
"labelPlural": "Implements Security",
"help": "Does the Custom Field implement security."
},
"help": {
"fieldName": "help",
"view": "write",
"type": "string",
"required": false,
"label": "Help",
"labelPlural": "Help",
"help": "Help Text for the Custom Field."
}
},
"label": {
"fieldName": "label",
"view": "write",
"type": "string",
"required": true,
"label": "Label",
"labelPlural": "Labels",
"help": "Unique label for the Custom Field."
},
"labelPlural": {
"fieldName": "labelPlural",
"view": "write",
"type": "string",
"required": false,
"label": "Label Plural",
"labelPlural": "Label Plural",
"help": "Unique label in plural for the Custom Field."
},
"propertyName": {
"fieldName": "propertyName",
"view": "write",
"type": "string",
"required": true,
"label": "Property Name",
"labelPlural": "Property Names",
"help": "Unique property name for the Custom Field."
},
"required": {
"fieldName": "required",
"view": "write",
"type": "boolean",
"required": false,
"label": "Required",
"labelPlural": "Required",
"help": "Is the Custom Field required?"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "Unique identifier assigned for a Custom Field"
},
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"OT_DEVICE",
"OT_PRODUCT_TYPE",
"OT_COMPANY",
"OT_PRODUCT",
"OT_SITE",
"OT_USER"
],
"description": "Target Object Type for this Custom Field"
}
},
"required": [
"type"
],
"description": "Custom Field target details"
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CFT_HIERARCHY",
"CFT_ARRAY_ONE_OF",
"CFT_STRING",
"CFT_ARRAY_ANY_OF",
"CFT_ARRAY_ONE_PLUS_OF",
"CFT_DATE",
"CFT_DATETIME",
"CFT_NUMBER",
"CFT_PASSWORD",
"CFT_READONLY",
"CFT_NUMBER_AUTO_INCREMENT"
],
"description": "Field Type for this Custom Field"
},
"levels": {
"type": "array",
"description": "Options for Array Types"
},
"defaultValue": {
"type": "string",
"description": "Default value for this Custom Field"
},
"implementsSecurity": {
"type": "string",
"description": "Does this Custom Field implement Security?"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
],
"description": "Custom Field field details"
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
},
"required": {
"type": "boolean",
"description": "Is this field required?"
},
"editParameters": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"cd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"levels": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"defaultValue": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"implementsSecurity": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"help": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"label": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"labelPlural": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"propertyName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"required": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"customFieldCd"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"customFieldCd",
"companyCd",
"label",
"propertyName"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Update Hierarchy LevelPUT/api/v3.1/companies/{companyCd}/customFields/{customFieldCd}/actions/updateLevel{?levelId}
Update a Level of the Hierarchy. By passing in a new parentId the level can be moved.
- Types of Responses
- Response 200 - Successful
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/4Uae73unb72TYuDJDrcK/actions/updateLevel?levelId=levelIdToUpdate
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- customFieldCd
string(required) Example: 4Uae73unb72TYuDJDrcK- levelId
string(required) Example: levelIdToUpdate
Request
Body
{
"name": "My New Level Name",
"parentId": "top"
}Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Level Name for Custom Field Hierarchy Level"
},
"parentId": {
"type": "string",
"description": "Parent Id for Custom Field Hierarchy Level"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"customFieldCd": "a1psH6Z5g3968ESe449K",
"companyCd": "H6Z5Ea1psSe449Kg3968",
"target": {
"type": "OT_DEVICE"
},
"field": {
"type": "CFT_HIERARCHY",
"levels": [
{
"id": "KEY1",
"name": "Display Text 1",
"parentId": "top"
},
{
"id": "KEY2",
"name": "Display Text 2",
"parentId": "top",
"level": [
{
"id": "KEY1-CHILD",
"name": "Display Text Child 1",
"parentId": "KEY1"
},
{
"id": "KEY2-CHILD",
"name": "Display Text Child 2",
"parentId": "KEY2"
}
]
},
{
"id": "KEY3",
"name": "Display Text 3",
"parentId": "top"
}
],
"defaultValue": "myValue",
"implementsSecurity": "false",
"help": "This field is for..."
},
"label": "My Field Label",
"labelPlural": "My Field Labels",
"propertyName": "myFieldKey",
"required": false,
"editParameters": {
"customFieldCd": {
"fieldName": "customFieldCd",
"view": "read",
"type": "string",
"required": false,
"label": "Custom Field CD",
"labelPlural": "Custom Field CDs",
"help": "Unique identifier for the Custom Field."
},
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"target": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Target Type",
"labelPlural": "Target Types",
"help": "Object Type of the Target."
},
"cd": {
"fieldName": "cd",
"view": "write",
"type": "string",
"required": false,
"label": "Target CD",
"labelPlural": "Target CDs",
"help": "Unique identifier of the Target Object."
}
},
"field": {
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Field Type",
"labelPlural": "Field Types",
"help": "Type of Field for the Custom Field."
},
"levels": {
"fieldName": "levels",
"view": "write",
"type": "array",
"required": false,
"label": "Levels",
"labelPlural": "Levels",
"help": "Levels for Hierarchy Types."
},
"defaultValue": {
"fieldName": "defaultValue",
"view": "write",
"type": "string",
"required": false,
"label": "Default Value",
"labelPlural": "Default Values",
"help": "Default Value for the Custom Field."
},
"implementsSecurity": {
"fieldName": "implementsSecurity",
"view": "write",
"type": "boolean",
"required": false,
"label": "Implements Security",
"labelPlural": "Implements Security",
"help": "Does the Custom Field implement security."
},
"help": {
"fieldName": "help",
"view": "write",
"type": "string",
"required": false,
"label": "Help",
"labelPlural": "Help",
"help": "Help Text for the Custom Field."
}
},
"label": {
"fieldName": "label",
"view": "write",
"type": "string",
"required": true,
"label": "Label",
"labelPlural": "Labels",
"help": "Unique label for the Custom Field."
},
"labelPlural": {
"fieldName": "labelPlural",
"view": "write",
"type": "string",
"required": false,
"label": "Label Plural",
"labelPlural": "Label Plural",
"help": "Unique label in plural for the Custom Field."
},
"propertyName": {
"fieldName": "propertyName",
"view": "write",
"type": "string",
"required": true,
"label": "Property Name",
"labelPlural": "Property Names",
"help": "Unique property name for the Custom Field."
},
"required": {
"fieldName": "required",
"view": "write",
"type": "boolean",
"required": false,
"label": "Required",
"labelPlural": "Required",
"help": "Is the Custom Field required?"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_CUSTOM_FIELD",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "string",
"description": "Unique identifier assigned for a Custom Field"
},
"companyCd": {
"type": "string",
"description": "Unique identifier assigned for a Company"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"OT_DEVICE",
"OT_PRODUCT_TYPE",
"OT_COMPANY",
"OT_PRODUCT",
"OT_SITE",
"OT_USER"
],
"description": "Target Object Type for this Custom Field"
}
},
"required": [
"type"
],
"description": "Custom Field target details"
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CFT_HIERARCHY",
"CFT_ARRAY_ONE_OF",
"CFT_STRING",
"CFT_ARRAY_ANY_OF",
"CFT_ARRAY_ONE_PLUS_OF",
"CFT_DATE",
"CFT_DATETIME",
"CFT_NUMBER",
"CFT_PASSWORD",
"CFT_READONLY",
"CFT_NUMBER_AUTO_INCREMENT"
],
"description": "Field Type for this Custom Field"
},
"levels": {
"type": "array",
"description": "Options for Array Types"
},
"defaultValue": {
"type": "string",
"description": "Default value for this Custom Field"
},
"implementsSecurity": {
"type": "string",
"description": "Does this Custom Field implement Security?"
},
"help": {
"type": "string",
"description": "Help for this Custom Field"
}
},
"required": [
"type"
],
"description": "Custom Field field details"
},
"label": {
"type": "string",
"description": "Display label for the Custom Field"
},
"labelPlural": {
"type": "string",
"description": "Display label in plural for the Custom Field"
},
"propertyName": {
"type": "string",
"description": "Property Name for the Custom Field"
},
"required": {
"type": "boolean",
"description": "Is this field required?"
},
"editParameters": {
"type": "object",
"properties": {
"customFieldCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"target": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"cd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"field": {
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "oneOf",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"levels": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object"
],
"default": "array",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"defaultValue": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"implementsSecurity": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"help": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"type"
]
},
"label": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"labelPlural": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"propertyName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"required": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"customFieldCd"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"customFieldCd",
"companyCd",
"label",
"propertyName"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Delete Hierarchy LevelDELETE/api/v3.1/companies/{companyCd}/customFields/{customFieldCd}/actions/deleteLevel{?levelId}
Delete a Level of the Hierarchy.
- Types of Responses
- Response 204 - Successful
See also: Global Failures
Example URI
DELETE https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/4Uae73unb72TYuDJDrcK/actions/deleteLevel?levelId=levelIdToDelete
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- customFieldCd
string(required) Example: 4Uae73unb72TYuDJDrcK- levelId
string(required) Example: levelIdToDelete
Response
204Headers
Content-Type: application/jsonGet Next IDsGET/api/v3.1/companies/{companyCd}/customFields/{customFieldCd}/actions/getNextIds{?number}
Get the next X number of auto generated IDs for the target object of this custom field. Only applicable to CFT_NUMBER_AUTO_INCREMENT types.
If ‘number’ is omitted from the query then only 1 will be returned. A maximum of 20 IDs can be requested.
The last generated ID is stored on the target object as a custom field and is returned (read-only) in the API object.
- Types of Responses
- Response 200 - Successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/customFields/4Uae73unb72TYuDJDrcK/actions/getNextIds?number=1
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- customFieldCd
string(required) Example: 4Uae73unb72TYuDJDrcK- number
number(optional) Example: 1
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
"1"
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_GET_NEXT_IDS",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Array of IDs"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Reports ¶
Reports List ¶
Reports list description
Get Reports ListGET/api/v3.1/reports{?editParameters,limit,page}
Get the Reports list.
Notice the limit and page parameters for limiting and paging through a potentially large Rules list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Rules for this Site
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/reports?editParameters=false&limit=100&page=1
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"reportCd": "rh6d3SKxM25AO4oyfjfb",
"type": "REPORT_INTERVAL_DATA_CSV",
"parameters": {
"siteCd": [
"sc0130Y8wN4hpg2h64wd"
],
"startDate": "2017-03-28",
"endDate": "2017-03-29",
"interval": "UD_INC_15MIN",
"usageType": "UD_DTYPE_KWH"
},
"name": "Report Name",
"fileName": "ReportFileName.csv",
"state": "REPORT_STATE_INCOMPLETE",
"errors": [],
"runDatetime": "2017-04-03 14:20:27 UTC",
"expireDatetime": "2017-04-17 14:20:27 UTC",
"auditDatetime": "2017-04-03 14:20:27",
"user": {
"userCd": "sc2h64wd0130Y8wN4hpg",
"name": "Report User"
},
"editParameters": {
"reportCd": {
"fieldName": "reportCd",
"view": "read",
"type": "string",
"required": true,
"label": "Report CD",
"labelPlural": "Report CDs",
"help": "Unique identifier for the Report."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Type of the Report.",
"options": [
{
"text": "Interval Data Report CSV",
"value": "REPORT_INTERVAL_DATA_CSV"
},
{
"text": "eGauge Audit Report CSV",
"value": "REPORT_AUDIT_CSV"
}
]
},
"parameters": {
"siteCd": {
"fieldName": "siteCd",
"view": "write",
"type": "onePlusOf",
"required": true,
"label": "Site CD",
"labelPlural": "Site CDs",
"help": "Site CDs to run report against."
},
"startDate": {
"fieldName": "startDate",
"view": "write",
"type": "string",
"required": true,
"label": "Start Date",
"labelPlural": "Start Dates",
"help": "Start Date in YYYY-MM-DD format."
},
"endDate": {
"fieldName": "endDate",
"view": "write",
"type": "string",
"required": true,
"label": "End Date",
"labelPlural": "End Dates",
"help": "End Date in YYYY-MM-DD format."
},
"interval": {
"fieldName": "interval",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Interval",
"labelPlural": "Intervals",
"help": "Data Interval"
},
"usageType": {
"fieldName": "usageType",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "Data Usage Type"
}
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"fileName": {
"fieldName": "fileName",
"view": "read",
"type": "string",
"required": true,
"label": "File Name",
"labelPlural": "File Names",
"help": "File Name for the Report (auto generated)."
},
"state": {
"fieldName": "state",
"view": "read",
"type": "oneOf",
"required": true,
"label": "State",
"labelPlural": "States",
"help": "State of the Report.",
"options": [
{
"text": "Incomplete",
"value": "REPORT_STATE_INCOMPLETE"
},
{
"text": "Pending",
"value": "REPORT_STATE_PENDING"
},
{
"text": "Running",
"value": "REPORT_STATE_RUNNING"
},
{
"text": "Failed",
"value": "REPORT_STATE_FAILED"
},
{
"text": "Done",
"value": "REPORT_STATE_DONE"
},
{
"text": "Expired",
"value": "REPORT_STATE_EXPIRED"
},
{
"text": "Cancelled",
"value": "REPORT_STATE_CANCELLED"
}
]
},
"errors": {
"fieldName": "errors",
"view": "read",
"type": "array",
"required": false,
"label": "Report Errors",
"labelPlural": "Report Errors",
"help": "Hello, world!"
},
"runDatetime": {
"fieldName": "runDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Run Datetime",
"labelPlural": "Run Datetimes",
"help": "``"
},
"expireDatetime": {
"fieldName": "expireDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Expire Datetime",
"labelPlural": "Expire Datetimes",
"help": "``"
},
"auditDatetime": {
"fieldName": "auditDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Audit Datetime",
"labelPlural": "Audit Datetimes",
"help": "``"
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_REPORT",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reportCd": {
"type": "string",
"enum": [
"rh6d3SKxM25AO4oyfjfb"
],
"description": "Unique identifier for the report"
},
"type": {
"type": "string",
"enum": [
"REPORT_INTERVAL_DATA_CSV",
"REPORT_AUDIT_CSV"
],
"description": "Report type (Interval Data, BACnet Audit)"
},
"parameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "array",
"items": {
"type": "string",
"enum": [
"sc0130Y8wN4hpg2h64wd"
]
},
"description": "Sites for which report should be run"
},
"startDate": {
"type": "string",
"enum": [
"2017-03-28"
],
"description": "Start Date in YYYY-MM-DD format"
},
"endDate": {
"type": "string",
"enum": [
"2017-03-29"
],
"description": "End Date in YYYY-MM-DD format"
},
"interval": {
"type": "string",
"enum": [
"UD_INC_15MIN"
],
"description": "Interval for Interval Data, see editParameters for available options"
},
"usageType": {
"type": "string",
"enum": [
"UD_DTYPE_KWH"
],
"description": "Usage Type for Interval Data, see editParameters for available options"
}
},
"required": [
"siteCd",
"startDate",
"endDate",
"interval",
"usageType"
],
"additionalProperties": false,
"description": "Parameters to run the Report"
},
"name": {
"type": "string",
"enum": [
"Report Name"
],
"description": "Name of the report (auto generated if none given)"
},
"fileName": {
"type": "string",
"enum": [
"ReportFileName.csv"
],
"description": "Auto generated filename of the report"
},
"state": {
"type": "string",
"enum": [
"REPORT_STATE_INCOMPLETE",
"REPORT_STATE_PENDING",
"REPORT_STATE_RUNNING",
"REPORT_STATE_FAILED",
"REPORT_STATE_DONE",
"REPORT_STATE_EXPIRED",
"REPORT_STATE_CANCELLED"
],
"description": "State of the Report"
},
"errors": {
"description": "List of errors when report generation failed"
},
"runDatetime": {
"type": "string",
"enum": [
"2017-04-03 14:20:27 UTC"
],
"description": "UTC datetime when report was run"
},
"expireDatetime": {
"type": "string",
"enum": [
"2017-04-17 14:20:27 UTC"
],
"description": "UTC datetime when report will expire (for download)"
},
"auditDatetime": {
"type": "string",
"enum": [
"2017-04-03 14:20:27"
],
"description": "System datetime when report run parameters were last edited"
},
"user": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"sc2h64wd0130Y8wN4hpg"
],
"description": "Unique identifier for the User"
},
"name": {
"type": "string",
"enum": [
"Report User"
],
"description": "Name of the User"
}
},
"required": [
"userCd",
"name"
],
"additionalProperties": false,
"description": "User that created or edited the Report"
},
"editParameters": {
"type": "object",
"properties": {
"reportCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"reportCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Report CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Report CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Report."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"type"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Type"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Types"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Type of the Report."
],
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Interval Data Report CSV"
],
"description": "Text to display in UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_INTERVAL_DATA_CSV"
],
"description": "Option value"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"eGauge Audit Report CSV"
],
"description": "Text to display in UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_AUDIT_CSV"
],
"description": "Option value"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
}
],
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"additionalProperties": false,
"description": "Edit info"
},
"parameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"siteCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"onePlusOf",
"string",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Site CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Site CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Site CDs to run report against."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"startDate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"startDate"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Start Date"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Start Dates"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Start Date in YYYY-MM-DD format."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"endDate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"endDate"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"End Date"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"End Dates"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"End Date in YYYY-MM-DD format."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"interval": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"interval"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Interval"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Intervals"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Data Interval"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"usageType": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"usageType"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Usage Type"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Usage Types"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Data Usage Type"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"siteCd",
"startDate",
"endDate",
"interval",
"usageType"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name is required, and must be unique within a Site"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"fileName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"fileName"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"File Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"File Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"File Name for the Report (auto generated)."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"state": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"state"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"State"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"States"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"State of the Report."
],
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Incomplete"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_INCOMPLETE"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Pending"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_PENDING"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Running"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_RUNNING"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Failed"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_FAILED"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Done"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_DONE"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Expired"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_EXPIRED"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Cancelled"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_CANCELLED"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
}
],
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"additionalProperties": false,
"description": "Edit info"
},
"errors": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"errors"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Report Errors"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Report Errors"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
""
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"runDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"runDatetime"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Run Datetime"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Run Datetimes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"``"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"expireDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"expireDatetime"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Expire Datetime"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Expire Datetimes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"``"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"auditDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"auditDatetime"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Audit Datetime"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Audit Datetimes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"``"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"reportCd",
"type",
"parameters",
"name",
"fileName",
"state",
"errors",
"runDatetime",
"expireDatetime",
"auditDatetime"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"reportCd",
"type",
"parameters",
"name",
"fileName",
"state",
"runDatetime",
"expireDatetime",
"auditDatetime",
"user",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Report ¶
The request parameters for a report depend on the report type. The examples below show the request and response for the REPORT_INTERVAL_DATA_CSV type. When creating a new Report you can see the appropriate properties in the list of editParameters.
Get ReportGET/api/v3.1/reports/{reportCd}{?editParameters}
- Types of Responses
- Response 200 - Retrieval successful - body included with any extra changes
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/reports/rh6d3SKxM25AO4oyfjfb?editParameters=false
URI Parameters
- reportCd
string(required) Example: rh6d3SKxM25AO4oyfjfb- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"reportCd": "rh6d3SKxM25AO4oyfjfb",
"type": "REPORT_INTERVAL_DATA_CSV",
"parameters": {
"siteCd": [
"sc0130Y8wN4hpg2h64wd"
],
"startDate": "2017-03-28",
"endDate": "2017-03-29",
"interval": "UD_INC_15MIN",
"usageType": "UD_DTYPE_KWH"
},
"name": "Report Name",
"fileName": "ReportFileName.csv",
"state": "REPORT_STATE_INCOMPLETE",
"errors": [],
"runDatetime": "2017-04-03 14:20:27 UTC",
"expireDatetime": "2017-04-17 14:20:27 UTC",
"auditDatetime": "2017-04-03 14:20:27",
"user": {
"userCd": "sc2h64wd0130Y8wN4hpg",
"name": "Report User"
},
"editParameters": {
"reportCd": {
"fieldName": "reportCd",
"view": "read",
"type": "string",
"required": true,
"label": "Report CD",
"labelPlural": "Report CDs",
"help": "Unique identifier for the Report."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Type of the Report.",
"options": [
{
"text": "Interval Data Report CSV",
"value": "REPORT_INTERVAL_DATA_CSV"
},
{
"text": "eGauge Audit Report CSV",
"value": "REPORT_AUDIT_CSV"
}
]
},
"parameters": {
"siteCd": {
"fieldName": "siteCd",
"view": "write",
"type": "onePlusOf",
"required": true,
"label": "Site CD",
"labelPlural": "Site CDs",
"help": "Site CDs to run report against."
},
"startDate": {
"fieldName": "startDate",
"view": "write",
"type": "string",
"required": true,
"label": "Start Date",
"labelPlural": "Start Dates",
"help": "Start Date in YYYY-MM-DD format."
},
"endDate": {
"fieldName": "endDate",
"view": "write",
"type": "string",
"required": true,
"label": "End Date",
"labelPlural": "End Dates",
"help": "End Date in YYYY-MM-DD format."
},
"interval": {
"fieldName": "interval",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Interval",
"labelPlural": "Intervals",
"help": "Data Interval"
},
"usageType": {
"fieldName": "usageType",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "Data Usage Type"
}
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"fileName": {
"fieldName": "fileName",
"view": "read",
"type": "string",
"required": true,
"label": "File Name",
"labelPlural": "File Names",
"help": "File Name for the Report (auto generated)."
},
"state": {
"fieldName": "state",
"view": "read",
"type": "oneOf",
"required": true,
"label": "State",
"labelPlural": "States",
"help": "State of the Report.",
"options": [
{
"text": "Incomplete",
"value": "REPORT_STATE_INCOMPLETE"
},
{
"text": "Pending",
"value": "REPORT_STATE_PENDING"
},
{
"text": "Running",
"value": "REPORT_STATE_RUNNING"
},
{
"text": "Failed",
"value": "REPORT_STATE_FAILED"
},
{
"text": "Done",
"value": "REPORT_STATE_DONE"
},
{
"text": "Expired",
"value": "REPORT_STATE_EXPIRED"
},
{
"text": "Cancelled",
"value": "REPORT_STATE_CANCELLED"
}
]
},
"errors": {
"fieldName": "errors",
"view": "read",
"type": "array",
"required": false,
"label": "Report Errors",
"labelPlural": "Report Errors",
"help": "Hello, world!"
},
"runDatetime": {
"fieldName": "runDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Run Datetime",
"labelPlural": "Run Datetimes",
"help": "``"
},
"expireDatetime": {
"fieldName": "expireDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Expire Datetime",
"labelPlural": "Expire Datetimes",
"help": "``"
},
"auditDatetime": {
"fieldName": "auditDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Audit Datetime",
"labelPlural": "Audit Datetimes",
"help": "``"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_REPORT",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"reportCd": {
"type": "string",
"enum": [
"rh6d3SKxM25AO4oyfjfb"
],
"description": "Unique identifier for the report"
},
"type": {
"type": "string",
"enum": [
"REPORT_INTERVAL_DATA_CSV",
"REPORT_AUDIT_CSV"
],
"description": "Report type (Interval Data, BACnet Audit)"
},
"parameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "array",
"items": {
"type": "string",
"enum": [
"sc0130Y8wN4hpg2h64wd"
]
},
"description": "Sites for which report should be run"
},
"startDate": {
"type": "string",
"enum": [
"2017-03-28"
],
"description": "Start Date in YYYY-MM-DD format"
},
"endDate": {
"type": "string",
"enum": [
"2017-03-29"
],
"description": "End Date in YYYY-MM-DD format"
},
"interval": {
"type": "string",
"enum": [
"UD_INC_15MIN"
],
"description": "Interval for Interval Data, see editParameters for available options"
},
"usageType": {
"type": "string",
"enum": [
"UD_DTYPE_KWH"
],
"description": "Usage Type for Interval Data, see editParameters for available options"
}
},
"required": [
"siteCd",
"startDate",
"endDate",
"interval",
"usageType"
],
"additionalProperties": false,
"description": "Parameters to run the Report"
},
"name": {
"type": "string",
"enum": [
"Report Name"
],
"description": "Name of the report (auto generated if none given)"
},
"fileName": {
"type": "string",
"enum": [
"ReportFileName.csv"
],
"description": "Auto generated filename of the report"
},
"state": {
"type": "string",
"enum": [
"REPORT_STATE_INCOMPLETE",
"REPORT_STATE_PENDING",
"REPORT_STATE_RUNNING",
"REPORT_STATE_FAILED",
"REPORT_STATE_DONE",
"REPORT_STATE_EXPIRED",
"REPORT_STATE_CANCELLED"
],
"description": "State of the Report"
},
"errors": {
"description": "List of errors when report generation failed"
},
"runDatetime": {
"type": "string",
"enum": [
"2017-04-03 14:20:27 UTC"
],
"description": "UTC datetime when report was run"
},
"expireDatetime": {
"type": "string",
"enum": [
"2017-04-17 14:20:27 UTC"
],
"description": "UTC datetime when report will expire (for download)"
},
"auditDatetime": {
"type": "string",
"enum": [
"2017-04-03 14:20:27"
],
"description": "System datetime when report run parameters were last edited"
},
"user": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"sc2h64wd0130Y8wN4hpg"
],
"description": "Unique identifier for the User"
},
"name": {
"type": "string",
"enum": [
"Report User"
],
"description": "Name of the User"
}
},
"required": [
"userCd",
"name"
],
"additionalProperties": false,
"description": "User that created or edited the Report"
},
"editParameters": {
"type": "object",
"properties": {
"reportCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"reportCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Report CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Report CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Report."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"type"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Type"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Types"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Type of the Report."
],
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Interval Data Report CSV"
],
"description": "Text to display in UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_INTERVAL_DATA_CSV"
],
"description": "Option value"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"eGauge Audit Report CSV"
],
"description": "Text to display in UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_AUDIT_CSV"
],
"description": "Option value"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
}
],
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"additionalProperties": false,
"description": "Edit info"
},
"parameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"siteCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"onePlusOf",
"string",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Site CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Site CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Site CDs to run report against."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"startDate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"startDate"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Start Date"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Start Dates"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Start Date in YYYY-MM-DD format."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"endDate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"endDate"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"End Date"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"End Dates"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"End Date in YYYY-MM-DD format."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"interval": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"interval"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Interval"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Intervals"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Data Interval"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"usageType": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"usageType"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Usage Type"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Usage Types"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Data Usage Type"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"siteCd",
"startDate",
"endDate",
"interval",
"usageType"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name is required, and must be unique within a Site"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"fileName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"fileName"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"File Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"File Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"File Name for the Report (auto generated)."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"state": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"state"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"State"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"States"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"State of the Report."
],
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Incomplete"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_INCOMPLETE"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Pending"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_PENDING"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Running"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_RUNNING"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Failed"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_FAILED"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Done"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_DONE"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Expired"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_EXPIRED"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"text": {
"type": "string",
"enum": [
"Cancelled"
],
"description": "Text for UI"
},
"value": {
"type": "string",
"enum": [
"REPORT_STATE_CANCELLED"
],
"description": "Value of Item"
}
},
"required": [
"text",
"value"
],
"additionalProperties": false
}
],
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"additionalProperties": false,
"description": "Edit info"
},
"errors": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"errors"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Report Errors"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Report Errors"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
""
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"runDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"runDatetime"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Run Datetime"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Run Datetimes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"``"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"expireDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"expireDatetime"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Expire Datetime"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Expire Datetimes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"``"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"auditDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"auditDatetime"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Audit Datetime"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Audit Datetimes"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"``"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"reportCd",
"type",
"parameters",
"name",
"fileName",
"state",
"errors",
"runDatetime",
"expireDatetime",
"auditDatetime"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"reportCd",
"type",
"parameters",
"name",
"fileName",
"state",
"runDatetime",
"expireDatetime",
"auditDatetime",
"user",
"editParameters"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Create a new ReportPOST/api/v3.1/reports/{?editParameters}
Process options for creating a new report
Recommended method is to create a Report by sending in the “type” property in the fields section with editParameters set to “true”. This will return a 409 with available options in the editParameters to update the Report. However, if all options are already known they can be passed in to create the new report and a 200 will be returned if successful.
The eGauge Audit report (REPORT_AUDIT_CSV) needs an XML file upload in either the POST (Create) or the PUT (Update) request. In that case the request body has to be a multipart html form upload where the request attributes need to be in a JSON encoded string in the “payload” field and the file itself in the “upload” field. See the example at Update a Report
- Types of Responses
- Response 200 - Update successful - reportCd returned in body or full Report return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/reports/?editParameters=false
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"type": "REPORT_INTERVAL_DATA_CSV"
}Schema
{
"type": "object",
"properties": {
"type": {
"enum": [
"REPORT_INTERVAL_DATA_CSV",
"REPORT_AUDIT_CSV"
],
"description": "Report type (Interval Data, BACnet Audit)"
}
},
"required": [
"type"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"reportCd": "aCe1Tx8GVmN8E7o6JLNG"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_REPORT",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"reportCd": {
"type": "string",
"description": "The Report CD"
}
},
"required": [
"reportCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"reportCd": "rh6d3SKxM25AO4oyfjfb",
"type": "REPORT_INTERVAL_DATA_CSV",
"parameters": {
"siteCd": [
"sc0130Y8wN4hpg2h64wd"
],
"startDate": "2017-03-28",
"endDate": "2017-03-29",
"interval": "UD_INC_15MIN",
"usageType": "UD_DTYPE_KWH"
},
"name": "Report Name",
"fileName": "ReportFileName.csv",
"state": "REPORT_STATE_INCOMPLETE",
"errors": [],
"runDatetime": "2017-04-03 14:20:27 UTC",
"expireDatetime": "2017-04-17 14:20:27 UTC",
"auditDatetime": "2017-04-03 14:20:27",
"user": {
"userCd": "sc2h64wd0130Y8wN4hpg",
"name": "Report User"
},
"editParameters": {
"reportCd": {
"fieldName": "reportCd",
"view": "read",
"type": "string",
"required": true,
"label": "Report CD",
"labelPlural": "Report CDs",
"help": "Unique identifier for the Report."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Type of the Report.",
"options": [
{
"text": "Interval Data Report CSV",
"value": "REPORT_INTERVAL_DATA_CSV"
},
{
"text": "eGauge Audit Report CSV",
"value": "REPORT_AUDIT_CSV"
}
]
},
"parameters": {
"siteCd": {
"fieldName": "siteCd",
"view": "write",
"type": "onePlusOf",
"required": true,
"label": "Site CD",
"labelPlural": "Site CDs",
"help": "Site CDs to run report against."
},
"startDate": {
"fieldName": "startDate",
"view": "write",
"type": "string",
"required": true,
"label": "Start Date",
"labelPlural": "Start Dates",
"help": "Start Date in YYYY-MM-DD format."
},
"endDate": {
"fieldName": "endDate",
"view": "write",
"type": "string",
"required": true,
"label": "End Date",
"labelPlural": "End Dates",
"help": "End Date in YYYY-MM-DD format."
},
"interval": {
"fieldName": "interval",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Interval",
"labelPlural": "Intervals",
"help": "Data Interval"
},
"usageType": {
"fieldName": "usageType",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "Data Usage Type"
}
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"fileName": {
"fieldName": "fileName",
"view": "read",
"type": "string",
"required": true,
"label": "File Name",
"labelPlural": "File Names",
"help": "File Name for the Report (auto generated)."
},
"state": {
"fieldName": "state",
"view": "read",
"type": "oneOf",
"required": true,
"label": "State",
"labelPlural": "States",
"help": "State of the Report.",
"options": [
{
"text": "Incomplete",
"value": "REPORT_STATE_INCOMPLETE"
},
{
"text": "Pending",
"value": "REPORT_STATE_PENDING"
},
{
"text": "Running",
"value": "REPORT_STATE_RUNNING"
},
{
"text": "Failed",
"value": "REPORT_STATE_FAILED"
},
{
"text": "Done",
"value": "REPORT_STATE_DONE"
},
{
"text": "Expired",
"value": "REPORT_STATE_EXPIRED"
},
{
"text": "Cancelled",
"value": "REPORT_STATE_CANCELLED"
}
]
},
"errors": {
"fieldName": "errors",
"view": "read",
"type": "array",
"required": false,
"label": "Report Errors",
"labelPlural": "Report Errors",
"help": "Hello, world!"
},
"runDatetime": {
"fieldName": "runDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Run Datetime",
"labelPlural": "Run Datetimes",
"help": "``"
},
"expireDatetime": {
"fieldName": "expireDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Expire Datetime",
"labelPlural": "Expire Datetimes",
"help": "``"
},
"auditDatetime": {
"fieldName": "auditDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Audit Datetime",
"labelPlural": "Audit Datetimes",
"help": "``"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_REPORT",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"reportCd": {
"type": "string",
"description": "Unique identifier for the report"
},
"type": {
"type": "string",
"enum": [
"REPORT_INTERVAL_DATA_CSV",
"REPORT_AUDIT_CSV"
],
"description": "Report type (Interval Data, BACnet Audit)"
},
"parameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "array",
"description": "Sites for which report should be run"
},
"startDate": {
"type": "string",
"description": "Start Date in YYYY-MM-DD format"
},
"endDate": {
"type": "string",
"description": "End Date in YYYY-MM-DD format"
},
"interval": {
"type": "string",
"description": "Interval for Interval Data, see editParameters for available options"
},
"usageType": {
"type": "string",
"description": "Usage Type for Interval Data, see editParameters for available options"
}
},
"required": [
"siteCd",
"startDate",
"endDate",
"interval",
"usageType"
],
"description": "Parameters to run the Report"
},
"name": {
"type": "string",
"description": "Name of the report (auto generated if none given)"
},
"fileName": {
"type": "string",
"description": "Auto generated filename of the report"
},
"state": {
"type": "string",
"enum": [
"REPORT_STATE_INCOMPLETE",
"REPORT_STATE_PENDING",
"REPORT_STATE_RUNNING",
"REPORT_STATE_FAILED",
"REPORT_STATE_DONE",
"REPORT_STATE_EXPIRED",
"REPORT_STATE_CANCELLED"
],
"description": "State of the Report"
},
"errors": {
"description": "List of errors when report generation failed"
},
"runDatetime": {
"type": "string",
"description": "UTC datetime when report was run"
},
"expireDatetime": {
"type": "string",
"description": "UTC datetime when report will expire (for download)"
},
"auditDatetime": {
"type": "string",
"description": "System datetime when report run parameters were last edited"
},
"user": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for the User"
},
"name": {
"type": "string",
"description": "Name of the User"
}
},
"required": [
"userCd",
"name"
],
"description": "User that created or edited the Report"
},
"editParameters": {
"type": "object",
"properties": {
"reportCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"parameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"onePlusOf",
"string",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"startDate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"endDate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"interval": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"usageType": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"siteCd",
"startDate",
"endDate",
"interval",
"usageType"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"fileName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"state": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"errors": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"runDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"expireDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"auditDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"reportCd",
"type",
"parameters",
"name",
"fileName",
"state",
"errors",
"runDatetime",
"expireDatetime",
"auditDatetime"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"reportCd",
"type",
"name",
"fileName",
"state",
"runDatetime",
"expireDatetime",
"auditDatetime"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Update a ReportPUT/api/v3.1/reports/{reportCd}{?editParameters}
Only send in data that is changed
The eGauge Audit report (REPORT_AUDIT_CSV) needs an XML file upload in either the POST (Create) or the PUT (Update) request. In that case the request body has to be a multipart html form upload where the request attributes need to be in a JSON encoded string in the “payload” field and the file itself in the “upload” field.
Example of file upload request body in multipart/form-data format:
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="payload"
{"parameters":{"upload":"InputData.xml"}}
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="upload"; filename="InputData.xml"
Content-Type: text/xml
------WebKitFormBoundary7MA4YWxkTrZu0gW--
- Types of Responses
- Response 200 - Update successful - reportCd returned in body or full Report return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/reports/rh6d3SKxM25AO4oyfjfb?editParameters=false
URI Parameters
- reportCd
string(required) Example: rh6d3SKxM25AO4oyfjfbThe Report CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"parameters": {
"endDate": "2017-04-01"
}
}Schema
{
"type": "object",
"properties": {
"parameters": {
"type": "object",
"properties": {
"endDate": {
"type": "string",
"description": "End Date of the report"
}
},
"required": [
"endDate"
]
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"reportCd": "aCe1Tx8GVmN8E7o6JLNG"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_REPORT",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"reportCd": {
"type": "string",
"description": "The Report CD"
}
},
"required": [
"reportCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {
"reportCd": "rh6d3SKxM25AO4oyfjfb",
"type": "REPORT_INTERVAL_DATA_CSV",
"parameters": {
"siteCd": [
"sc0130Y8wN4hpg2h64wd"
],
"startDate": "2017-03-28",
"endDate": "2017-03-29",
"interval": "UD_INC_15MIN",
"usageType": "UD_DTYPE_KWH"
},
"name": "Report Name",
"fileName": "ReportFileName.csv",
"state": "REPORT_STATE_INCOMPLETE",
"errors": [],
"runDatetime": "2017-04-03 14:20:27 UTC",
"expireDatetime": "2017-04-17 14:20:27 UTC",
"auditDatetime": "2017-04-03 14:20:27",
"user": {
"userCd": "sc2h64wd0130Y8wN4hpg",
"name": "Report User"
},
"editParameters": {
"reportCd": {
"fieldName": "reportCd",
"view": "read",
"type": "string",
"required": true,
"label": "Report CD",
"labelPlural": "Report CDs",
"help": "Unique identifier for the Report."
},
"type": {
"fieldName": "type",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Type",
"labelPlural": "Types",
"help": "Type of the Report.",
"options": [
{
"text": "Interval Data Report CSV",
"value": "REPORT_INTERVAL_DATA_CSV"
},
{
"text": "eGauge Audit Report CSV",
"value": "REPORT_AUDIT_CSV"
}
]
},
"parameters": {
"siteCd": {
"fieldName": "siteCd",
"view": "write",
"type": "onePlusOf",
"required": true,
"label": "Site CD",
"labelPlural": "Site CDs",
"help": "Site CDs to run report against."
},
"startDate": {
"fieldName": "startDate",
"view": "write",
"type": "string",
"required": true,
"label": "Start Date",
"labelPlural": "Start Dates",
"help": "Start Date in YYYY-MM-DD format."
},
"endDate": {
"fieldName": "endDate",
"view": "write",
"type": "string",
"required": true,
"label": "End Date",
"labelPlural": "End Dates",
"help": "End Date in YYYY-MM-DD format."
},
"interval": {
"fieldName": "interval",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Interval",
"labelPlural": "Intervals",
"help": "Data Interval"
},
"usageType": {
"fieldName": "usageType",
"view": "write",
"type": "oneOf",
"required": true,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "Data Usage Type"
}
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"fileName": {
"fieldName": "fileName",
"view": "read",
"type": "string",
"required": true,
"label": "File Name",
"labelPlural": "File Names",
"help": "File Name for the Report (auto generated)."
},
"state": {
"fieldName": "state",
"view": "read",
"type": "oneOf",
"required": true,
"label": "State",
"labelPlural": "States",
"help": "State of the Report.",
"options": [
{
"text": "Incomplete",
"value": "REPORT_STATE_INCOMPLETE"
},
{
"text": "Pending",
"value": "REPORT_STATE_PENDING"
},
{
"text": "Running",
"value": "REPORT_STATE_RUNNING"
},
{
"text": "Failed",
"value": "REPORT_STATE_FAILED"
},
{
"text": "Done",
"value": "REPORT_STATE_DONE"
},
{
"text": "Expired",
"value": "REPORT_STATE_EXPIRED"
},
{
"text": "Cancelled",
"value": "REPORT_STATE_CANCELLED"
}
]
},
"errors": {
"fieldName": "errors",
"view": "read",
"type": "array",
"required": false,
"label": "Report Errors",
"labelPlural": "Report Errors",
"help": "Hello, world!"
},
"runDatetime": {
"fieldName": "runDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Run Datetime",
"labelPlural": "Run Datetimes",
"help": "``"
},
"expireDatetime": {
"fieldName": "expireDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Expire Datetime",
"labelPlural": "Expire Datetimes",
"help": "``"
},
"auditDatetime": {
"fieldName": "auditDatetime",
"view": "read",
"type": "datetime",
"required": false,
"label": "Audit Datetime",
"labelPlural": "Audit Datetimes",
"help": "``"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_REPORT",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"reportCd": {
"type": "string",
"description": "Unique identifier for the report"
},
"type": {
"type": "string",
"enum": [
"REPORT_INTERVAL_DATA_CSV",
"REPORT_AUDIT_CSV"
],
"description": "Report type (Interval Data, BACnet Audit)"
},
"parameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "array",
"description": "Sites for which report should be run"
},
"startDate": {
"type": "string",
"description": "Start Date in YYYY-MM-DD format"
},
"endDate": {
"type": "string",
"description": "End Date in YYYY-MM-DD format"
},
"interval": {
"type": "string",
"description": "Interval for Interval Data, see editParameters for available options"
},
"usageType": {
"type": "string",
"description": "Usage Type for Interval Data, see editParameters for available options"
}
},
"required": [
"siteCd",
"startDate",
"endDate",
"interval",
"usageType"
],
"description": "Parameters to run the Report"
},
"name": {
"type": "string",
"description": "Name of the report (auto generated if none given)"
},
"fileName": {
"type": "string",
"description": "Auto generated filename of the report"
},
"state": {
"type": "string",
"enum": [
"REPORT_STATE_INCOMPLETE",
"REPORT_STATE_PENDING",
"REPORT_STATE_RUNNING",
"REPORT_STATE_FAILED",
"REPORT_STATE_DONE",
"REPORT_STATE_EXPIRED",
"REPORT_STATE_CANCELLED"
],
"description": "State of the Report"
},
"errors": {
"description": "List of errors when report generation failed"
},
"runDatetime": {
"type": "string",
"description": "UTC datetime when report was run"
},
"expireDatetime": {
"type": "string",
"description": "UTC datetime when report will expire (for download)"
},
"auditDatetime": {
"type": "string",
"description": "System datetime when report run parameters were last edited"
},
"user": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"description": "Unique identifier for the User"
},
"name": {
"type": "string",
"description": "Name of the User"
}
},
"required": [
"userCd",
"name"
],
"description": "User that created or edited the Report"
},
"editParameters": {
"type": "object",
"properties": {
"reportCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"type": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"parameters": {
"type": "object",
"properties": {
"siteCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"onePlusOf",
"string",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"startDate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"endDate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"onePlusOf",
"number",
"oneOf",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"interval": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"usageType": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"onePlusOf",
"number",
"anyOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"siteCd",
"startDate",
"endDate",
"interval",
"usageType"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"fileName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"state": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
},
"options": {
"type": "array",
"description": "List of items"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural",
"options"
],
"description": "Edit info"
},
"errors": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"runDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"expireDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"auditDatetime": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"datetime",
"array",
"oneOf",
"string",
"number",
"anyOf",
"onePlusOf",
"object"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"reportCd",
"type",
"parameters",
"name",
"fileName",
"state",
"errors",
"runDatetime",
"expireDatetime",
"auditDatetime"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"reportCd",
"type",
"name",
"fileName",
"state",
"runDatetime",
"expireDatetime",
"auditDatetime"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Delete a ReportDELETE/api/v3.1/reports/{reportCd}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/reports/rh6d3SKxM25AO4oyfjfb
URI Parameters
- reportCd
string(required) Example: rh6d3SKxM25AO4oyfjfbThe Report CD
Response
204Headers
Content-Type: application/jsonDownload Report ¶
Download ReportGET/api/v3.1/reports/{reportCd}/actions/download
- Types of Responses
- Response 200 - Retrieval successful - Report as body
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/reports/rh6d3SKxM25AO4oyfjfb/actions/download
URI Parameters
- reportCd
string(required) Example: rh6d3SKxM25AO4oyfjfb
Response
200Headers
Content-Type: application/octet-streamFiles ¶
Files List ¶
Get Files ListGET/api/v3.1/companies/{companyCd}/files{?editParameters,limit,page}
Get the Files list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Rules for this Site
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/H6Z5Ea1psSe449Kg3968/files?editParameters=false&limit=100&page=1
URI Parameters
- companyCd
string(required) Example: H6Z5Ea1psSe449Kg3968The Company CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"fileCd": "M25AO4oyfjfbrh6d3SKx",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"user": {
"userCd": "aoJ2D5i4t4yTL3lO6L45",
"name": "John Smith"
},
"fileName": "image.jpg",
"fileLocation": "https://storage.googleapis.com/dummy-bucket/image.jpg",
"public": true,
"editParameters": {
"fileCd": {
"fieldName": "fileCd",
"view": "read",
"type": "string",
"required": true,
"label": "File CD",
"labelPlural": "File CDs",
"help": "Unique identifier for the File."
},
"company": {
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": false,
"label": "Name",
"labelPlural": "Names",
"help": "Company Name"
}
},
"user": {
"userCd": {
"fieldName": "userCd",
"view": "read",
"type": "string",
"required": false,
"label": "User CD",
"labelPlural": "User CDs",
"help": "Unique identifier for the User."
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": false,
"label": "Name",
"labelPlural": "Names",
"help": "User Name."
}
},
"fileName": {
"fieldName": "fileName",
"view": "write",
"type": "string",
"required": false,
"label": "File Name",
"labelPlural": "File Names",
"help": "File Name for the File."
},
"fileLocation": {
"fieldName": "fileLocation",
"view": "read",
"type": "string",
"required": false,
"label": "File Location",
"labelPlural": "File Locations",
"help": "Location of the File."
},
"public": {
"fieldName": "public",
"view": "write",
"type": "boolean",
"required": true,
"label": "Public?",
"labelPlural": "Public?",
"help": "Is this File Public?"
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_FILE",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fileCd": {
"type": "string",
"enum": [
"M25AO4oyfjfbrh6d3SKx"
],
"description": "Unique identifier for the File"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this File is assigned to"
},
"user": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"aoJ2D5i4t4yTL3lO6L45"
],
"description": "Unique identifier for a User"
},
"name": {
"type": "string",
"enum": [
"John Smith"
],
"description": "First Name concatenated with Last Name"
}
},
"required": [
"userCd"
],
"additionalProperties": false,
"description": "User this File is assigned to"
},
"fileName": {
"type": "string",
"enum": [
"image.jpg"
],
"description": "File Name of the File"
},
"fileLocation": {
"type": "string",
"enum": [
"https://storage.googleapis.com/dummy-bucket/image.jpg"
],
"description": "Location of the File"
},
"public": {
"type": "boolean",
"enum": [
true
],
"description": "Is this file public?"
},
"editParameters": {
"type": "object",
"properties": {
"fileCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"fileCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"File CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"File CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the File."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"companyCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Company CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Company CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Company."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Company Name"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"additionalProperties": false
},
"user": {
"type": "object",
"properties": {
"userCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"userCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"User CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"User CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the User."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"User Name."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"additionalProperties": false
},
"fileName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"fileName"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"File Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"File Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"File Name for the File."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"fileLocation": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"fileLocation"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"File Location"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"File Locations"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Location of the File."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"public": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"public"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Public?"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Public?"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Is this File Public?"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"fileCd",
"company",
"user",
"public"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"fileCd",
"company",
"user",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}File ¶
Get FileGET/api/v3.1/companies/{companyCd}/files/{fileCd}{?editParameters}
- Types of Responses
- Response 200 - Retrieval successful
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/H6Z5Ea1psSe449Kg3968/files/M25AO4oyfjfbrh6d3SKx?editParameters=false
URI Parameters
- companyCd
string(required) Example: H6Z5Ea1psSe449Kg3968The Company CD
- fileCd
string(required) Example: M25AO4oyfjfbrh6d3SKx- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"fileCd": "M25AO4oyfjfbrh6d3SKx",
"company": {
"companyCd": "H6Z5Ea1psSe449Kg3968",
"name": "Altair"
},
"user": {
"userCd": "aoJ2D5i4t4yTL3lO6L45",
"name": "John Smith"
},
"fileName": "image.jpg",
"fileLocation": "https://storage.googleapis.com/dummy-bucket/image.jpg",
"public": true,
"editParameters": {
"fileCd": {
"fieldName": "fileCd",
"view": "read",
"type": "string",
"required": true,
"label": "File CD",
"labelPlural": "File CDs",
"help": "Unique identifier for the File."
},
"company": {
"companyCd": {
"fieldName": "companyCd",
"view": "read",
"type": "string",
"required": false,
"label": "Company CD",
"labelPlural": "Company CDs",
"help": "Unique identifier for the Company."
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": false,
"label": "Name",
"labelPlural": "Names",
"help": "Company Name"
}
},
"user": {
"userCd": {
"fieldName": "userCd",
"view": "read",
"type": "string",
"required": false,
"label": "User CD",
"labelPlural": "User CDs",
"help": "Unique identifier for the User."
},
"name": {
"fieldName": "name",
"view": "read",
"type": "string",
"required": false,
"label": "Name",
"labelPlural": "Names",
"help": "User Name."
}
},
"fileName": {
"fieldName": "fileName",
"view": "write",
"type": "string",
"required": false,
"label": "File Name",
"labelPlural": "File Names",
"help": "File Name for the File."
},
"fileLocation": {
"fieldName": "fileLocation",
"view": "read",
"type": "string",
"required": false,
"label": "File Location",
"labelPlural": "File Locations",
"help": "Location of the File."
},
"public": {
"fieldName": "public",
"view": "write",
"type": "boolean",
"required": true,
"label": "Public?",
"labelPlural": "Public?",
"help": "Is this File Public?"
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_FILE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"fileCd": {
"type": "string",
"enum": [
"M25AO4oyfjfbrh6d3SKx"
],
"description": "Unique identifier for the File"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"enum": [
"H6Z5Ea1psSe449Kg3968"
],
"description": "Unique identifier assigned for a Company"
},
"name": {
"type": "string",
"enum": [
"Altair"
],
"description": "Name of the Company"
}
},
"required": [
"companyCd",
"name"
],
"additionalProperties": false,
"description": "Company this File is assigned to"
},
"user": {
"type": "object",
"properties": {
"userCd": {
"type": "string",
"enum": [
"aoJ2D5i4t4yTL3lO6L45"
],
"description": "Unique identifier for a User"
},
"name": {
"type": "string",
"enum": [
"John Smith"
],
"description": "First Name concatenated with Last Name"
}
},
"required": [
"userCd"
],
"additionalProperties": false,
"description": "User this File is assigned to"
},
"fileName": {
"type": "string",
"enum": [
"image.jpg"
],
"description": "File Name of the File"
},
"fileLocation": {
"type": "string",
"enum": [
"https://storage.googleapis.com/dummy-bucket/image.jpg"
],
"description": "Location of the File"
},
"public": {
"type": "boolean",
"enum": [
true
],
"description": "Is this file public?"
},
"editParameters": {
"type": "object",
"properties": {
"fileCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"fileCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"File CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"File CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the File."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"company": {
"type": "object",
"properties": {
"companyCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"companyCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Company CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Company CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Company."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Company Name"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"additionalProperties": false
},
"user": {
"type": "object",
"properties": {
"userCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"userCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"User CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"User CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the User."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"User Name."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"additionalProperties": false
},
"fileName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"fileName"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"File Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"File Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"File Name for the File."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"fileLocation": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"fileLocation"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"File Location"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"File Locations"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Location of the File."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"public": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"public"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Public?"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Public?"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Is this File Public?"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"fileCd",
"company",
"user",
"public"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"fileCd",
"company",
"user",
"editParameters"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Create a new FilePOST/api/v3.1/companies/{companyCd}/files/{?editParameters}
The file creation needs an file upload in the POST request. The request body has to be a multipart html form upload where the request attributes need to be in a JSON encoded string in the “payload” field and the file itself in the “upload” field.
The attributes in the payload field can be used to set the file to public (true/false, default is false) or to set a specific file name.
Example of file upload request body in multipart/form-data format:
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="payload"
{"public":true}
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="upload"; filename="image.jpg"
Content-Type: image/jpeg
------WebKitFormBoundary7MA4YWxkTrZu0gW--
- Types of Responses
- Response 200 - Update successful - fileCd returned in body or full File return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/companies/H6Z5Ea1psSe449Kg3968/files/?editParameters=false
URI Parameters
- companyCd
string(required) Example: H6Z5Ea1psSe449Kg3968The Company CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"public": true
}Schema
{
"type": "object",
"properties": {
"public": {
"type": "boolean",
"description": "Is this file public?"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"fileCd": "M25AO4oyfjfbrh6d3SKx"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_FILE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"fileCd": {
"type": "string",
"description": "The File CD"
}
},
"required": [
"fileCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_FILE",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Update a FilePUT/api/v3.1/companies/{companyCd}/files/{fileCd}{?editParameters}
The request can be used to set the file to public (true/false) or to set a specific file name.
- Types of Responses
- Response 200 - Update successful - fileCd returned in body or full File return if editParameters set to true
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/companies/H6Z5Ea1psSe449Kg3968/files/M25AO4oyfjfbrh6d3SKx?editParameters=false
URI Parameters
- companyCd
string(required) Example: H6Z5Ea1psSe449Kg3968The Company CD
- fileCd
string(required) Example: M25AO4oyfjfbrh6d3SKxThe File CD
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"fileName": "image.jpg",
"public": true
}Schema
{
"type": "object",
"properties": {
"fileName": {
"type": "string",
"description": "File Name of the File"
},
"public": {
"type": "boolean",
"description": "Is this file public?"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"fileCd": "M25AO4oyfjfbrh6d3SKx"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_FILE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"fileCd": {
"type": "string",
"description": "The File CD"
}
},
"required": [
"fileCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_FILE",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Delete a FileDELETE/api/v3.1/companies/{companyCd}/files/{fileCd}
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/companies/H6Z5Ea1psSe449Kg3968/files/M25AO4oyfjfbrh6d3SKx
URI Parameters
- companyCd
string(required) Example: H6Z5Ea1psSe449Kg3968The Company CD
- fileCd
string(required) Example: M25AO4oyfjfbrh6d3SKxThe File CD
Response
204Headers
Content-Type: application/jsonDownload File ¶
Download FileGET/api/v3.1/companies/{companyCd}/files/{fileCd}/actions/download
- Types of Responses
- Response 200 - Retrieval successful - File as body
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/H6Z5Ea1psSe449Kg3968/files/M25AO4oyfjfbrh6d3SKx/actions/download
URI Parameters
- companyCd
string(required) Example: H6Z5Ea1psSe449Kg3968- fileCd
string(required) Example: M25AO4oyfjfbrh6d3SKx
Response
200Headers
Content-Type: application/octet-streamDownloads ¶
Reports ¶
The report will be in the body of the response.
ReportsGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/downloads/reports{?type,format,method,compact,filter,filterOr,page,limit}
If the parameter “method” is omitted or set to “stored” then the last available copy on the cloud will be downloaded. To force the cloud to get a new report from the gateway and store it set “method” to “refresh”. To get a copy directly from an SSH enabled gateway set “method” to “fetch”.
A BACnet report that is retrieved from the cloud (method=stored) can be paginated and filtered. If the JSON format is retrieved the return can be for devices only (objects omitted) when compact=true is used.
The pagination will be done on the objects. The filtering will be done on device and object properties. To use filtering any of the device and object properties can be used.
For a GET call the filtering needs to be specified in array form, for example: filter[device-identifier]=997&filter[object-name]=VAV. A list of properties can be found at the request options of the POST call.
For a POST call the filtering is in the JSON request body.
The “filter” input uses “and filtering”. To use “or filtering” the “filterOr” input needs to be used and the properties to filter on should be comma separated, for example: filterOr[object-name,description]=load.
The “filter” and “filterOr” input parameters can be combined.
When “method=refresh” is used for a BACnet report the “filter[device-identifier]” query parameter can be used to limit the newly generated report to only contain the devices which identifiers are contained in the comma separated filter (example “filter[device-identifier]=997,999”). In this comma separated list, a range can also be used (example “filter[device-identifier]=997,999,1001-1099”).
For type=modbus (Modbus Report) the following options are currently not implemented: format, compact, filter (see exception below), filterOr, page, limit.
When “method=refresh” is used for a Modbus report the “filter[network]” and “filter[port]” query parameters can be used to limit the newly generated report to only contain the devices which networks and ports are contained in the comma separated filter (example “filter[network]=10.0.0.0/8,192.168.0.0/16&filter[port]=1024,1032”).
- Types of Responses
- Response 200 - Send successful
- Response 409 - Conflict - If the download request would invalidate a constraint
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/downloads/reports?type=bacnet&format=json&method=stored&compact=false&filter=&filterOr=&page=1&limit=100
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
- type
string(required) Example: bacnetThe type of report being downloaded
Choices:
bacnetmodbus- format
string(required) Example: jsonThe format of the report
Choices:
jsoncsv- method
string(optional) Example: storedThe method of the report generation
Choices:
storedrefreshfetchstatus- compact
string(optional) Example: falseOmit the objects from devices if set to true (JSON format only)
Choices:
falsetrue- filter
array(optional)Filter by property using “and”, see POST request for available properties
- filterOr
array(optional)Filter by property using “or”, see POST request for available properties
- page
number(optional) Example: 1Which page number to return based on the limit count
- limit
number(optional) Example: 100Number of items to return
Response
200Headers
Content-Type: application/octet-streamResponse
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 907,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}ReportsPOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/downloads/reports
If the parameter “method” is omitted or set to “stored” then the last available copy on the cloud will be downloaded. To force the cloud to get a new report from the gateway and store it set “method” to “refresh”. To get a copy directly from an SSH enabled gateway set “method” to “fetch”.
A BACnet report that is retrieved from the cloud (method=stored) can be paginated and filtered. If the JSON format is retrieved the return can be for devices only (objects omitted) when compact=true is used.
The pagination will be done on the objects. The filtering will be done on device and object properties. To use filtering any of the device and object properties can be used.
For a GET call the filtering needs to be specified in array form, for example: filter[device-identifier]=997&filter[object-name]=VAV.
For a POST call the filtering is in the JSON request body.
The “filter” input uses “and filtering”. To use “or filtering” the “filterOr” input needs to be used and the properties to filter on should be comma separated, for example: filterOr[object-name,description]=load.
The “filter” and “filterOr” input parameters can be combined.
For type=modbus (Modbus Report) the following options are currently not implemented: format, compact, filter, filterOr, page, limit.
- Types of Responses
- Response 200 - Send successful
- Response 409 - Conflict - If the download request would invalidate a constraint
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/downloads/reports
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrThe Site CD
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD
Request
Body
{
"type": "bacnet",
"format": "json",
"method": "stored",
"compact": "false",
"filter": {
"display-name": "filterValue",
"device-identifier": "997",
"address": "filterValue",
"saddress": "filterValue",
"system-status": "filterValue",
"vendor-name": "filterValue",
"vendor-identifier": "filterValue",
"model-name": "filterValue",
"standard-version": "filterValue",
"software-version": "filterValue",
"bacnet-network": "filterValue",
"multiread": "filterValue",
"router": "filterValue",
"max-master": "filterValue",
"max-info-frames": "filterValue",
"object-type": "filterValue",
"object-identifier": "filterValue",
"object-name": "filterValue",
"value": "filterValue",
"units": "filterValue",
"description": "filterValue",
"cov": "filterValue"
},
"filterOr": {
"object-identifier,description": "filterValue"
},
"page": 1,
"limit": 100
}Schema
{
"type": "object",
"properties": {
"type": {
"enum": [
"bacnet",
"modbus"
],
"description": "The type of report being downloaded"
},
"format": {
"enum": [
"json",
"csv"
],
"description": "The format of the report"
},
"method": {
"enum": [
"stored",
"refresh",
"fetch"
],
"description": "The method of the report generation"
},
"compact": {
"enum": [
"false",
"true"
],
"description": "Omit the objects from devices if set to true (JSON format only)"
},
"filter": {
"type": "object",
"properties": {
"display-name": {
"type": "string",
"description": "Filter by property"
},
"device-identifier": {
"type": "string",
"description": "Filter by property"
},
"address": {
"type": "string",
"description": "Filter by property"
},
"saddress": {
"type": "string",
"description": "Filter by property"
},
"system-status": {
"type": "string",
"description": "Filter by property"
},
"vendor-name": {
"type": "string",
"description": "Filter by property"
},
"vendor-identifier": {
"type": "string",
"description": "Filter by property"
},
"model-name": {
"type": "string",
"description": "Filter by property"
},
"standard-version": {
"type": "string",
"description": "Filter by property"
},
"software-version": {
"type": "string",
"description": "Filter by property"
},
"bacnet-network": {
"type": "string",
"description": "Filter by property"
},
"multiread": {
"type": "string",
"description": "Filter by property"
},
"router": {
"type": "string",
"description": "Filter by property"
},
"max-master": {
"type": "string",
"description": "Filter by property"
},
"max-info-frames": {
"type": "string",
"description": "Filter by property"
},
"object-type": {
"type": "string",
"description": "Filter by property"
},
"object-identifier": {
"type": "string",
"description": "Filter by property"
},
"object-name": {
"type": "string",
"description": "Filter by property"
},
"value": {
"type": "string",
"description": "Filter by property"
},
"units": {
"type": "string",
"description": "Filter by property"
},
"description": {
"type": "string",
"description": "Filter by property"
},
"cov": {
"type": "string",
"description": "Filter by property"
}
}
},
"filterOr": {
"type": "object",
"properties": {
"object-identifier,description": {
"type": "string",
"description": "Filter by properties using \"or\""
}
}
},
"page": {
"type": "number",
"description": "Which page number to return based on the limit count"
},
"limit": {
"type": "number",
"description": "Number of items to return"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/octet-streamResponse
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 907,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Emails ¶
Emails ¶
A User can send email to other Users. The number of recipients is limited. Number of e-mails sent per hour is limited.
Send EmailPOST/api/v3.1/emails
- Types of Responses
- Response 200 - Send successful
- Response 409 - Conflict - If the send would invalidate a constraint
Example URI
POST https://altairsmartedge.com/api/v3.1/emails
Request
Body
{
"users": [
"GVE7oGCE1Tx8AmN6JLN8"
],
"email": [
"user@example.com"
],
"subject": "Email Subject",
"body": "Email Body",
"deviceIssueCd": [
"91236"
]
}Schema
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "string"
},
"description": "User CDs"
},
"email": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses"
},
"subject": {
"type": "string",
"description": "Email Subject, limited to 100 characters"
},
"body": {
"type": "string",
"description": "Email Body, limited to 1000 characters"
},
"deviceIssueCd": {
"type": "array",
"items": {
"type": "string"
},
"description": "Device Issue CDs to be emailed"
}
},
"required": [
"subject",
"body"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_STATUS",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 907,
"responseType": "JSON",
"responseDataType": "ALTAIR_ERROR",
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Email Templates ¶
Sub-companies inherit the template from the parent.
Email Templates List ¶
Get Email Templates ListGET/api/v3.1/companies/{companyCd}/emailTemplates/{?editParameters}
Get the Email Templates list.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Email Templates
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/emailTemplates/?editParameters=false
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"emailTemplateLcd": "CI_EMAIL_TEMPLATE_PASSWORD_RESET_LINK",
"description": "Password Reset - Link",
"text": {
"subject": "My Subject",
"body": "My email body.",
"inherited": false
},
"html": {
"subject": "My Subject",
"body": "My email body.",
"inherited": false
},
"editParameters": {
"emailTemplateLcd": {
"fieldName": "emailTemplateLcd",
"view": "read",
"type": "string",
"required": true,
"label": "Email Template LCD",
"labelPlural": "Email Template LCDs",
"help": "Unique identifier for the Email Template Lookup."
},
"description": {
"fieldName": "description",
"view": "read",
"type": "string",
"required": true,
"label": "Description",
"labelPlural": "Descriptions",
"help": "Email Template description"
},
"text": {
"subject": {
"fieldName": "subject",
"view": "write",
"type": "string",
"required": false,
"label": "Email Subject",
"labelPlural": "Email Subjects",
"help": "Subject of the Email"
},
"body": {
"fieldName": "body",
"view": "write",
"type": "string",
"required": false,
"label": "Email Body",
"labelPlural": "Email Bodies",
"help": "Body of the Email."
},
"inherited": {
"fieldName": "inherited",
"view": "read",
"type": "boolean",
"required": true,
"label": "Inherited?",
"labelPlural": "Inherited?",
"help": "Is this template inherited from a parent company?"
}
},
"html": {
"subject": {
"fieldName": "subject",
"view": "write",
"type": "string",
"required": false,
"label": "Email Subject",
"labelPlural": "Email Subjects",
"help": "Subject of the Email"
},
"body": {
"fieldName": "body",
"view": "write",
"type": "string",
"required": false,
"label": "Email Body",
"labelPlural": "Email Bodies",
"help": "Body of the Email."
},
"inherited": {
"fieldName": "inherited",
"view": "read",
"type": "boolean",
"required": true,
"label": "Inherited?",
"labelPlural": "Inherited?",
"help": "Is this template inherited from a parent company?"
}
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_EMAIL_TEMPLATE",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Email Template ¶
Get Email TemplateGET/api/v3.1/companies/{companyCd}/emailTemplates/{emailTemplateLcd}{?editParameters}
- Types of Responses
- Response 200 - If Email Template is retrieved
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/emailTemplates/CI_EMAIL_TEMPLATE_PASSWORD_RESET_LINK?editParameters=false
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- emailTemplateLcd
string(required) Example: CI_EMAIL_TEMPLATE_PASSWORD_RESET_LINK- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"emailTemplateLcd": "CI_EMAIL_TEMPLATE_PASSWORD_RESET_LINK",
"description": "Password Reset - Link",
"text": {
"subject": "My Subject",
"body": "My email body.",
"inherited": false
},
"html": {
"subject": "My Subject",
"body": "My email body.",
"inherited": false
},
"editParameters": {
"emailTemplateLcd": {
"fieldName": "emailTemplateLcd",
"view": "read",
"type": "string",
"required": true,
"label": "Email Template LCD",
"labelPlural": "Email Template LCDs",
"help": "Unique identifier for the Email Template Lookup."
},
"description": {
"fieldName": "description",
"view": "read",
"type": "string",
"required": true,
"label": "Description",
"labelPlural": "Descriptions",
"help": "Email Template description"
},
"text": {
"subject": {
"fieldName": "subject",
"view": "write",
"type": "string",
"required": false,
"label": "Email Subject",
"labelPlural": "Email Subjects",
"help": "Subject of the Email"
},
"body": {
"fieldName": "body",
"view": "write",
"type": "string",
"required": false,
"label": "Email Body",
"labelPlural": "Email Bodies",
"help": "Body of the Email."
},
"inherited": {
"fieldName": "inherited",
"view": "read",
"type": "boolean",
"required": true,
"label": "Inherited?",
"labelPlural": "Inherited?",
"help": "Is this template inherited from a parent company?"
}
},
"html": {
"subject": {
"fieldName": "subject",
"view": "write",
"type": "string",
"required": false,
"label": "Email Subject",
"labelPlural": "Email Subjects",
"help": "Subject of the Email"
},
"body": {
"fieldName": "body",
"view": "write",
"type": "string",
"required": false,
"label": "Email Body",
"labelPlural": "Email Bodies",
"help": "Body of the Email."
},
"inherited": {
"fieldName": "inherited",
"view": "read",
"type": "boolean",
"required": true,
"label": "Inherited?",
"labelPlural": "Inherited?",
"help": "Is this template inherited from a parent company?"
}
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_EMAIL_TEMPLATE",
"httpStatus": 200,
"messages": [],
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"emailTemplateLcd": {
"type": "string",
"description": "Lookup CD for the Email Template"
},
"description": {
"type": "string",
"description": "Description of the Email Template"
},
"text": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "Subject of the text email"
},
"body": {
"type": "string",
"description": "Body of the text email"
},
"inherited": {
"type": "boolean",
"description": "Is the template inherited from a parent company?"
}
},
"required": [
"inherited"
]
},
"html": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "Subject of the html email"
},
"body": {
"type": "string",
"description": "Body of the html email"
},
"inherited": {
"type": "boolean",
"description": "Is the template inherited from a parent company?"
}
},
"required": [
"inherited"
]
},
"editParameters": {
"type": "object",
"properties": {
"emailTemplateLcd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"description": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"text": {
"type": "object",
"properties": {
"subject": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"body": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"inherited": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"inherited"
]
},
"html": {
"type": "object",
"properties": {
"subject": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"body": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"inherited": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"boolean",
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "boolean",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"inherited"
]
}
},
"required": [
"emailTemplateLcd",
"description"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"emailTemplateLcd",
"description"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"messages": {
"description": "any messages, including error, that need to be returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Time to execute the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Update a Email TemplatePUT/api/v3.1/companies/{companyCd}/emailTemplates/{emailTemplateLcd}{?editParameters}
Only subject and body for the text and html based templates can be updated. If both subject and body are sent in as NULL then the template will be deleted at the company level and the inherited version will be used again.
Certain text strings will be replaced in both the subject and the body of the email, where appropriate. See the inherited email template for details. Examples are:
[NAME] will be replaced with the first name of the recipient
[COMPANY_NAME] will be replaced with the name of the company
[LOGIN] will be replace with the username of the recipient
[RECOVER_URL] will be replaced with the create your first password URL
[RESET_URL] will be replaced with the password reset URL
[VALID_FOR_HOURS] will be replaced with the expiry of the link in hours (number)
[UNLOCK_URL] will be replaced with the account unlock URL
[RESET_CODE] will be replaced with the password reset code
[VALID_FOR_MINUTES] will be replaced with the expiry of the code in minutes (number)
When requesting editParameters in the return the complete Email Template object will be returned.
- Types of Responses
- Response 200 - Update successful
- Response 409 - Conflict - If the update would invalidate a constraint
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/companies/cK4Uae73unb72TYuDJDr/emailTemplates/CI_EMAIL_TEMPLATE_PASSWORD_RESET_LINK?editParameters=false
URI Parameters
- companyCd
string(required) Example: cK4Uae73unb72TYuDJDr- emailTemplateLcd
string(required) Example: CI_EMAIL_TEMPLATE_PASSWORD_RESET_LINK- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"text": {
"subject": "My Subject",
"body": "My email body."
},
"html": {
"subject": "My Subject",
"body": "My email body."
}
}Schema
{
"type": "object",
"properties": {
"text": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "Subject of the text email"
},
"body": {
"type": "string",
"description": "Body of the text email"
}
}
},
"html": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "Subject of the html email"
},
"body": {
"type": "string",
"description": "Body of the html email"
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"emailTemplateLcd": "CI_EMAIL_TEMPLATE_PASSWORD_RESET_LINK"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_EMAIL_TEMPLATE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"emailTemplateLcd": {
"type": "string",
"description": "Lookup CD of the Email Template"
}
},
"required": [
"emailTemplateLcd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_EMAIL_TEMPLATE",
"messages": [
{
"id": "errorGenericError",
"text": "An example of a generic error message."
}
],
"httpStatus": 409,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"errorGenericError"
],
"description": "Error ID"
},
"text": {
"type": "string",
"enum": [
"An example of a generic error message."
],
"description": "Default text describing the error"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
},
"description": "any messages, including error, that need to be returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"messages",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Application Partner ¶
Currently two Application Partner Types are supported: APT_GOOGLE_PUBSUB and APT_SMARTCORE. The APT_GOOGLE_PUBSUB type has the “googlePubSubInfo” property on the Application Partner object. The APT_SMARTCORE type has the “smartcoreApiKey” property. In the examples below both of these properties are shown, but only one is present depending on the Application Partner type.
Individual companies can add tag elements in the system (Sites, Devices, Users, Partners) with meta data that is specific to their needs. These are generic fields that will appear as regular properties on those objects. They are grouped under a property called customFields, if present on the object. See the Custom Fields section for help on defining these element.
Get Application Partner List ¶
Application Partner ListGET/api/v3.1/applicationPartners{?editParameters,limit,page,orderBy,direction,filter}
Get the Application Partner List. The list consists of Application Partners for all Companies the logged in User has access too.
Example URI
GET https://altairsmartedge.com/api/v3.1/applicationPartners?editParameters=false&limit=100&page=1&orderBy=name&direction=asc&filter=text
URI Parameters
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
- orderBy
string(optional) Default: name Example: nameField to order results by
Choices:
namedescription- direction
string(optional) Default: asc Example: ascSort direction for the results list
Choices:
ascdesc- filter
string(optional) Example: textFilters results by matching text in fields: Name, Description
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"companyCd": "Y78G8zhrVMZcA2RgUSjL",
"name": "Application Partner Name",
"description": "Description of this Partner and service",
"enabled": true,
"partnerTypeLcd": "APT_GOOGLE_PUBSUB",
"messageFormat": "APMF_BUCKETIZED",
"googlePubSubInfo": {
"topic": {
"projectId": "ALTAIR_Project_ID",
"topicName": "Altair Topic Name"
},
"subscription": {
"projectId": "ALTAIR_Project_ID",
"subscriptionName": "Subscription Name",
"subscriptionPushUrl": "https://subscription.push.url"
},
"subscribers": [
{
"infoTypeLcd": "IT_GPUBSUB_SUBSCRIBER_USER",
"value": "user@gmail.com",
"text": "Optional Description"
}
]
},
"smartcoreApiKey": "MyAPIKey"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"companyCd": {
"type": "string",
"enum": [
"Y78G8zhrVMZcA2RgUSjL"
],
"description": "The unique CD of the Company for This Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
},
"description": {
"type": "string",
"enum": [
"Description of this Partner and service"
],
"description": "Description of this Partner and Service"
},
"enabled": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Whether this Partner is currently enabled for processing"
},
"partnerTypeLcd": {
"type": "string",
"enum": [
"APT_GOOGLE_PUBSUB"
],
"default": "APT_GOOGLE_PUBSUB",
"description": "Type of Application Partner"
},
"messageFormat": {
"type": "string",
"enum": [
"APMF_BUCKETIZED",
"APMF_TIMESERIES"
],
"default": "APMF_BUCKETIZED",
"description": "Publish Format for the Usage and Event Telemetry Data"
},
"googlePubSubInfo": {
"type": "object",
"properties": {
"topic": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"enum": [
"ALTAIR_Project_ID"
],
"description": "Project ID used by Altair"
},
"topicName": {
"type": "string",
"enum": [
"Altair Topic Name"
],
"description": "Topic name used by Altair"
}
},
"required": [
"projectId",
"topicName"
],
"additionalProperties": false
},
"subscription": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"enum": [
"ALTAIR_Project_ID"
],
"description": "Project ID used by Altair for this Subscription"
},
"subscriptionName": {
"type": "string",
"enum": [
"Subscription Name"
],
"description": "Subscription name used by Altair"
},
"subscriptionPushUrl": {
"type": "string",
"enum": [
"https://subscription.push.url"
],
"description": "Subscription Push URL"
}
},
"required": [
"projectId",
"subscriptionName"
],
"additionalProperties": false
},
"subscribers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"infoTypeLcd": {
"type": "string",
"enum": [
"IT_GPUBSUB_SUBSCRIBER_USER",
"IT_GPUBSUB_SUBSCRIBER_SERVICE_ACCOUNT"
],
"default": "``"
},
"value": {
"type": "string",
"enum": [
"user@gmail.com"
]
},
"text": {
"type": "string",
"enum": [
"Optional Description"
]
}
},
"required": [
"infoTypeLcd",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"topic",
"subscription",
"subscribers"
],
"additionalProperties": false
},
"smartcoreApiKey": {
"type": "string",
"enum": [
"MyAPIKey"
],
"description": "API Key for SmartCore"
}
},
"required": [
"partnerCd",
"companyCd",
"name",
"partnerTypeLcd"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Application Partner ¶
Get Application PartnersGET/api/v3.1/applicationPartners/{applicationPartnerCd}{?editParameters}
Get an Application Partner
Example URI
GET https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV?editParameters=false
URI Parameters
- applicationPartnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVUnique identifier assigned for an Application Partner
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"companyCd": "Y78G8zhrVMZcA2RgUSjL",
"name": "Application Partner Name",
"description": "Description of this Partner and service",
"enabled": true,
"partnerTypeLcd": "APT_GOOGLE_PUBSUB",
"messageFormat": "APMF_BUCKETIZED",
"googlePubSubInfo": {
"topic": {
"projectId": "ALTAIR_Project_ID",
"topicName": "Altair Topic Name"
},
"subscription": {
"projectId": "ALTAIR_Project_ID",
"subscriptionName": "Subscription Name",
"subscriptionPushUrl": "https://subscription.push.url"
},
"subscribers": [
{
"infoTypeLcd": "IT_GPUBSUB_SUBSCRIBER_USER",
"value": "user@gmail.com",
"text": "Optional Description"
}
]
},
"smartcoreApiKey": "MyAPIKey"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"description": "The unique CD for the Application Partner"
},
"companyCd": {
"type": "string",
"description": "The unique CD of the Company for This Application Partner"
},
"name": {
"type": "string",
"description": "The unique name of the Application Partner"
},
"description": {
"type": "string",
"description": "Description of this Partner and Service"
},
"enabled": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Whether this Partner is currently enabled for processing"
},
"partnerTypeLcd": {
"type": "string",
"enum": [
"APT_GOOGLE_PUBSUB"
],
"default": "APT_GOOGLE_PUBSUB",
"description": "Type of Application Partner"
},
"messageFormat": {
"type": "string",
"enum": [
"APMF_BUCKETIZED",
"APMF_TIMESERIES"
],
"default": "APMF_BUCKETIZED",
"description": "Publish Format for the Usage and Event Telemetry Data"
},
"googlePubSubInfo": {
"type": "object",
"properties": {
"topic": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Project ID used by Altair"
},
"topicName": {
"type": "string",
"description": "Topic name used by Altair"
}
},
"required": [
"projectId",
"topicName"
]
},
"subscription": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Project ID used by Altair for this Subscription"
},
"subscriptionName": {
"type": "string",
"description": "Subscription name used by Altair"
},
"subscriptionPushUrl": {
"type": "string",
"description": "Subscription Push URL"
}
},
"required": [
"projectId",
"subscriptionName"
]
},
"subscribers": {
"type": "array"
}
},
"required": [
"topic",
"subscription",
"subscribers"
]
},
"smartcoreApiKey": {
"type": "string",
"description": "API Key for SmartCore"
}
},
"required": [
"partnerCd",
"companyCd",
"name",
"partnerTypeLcd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data",
"meta"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Create an Application PartnerPOST/api/v3.1/applicationPartners/
Create an Application Partner.
The User of the API must know the partnerTypeLcd that is desired to be created. When creating a APT_GOOGLE_PUBSUB Application Partner the googlePubSubInfo section needs to be passed in, but not the smartcoreApiKey section. When creating a APT_SMARTCORE Application Partner the smartcoreApiKey section needs to be passed in, but not the googlePubSubInfo section.
The projectId for both the topic and subscription sections of googlePubSubInfo can be left blank; the backend will fill in the default projectId.
The publish format for the usage and event telemetry data supports two formats. The default is APMF_BUCKETIZED.
Example of the APMF_BUCKETIZED format:
{
"data":{
"usages":{
"ekFmE6WCH4ZX15Mnf88c":{
"1483257600":{
"MONTH":{
"KWH":{
"8":-111.158,
"TOTAL_YEAR":-1
}
}
},
"1501570800":{
"DAY":{
"KWH":{
"23":-85.252,
"TOTAL_MONTH":-111
}
}
},
"1503385200":{
"30SEC":{
"KWH_ODM":{
"2871":1111.213,
"2872":1114.954,
"2873":1118.461,
"2874":1121.306
},
"KW_AVG":{
"2873":10
},
"KWH":{
"2873":0.083
}
}
},
"1503471600":{
"15MIN":{
"KWH_ODM":{
"30":1037.569
},
"KWH":{
"30":0.965
},
"KW_AVG":{
"29":0
}
},
"HOUR":{
"KW_MAX":{
"7":7.75,
"TOTAL_DAY":10
},
"KWH":{
"7":0.932,
"TOTAL_DAY":-85
}
}
}
}
}
}
}Example of the APMF_TIMESERIES format:
{
"data":{
"usages":[
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"30SEC",
"usageType":"KWH_ODM",
"timestamp":1508228640,
"value":1007.434
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"30SEC",
"usageType":"KW_AVG",
"timestamp":1508228610,
"value":0
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"30SEC",
"usageType":"KWH",
"timestamp":1508228610,
"value":0
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"15MIN",
"usageType":"KWH_ODM",
"timestamp":1508228100,
"value":1006.558
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"15MIN",
"usageType":"KWH",
"timestamp":1508228100,
"value":1.539
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"15MIN",
"usageType":"KW_AVG",
"timestamp":1508227200,
"value":10
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"HOUR",
"usageType":"KW_MAX",
"timestamp":1507208400,
"value":10
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"HOUR",
"usageType":"KW_MAX",
"timestamp":1507186800,
"totalDay":10
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"HOUR",
"usageType":"KWH",
"timestamp":1507208400,
"value":3.2
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"HOUR",
"usageType":"KW_MAX",
"timestamp":1508227200,
"value":10
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"HOUR",
"usageType":"KW_MAX",
"timestamp":1508223600,
"totalDay":10
},
{
"deviceCd":"U3qOw7Y2k715P5z7CGyM",
"intervalType":"HOUR",
"usageType":"KWH",
"timestamp":1508227200,
"value":0.084
}
]
}
}Example URI
POST https://altairsmartedge.com/api/v3.1/applicationPartners/
Request
Body
{
"companyCd": "Y78G8zhrVMZcA2RgUSjL",
"name": "Application Partner Name",
"description": "Description of this Partner and service",
"enabled": true,
"partnerTypeLcd": "APT_GOOGLE_PUBSUB",
"messageFormat": "APMF_BUCKETIZED",
"googlePubSubInfo": {
"topic": {
"projectId": "ALTAIR_Project_ID",
"topicName": "Altair Topic Name"
},
"subscription": {
"projectId": "ALTAIR_Project_ID",
"subscriptionName": "Subscription Name",
"subscriptionPushUrl": "https://subscription.push.url"
},
"subscribers": [
{
"infoTypeLcd": "IT_GPUBSUB_SUBSCRIBER_USER",
"value": "user@gmail.com",
"text": "Optional Description"
}
]
},
"smartcoreApiKey": "MyAPIKey"
}Schema
{
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "The unique CD of the Company for This Application Partner"
},
"name": {
"type": "string",
"description": "The unique name of the Application Partner"
},
"description": {
"type": "string",
"description": "Description of this Partner and Service"
},
"enabled": {
"enum": [
true,
false
],
"description": "Whether this Partner is currently enabled for processing"
},
"partnerTypeLcd": {
"enum": [
"APT_GOOGLE_PUBSUB",
"APT_SMARTCORE"
],
"description": "Type of Application Partner"
},
"messageFormat": {
"enum": [
"APMF_BUCKETIZED",
"APMF_TIMESERIES"
],
"description": "Publish Format for the Usage and Event Telemetry Data"
},
"googlePubSubInfo": {
"type": "object",
"properties": {
"topic": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Project ID used by Altair"
},
"topicName": {
"type": "string",
"description": "Topic name used by Altair"
}
},
"required": [
"projectId",
"topicName"
]
},
"subscription": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Project ID used by Altair for this Subscription"
},
"subscriptionName": {
"type": "string",
"description": "Subscription name used by Altair"
},
"subscriptionPushUrl": {
"type": "string",
"description": "Subscription Push URL"
}
},
"required": [
"projectId",
"subscriptionName"
]
},
"subscribers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"infoTypeLcd": {
"enum": [
"IT_GPUBSUB_SUBSCRIBER_USER",
"IT_GPUBSUB_SUBSCRIBER_SERVICE_ACCOUNT"
]
},
"value": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"infoTypeLcd",
"value"
]
}
}
},
"required": [
"topic",
"subscription",
"subscribers"
]
},
"smartcoreApiKey": {
"type": "string",
"description": "API Key for SmartCore"
}
},
"required": [
"companyCd",
"name",
"partnerTypeLcd"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"companyCd": "Y78G8zhrVMZcA2RgUSjL",
"name": "Application Partner Name",
"description": "Description of this Partner and service",
"enabled": true,
"partnerTypeLcd": "APT_GOOGLE_PUBSUB",
"messageFormat": "APMF_BUCKETIZED",
"googlePubSubInfo": {
"topic": {
"projectId": "ALTAIR_Project_ID",
"topicName": "Altair Topic Name"
},
"subscription": {
"projectId": "ALTAIR_Project_ID",
"subscriptionName": "Subscription Name",
"subscriptionPushUrl": "https://subscription.push.url"
},
"subscribers": [
{
"infoTypeLcd": "IT_GPUBSUB_SUBSCRIBER_USER",
"value": "user@gmail.com",
"text": "Optional Description"
}
]
},
"smartcoreApiKey": "MyAPIKey"
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data",
"meta"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Update an Application PartnerPUT/api/v3.1/applicationPartners/{applicationPartnerCd}{?editParameters}
Update a Application Partner
When updating a APT_GOOGLE_PUBSUB Application Partner, if you want to change any part of a subscriber, you must send in all the other subscribers as well. Otherwise, the API will think you are asking to delete the others.
When requesting editParameters in the return the complete applicationPartner object will be returned.
Example URI
PUT https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV?editParameters=false
URI Parameters
- applicationPartnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVUnique identifier assigned for an Application Partner
- editParameters
string(optional) Default: false Example: falsetrue/false, returns editParameters
Choices:
truefalse
Request
Body
{
"companyCd": "Y78G8zhrVMZcA2RgUSjL",
"name": "Application Partner Name",
"description": "Description of this Partner and service",
"enabled": true,
"partnerTypeLcd": "APT_GOOGLE_PUBSUB",
"messageFormat": "APMF_BUCKETIZED",
"googlePubSubInfo": {
"topic": {
"projectId": "ALTAIR_Project_ID",
"topicName": "Altair Topic Name"
},
"subscription": {
"projectId": "ALTAIR_Project_ID",
"subscriptionName": "Subscription Name",
"subscriptionPushUrl": "https://subscription.push.url"
},
"subscribers": [
{
"infoTypeLcd": "IT_GPUBSUB_SUBSCRIBER_USER",
"value": "user@gmail.com",
"text": "Optional Description"
}
]
},
"smartcoreApiKey": "MyAPIKey"
}Schema
{
"type": "object",
"properties": {
"companyCd": {
"type": "string",
"description": "The unique CD of the Company for This Application Partner"
},
"name": {
"type": "string",
"description": "The unique name of the Application Partner"
},
"description": {
"type": "string",
"description": "Description of this Partner and Service"
},
"enabled": {
"enum": [
true,
false
],
"description": "Whether this Partner is currently enabled for processing"
},
"partnerTypeLcd": {
"enum": [
"APT_GOOGLE_PUBSUB",
"APT_SMARTCORE"
],
"description": "Type of Application Partner"
},
"messageFormat": {
"enum": [
"APMF_BUCKETIZED",
"APMF_TIMESERIES"
],
"description": "Publish Format for the Usage and Event Telemetry Data"
},
"googlePubSubInfo": {
"type": "object",
"properties": {
"topic": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Project ID used by Altair"
},
"topicName": {
"type": "string",
"description": "Topic name used by Altair"
}
},
"required": [
"projectId",
"topicName"
]
},
"subscription": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Project ID used by Altair for this Subscription"
},
"subscriptionName": {
"type": "string",
"description": "Subscription name used by Altair"
},
"subscriptionPushUrl": {
"type": "string",
"description": "Subscription Push URL"
}
},
"required": [
"projectId",
"subscriptionName"
]
},
"subscribers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"infoTypeLcd": {
"enum": [
"IT_GPUBSUB_SUBSCRIBER_USER",
"IT_GPUBSUB_SUBSCRIBER_SERVICE_ACCOUNT"
]
},
"value": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"infoTypeLcd",
"value"
]
}
}
},
"required": [
"topic",
"subscription",
"subscribers"
]
},
"smartcoreApiKey": {
"type": "string",
"description": "API Key for SmartCore"
}
},
"required": [
"companyCd",
"name",
"partnerTypeLcd"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"partnerCd": "MZcA2RgUSjLY78G8zhrV"
},
"meta": {
"responseCode": 200,
"responseType": "JSON",
"responseDataType": "RESPONSE_OK",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"description": "The unique CD for the Application Partner"
}
},
"required": [
"partnerCd"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data",
"meta"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Delete an Application PartnerDELETE/api/v3.1/applicationPartners/{applicationPartnerCd}
Delete an Application Partner
Example URI
DELETE https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV
URI Parameters
- applicationPartnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVUnique identifier assigned for an Application Partner
Response
204Headers
Content-Type: application/jsonResponse
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Site Verifications ¶
Get Site Verification List ¶
Site Verification ListGET/api/v3.1/applicationPartners/{applicationPartnerCd}/siteVerifications
Get the list of Site Verifications for the Application Partner
- Types of Responses
- Response 200 - Retrieval successful
- Response 409 - Conflict - If the request would validate a constraint
Example URI
GET https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV/siteVerifications
URI Parameters
- applicationPartnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVUnique identifier assigned for an Application Partner
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"verificationId": "ZcA2RgUSY78G8zhrVMjL",
"url": "http://www.example.com",
"verified": true
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_SITE_VERIFICATION",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verificationId": {
"type": "string",
"enum": [
"ZcA2RgUSY78G8zhrVMjL"
],
"description": "The unique CD of the Site Verification"
},
"url": {
"type": "string",
"enum": [
"http://www.example.com"
],
"description": "The URL used for the verification"
},
"verified": {
"type": "boolean",
"enum": [
true
],
"description": "Is the site verified?"
}
},
"required": [
"verificationId",
"url",
"verified"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Site Verification ¶
Get Site VerificationGET/api/v3.1/applicationPartners/{applicationPartnerCd}/siteVerifications/{verificationId}
Get a Site Verification of an Application Partner
- Types of Responses
- Response 200 - Retrieval successful
- Response 409 - Conflict - If the request would validate a constraint
Example URI
GET https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV/siteVerifications/ZcA2RgUSY78G8zhrVMjL
URI Parameters
- applicationPartnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVUnique identifier assigned to an Application Partner
- verificationId
string(required) Example: ZcA2RgUSY78G8zhrVMjLUnique identifier assigned to a Site Verification
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"verificationId": "ZcA2RgUSY78G8zhrVMjL",
"url": "http://www.example.com",
"verified": true
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SITE_VERIFICATION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"verificationId": {
"type": "string",
"enum": [
"ZcA2RgUSY78G8zhrVMjL"
],
"description": "The unique CD of the Site Verification"
},
"url": {
"type": "string",
"enum": [
"http://www.example.com"
],
"description": "The URL used for the verification"
},
"verified": {
"type": "boolean",
"enum": [
true
],
"description": "Is the site verified?"
}
},
"required": [
"verificationId",
"url",
"verified"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Create a Site VerificationPOST/api/v3.1/applicationPartners/{applicationPartnerCd}/siteVerifications/
Create a Site Verification for Google. The HTML file upload method is supported. For more information see https://support.google.com/webmasters/answer/35179.
Site verification uses a site URL as input, e.g., http://www.mysite.com. After successfully creating a new entry a verification file needs to be downloaded and installed at the URL used as input, e.g., http://www.mysite.com/downloadedVerificationFile.html.
- Types of Responses
- Response 200 - Create successful - verificationId returned
- Response 409 - Conflict - If the create would validate a constraint
Example URI
POST https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV/siteVerifications/
URI Parameters
- applicationPartnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVUnique identifier assigned to an Application Partner
Request
Body
{
"url": "http://www.example.com"
}Schema
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL used for the verification"
}
},
"required": [
"url"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"verificationId": "ZcA2RgUSY78G8zhrVMjL"
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SITE_VERIFICATION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"verificationId": {
"type": "string",
"enum": [
"ZcA2RgUSY78G8zhrVMjL"
],
"description": "The unique CD of the Site Verification"
}
},
"required": [
"verificationId"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Delete a Site VerificationDELETE/api/v3.1/applicationPartners/{applicationPartnerCd}/siteVerifications/{verificationId}
Delete a Site Verification. This will also remove the verification with Google.
- Types of Responses
- Response 204 - Delete successful - no body returned
- Response 409 - Conflict - If the delete would validate a constraint
Example URI
DELETE https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV/siteVerifications/ZcA2RgUSY78G8zhrVMjL
URI Parameters
- applicationPartnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVUnique identifier assigned to an Application Partner
- verificationId
string(required) Example: ZcA2RgUSY78G8zhrVMjLUnique identifier assigned to a Site Verification
Response
204Headers
Content-Type: application/jsonResponse
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Get Verification File ¶
Get Verification FileGET/api/v3.1/applicationPartners/{applicationPartnerCd}/siteVerifications/{verificationId}/actions/getFile
Downloads the verification file that needs to be uploaded to the URL of the Site Verification.
- Types of Responses
- Response 200 - Retrieval successful - File as body
- Response 409 - Conflict - If the request would validate a constraint
Example URI
GET https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV/siteVerifications/ZcA2RgUSY78G8zhrVMjL/actions/getFile
URI Parameters
- applicationPartnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVUnique identifier assigned for an Application Partner
- verificationId
string(required) Example: ZcA2RgUSY78G8zhrVMjLUnique identifier assigned to a Site Verification
Response
200Headers
Content-Type: text/plainResponse
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Verify Site ¶
Verify SiteGET/api/v3.1/applicationPartners/{applicationPartnerCd}/siteVerifications/{verificationId}/actions/verify
Verifies the site with Google. Requires verification file to be installed.
- Types of Responses
- Response 200 - Verification successful
- Response 409 - Conflict - If the request would validate a constraint
Example URI
GET https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV/siteVerifications/ZcA2RgUSY78G8zhrVMjL/actions/verify
URI Parameters
- applicationPartnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVUnique identifier assigned for an Application Partner
- verificationId
string(required) Example: ZcA2RgUSY78G8zhrVMjLUnique identifier assigned to a Site Verification
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"verificationId": "ZcA2RgUSY78G8zhrVMjL",
"url": "http://www.example.com",
"verified": true
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_SITE_VERIFICATION",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"verificationId": {
"type": "string",
"enum": [
"ZcA2RgUSY78G8zhrVMjL"
],
"description": "The unique CD of the Site Verification"
},
"url": {
"type": "string",
"enum": [
"http://www.example.com"
],
"description": "The URL used for the verification"
},
"verified": {
"type": "boolean",
"enum": [
true
],
"description": "Is the site verified?"
}
},
"required": [
"verificationId",
"url",
"verified"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"data": {},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_APPLICATION_PARTNER_ERROR",
"httpStatus": 409,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"default": "JSON",
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Application Partner Activity Data ¶
We track activity data for Application Partners in bucketized intervals. The following data is tracked:
- the number of usage data points published to Google PubSub for the Application Partner
The data is stored in UTC time.
Get Application Partner Activity Data ¶
Get Application Partner Activity DataGET/api/v3.1/applicationPartners/{partnerCd}/actions/getActivityData{?activityType,increment,startDateTime,endDateTime}
See also: Global Failures
- activityType - as per table below
| Activity Type LCD | Description |
|---|---|
| BDC_GPUBSUB_DATA_POINTS | Google PubSub Data Points Published Count |
- incrementType - as per table below
| Increment LCD | Description |
|---|---|
| UD_INC_15MIN | 15 Minutes |
| UD_INC_HOUR | Hourly |
| UD_INC_DAY | Daily |
| UD_INC_MONTH | Monthly |
Example URI
GET https://altairsmartedge.com/api/v3.1/applicationPartners/MZcA2RgUSjLY78G8zhrV/actions/getActivityData?activityType=BDC_GPUBSUB_DATA_POINTS&increment=UD_INC_15MIN&startDateTime=2017-09-01T00:00:00-00:00&endDateTime=2017-09-02T00:00:00-00:00
URI Parameters
- partnerCd
string(required) Example: MZcA2RgUSjLY78G8zhrVCD of the Application Partner
- activityType
string(required) Example: BDC_GPUBSUB_DATA_POINTSThe LCD of the activity type being sought
- increment
string(required) Example: UD_INC_15MINThe LCD of the increment desired
- startDateTime
string(required) Example: 2017-09-01T00:00:00-00:00The Start Date and Time of the Events being sought
- endDateTime
string(optional) Example: 2017-09-02T00:00:00-00:00The End Date and Time of the Events being sought. If not provided, presumes now.
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Partner Name",
"values": [
{
"startDateTime": "2017-09-01T10:15:00-07:00",
"value": 221
}
]
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_PARTNER_ACTIVITY_DATA",
"httpStatus": 200,
"timeStamp": "2017-09-03T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"description": "The Partner CD"
},
"name": {
"type": "string",
"description": "The full name of the Partner"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startDateTime": {
"type": "string",
"enum": [
"2017-09-01T10:15:00-07:00"
],
"description": "The start dateTime of this value."
},
"value": {
"type": "number",
"enum": [
221
],
"description": "The value for this dateTime"
}
},
"required": [
"startDateTime",
"value"
],
"additionalProperties": false
},
"description": "Array of Activity Data"
}
},
"required": [
"partnerCd",
"name",
"values"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Sync Files ¶
Sync File List ¶
When a Site (gateway) is updated the cloud generates a so-called Sync File to send to the gateway. These Sync Files are stored for 30 days and can be retrieved and/or used for restoring a Site’s Device to the state as found in the Sync File. If the Device does not exists on the Cloud anymore it can be added back.
The Sync Files are stored by date and can be listed by using the complete datetime properties as decribed in the following endpoints.
Get Sync File List YearsGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles
This will return all available years for use in the next endpoint.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of available Years for Sync Files
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"2019": {}
},
"meta": {
"responseCode": 200,
"responseType": "JSON",
"responseDataType": "ALTAIR_LIST_SYNC_FILES",
"httpStatus": 200,
"timeStamp": "2019-04-24T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"2019": {
"type": "object",
"properties": {}
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Get Sync File List MonthsGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}
This will return all available months for use in the next endpoint.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of available Months for Sync Files
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"2019": {
"04": {}
}
},
"meta": {
"responseCode": 200,
"responseType": "JSON",
"responseDataType": "ALTAIR_LIST_SYNC_FILES",
"httpStatus": 200,
"timeStamp": "2019-04-24T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"2019": {
"type": "object",
"properties": {
"04": {
"type": "object",
"properties": {}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Get Sync File List DaysGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}/{month}
This will return all available days for use in the next endpoint.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of available Days for Sync Files
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019/04
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
- month
string(required) Example: 04Month
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"2019": {
"04": {
"23": {}
}
}
},
"meta": {
"responseCode": 200,
"responseType": "JSON",
"responseDataType": "ALTAIR_LIST_SYNC_FILES",
"httpStatus": 200,
"timeStamp": "2019-04-24T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"2019": {
"type": "object",
"properties": {
"04": {
"type": "object",
"properties": {
"23": {
"type": "object",
"properties": {}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Get Sync File List HoursGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}/{month}/{day}
This will return all available hours for use in the next endpoint.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of available Hours for Sync Files
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019/04/23
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
- month
string(required) Example: 04Month
- day
string(required) Example: 23Day
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"2019": {
"04": {
"23": {
"13": {}
}
}
}
},
"meta": {
"responseCode": 200,
"responseType": "JSON",
"responseDataType": "ALTAIR_LIST_SYNC_FILES",
"httpStatus": 200,
"timeStamp": "2019-04-24T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"2019": {
"type": "object",
"properties": {
"04": {
"type": "object",
"properties": {
"23": {
"type": "object",
"properties": {
"13": {
"type": "object",
"properties": {}
}
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Get Sync File List MinutesGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}/{month}/{day}/{hour}
This will return all available minutes for use in the next endpoint.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of available Minutes for Sync Files
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019/04/23/13
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
- month
string(required) Example: 04Month
- day
string(required) Example: 23Day
- hour
string(required) Example: 13Hour
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"2019": {
"04": {
"23": {
"13": {
"49": {}
}
}
}
}
},
"meta": {
"responseCode": 200,
"responseType": "JSON",
"responseDataType": "ALTAIR_LIST_SYNC_FILES",
"httpStatus": 200,
"timeStamp": "2019-04-24T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"2019": {
"type": "object",
"properties": {
"04": {
"type": "object",
"properties": {
"23": {
"type": "object",
"properties": {
"13": {
"type": "object",
"properties": {
"49": {
"type": "object",
"properties": {}
}
}
}
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Get Sync File List SecondsGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}/{month}/{day}/{hour}/{minute}
This will return all available seconds for use in the next endpoint.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of available Seconds for Sync Files
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019/04/23/13/49
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
- month
string(required) Example: 04Month
- day
string(required) Example: 23Day
- hour
string(required) Example: 13Hour
- minute
string(required) Example: 49Minute
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"2019": {
"04": {
"23": {
"13": {
"49": {
"56": []
}
}
}
}
}
},
"meta": {
"responseCode": 200,
"responseType": "JSON",
"responseDataType": "ALTAIR_LIST_SYNC_FILES",
"httpStatus": 200,
"timeStamp": "2019-04-24T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"2019": {
"type": "object",
"properties": {
"04": {
"type": "object",
"properties": {
"23": {
"type": "object",
"properties": {
"13": {
"type": "object",
"properties": {
"49": {
"type": "object",
"properties": {
"56": {}
}
}
}
}
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Get Sync File List FilenamesGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}/{month}/{day}/{hour}/{minute}/{second}
This will return all available Sync Files.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of available Sync Files
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019/04/23/13/49/56
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
- month
string(required) Example: 04Month
- day
string(required) Example: 23Day
- hour
string(required) Example: 13Hour
- minute
string(required) Example: 49Minute
- second
string(required) Example: 56Second
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"2019": {
"04": {
"23": {
"13": {
"49": {
"56": [
"syncFile.json_v2"
]
}
}
}
}
}
},
"meta": {
"responseCode": 200,
"responseType": "JSON",
"responseDataType": "ALTAIR_LIST_SYNC_FILES",
"httpStatus": 200,
"timeStamp": "2019-04-24T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"2019": {
"type": "object",
"properties": {
"04": {
"type": "object",
"properties": {
"23": {
"type": "object",
"properties": {
"13": {
"type": "object",
"properties": {
"49": {
"type": "object",
"properties": {
"56": {
"type": "array",
"description": "List of Sync File Names"
}
}
}
}
}
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "Length of time it took to process the request"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"meta"
]
}Sync File ¶
Get Sync FileGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}/{month}/{day}/{hour}/{minute}/{second}/{fileName}
This will download the contents of the Sync File. (Note, the response example below has most data removed to keep it concise.)
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019/04/23/13/49/56/syncFile.json_v2
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
- month
string(required) Example: 04Month
- day
string(required) Example: 23Day
- hour
string(required) Example: 13Hour
- minute
string(required) Example: 49Minute
- second
string(required) Example: 56Second
- fileName
string(required) Example: syncFile.json_v2Name of the Sync File
Response
200Headers
Content-Type: application/jsonBody
{
"tblLookup": [],
"tblUser": [],
"tblUserInfo": [],
"tblCompany": [],
"tblHome": [],
"tblHomeInfo": [],
"tblMessage": [],
"tblMessageType": [],
"tblmapUser2Right": [],
"tblProduct": [],
"tblProductType": [],
"tblmapProduct2ProductType": [],
"tblProductDriver": [],
"tblProductDriverInfo": [],
"tblAction": [],
"tblDevice": [
{
"DeviceCd": "fRO2bU0RuJbZETIH4MP8",
"ProductCd": "pcEpjvVoRYQvo87tTJEg",
"HomeCd": "vZN42rK0azRwEX5H1RWx",
"Name": "CC150 Gateway",
"Location": "1554793008"
},
{
"DeviceCd": "GysRymbOHc6xNotDgDFZ",
"ProductCd": "bBCC8oCwxNR8kFJKL986",
"HomeCd": "vZN42rK0azRwEX5H1RWx",
"Name": "Virtual Power Meter",
"Location": "1554793059"
}
],
"tblSocket": [],
"tblSocketInfo": [],
"tblmapSocket2Device": [],
"tblDeviceInfo": [],
"tblDevicePort": [],
"tblDevicePortInfo": [],
"tblZuulDeviceMap": [],
"tblZuulSubscription": [],
"tblActionMap": [],
"tblActionMapInfo": [],
"tblCustomData": [],
"tblDeviceScene": [],
"tblMacro": [],
"tblTimer": [],
"tblmapTimer2DeviceScene": [],
"tblAlert": [],
"tblAlertInfo": [],
"tblCustomField": [],
"tblCustomFieldInfo": []
}Restore From Sync File ¶
Get Restore Device OptionsGET/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}/{month}/{day}/{hour}/{minute}/{second}/{fileName}/actions/restore/{?page,limit}
This will return a list of Devices found in the Sync File. The Device CDs can be used to restore the Device. If currently not present on the Site then the Device to restore needs to be added using a POST request. If currently present then the Device can be updated (properties will be overwritten) using a PUT request.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Devices for this Site
See also: Global Failures
Example URI
GET https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019/04/23/13/49/56/syncFile.json_v2/actions/restore/?page=1&limit=100
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
- month
string(required) Example: 04Month
- day
string(required) Example: 23Day
- hour
string(required) Example: 13Hour
- minute
string(required) Example: 49Minute
- second
string(required) Example: 56Second
- fileName
string(required) Example: syncFile.json_v2Name of the Sync File
- limit
number(optional) Default: 10 Example: 100Number of items to return
- page
number(optional) Default: 1 Example: 1Which page number to return based on the limit count
Response
200Headers
Content-Type: application/jsonBody
{
"data": [
{
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"imageLink": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/ofcVbSsW0JRNvwy2QZOH/image1.jpg",
"product": {
"productCd": "r1LneacYS2P8en818LS7",
"name": "GE Jasco Appliance Switch Module 45603",
"manufacturerName": "General Electric",
"model": "45603",
"make": "GE Jasco",
"imageLink": "/Factory/images/products/r1LneacYS2P8en818LS7.jpg",
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "Z-Wave Switch",
"protocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
]
},
"devicePorts": [
{
"devicePortCd": "cdW4t2rtfwrttyuNkobLr7P",
"name": "Ethernet",
"productPortCd": "PORT-ETHERNET"
}
],
"actions": [
{
"name": "POWER_ON",
"description": "Turns the Power ON",
"controllable": true,
"requiresParam": true
}
],
"bridge": "Z-Stick S2-Z-Wave Radio Frequency",
"settings": {
"dataUsagePollSecs": "UD_INC_30SEC",
"usageTypes": [
"UD_DTYPE_KWH",
"UD_DTYPE_KWH_ODM"
],
"streamLabels": [
"DL_TEMPERATURE",
"DL_MODE"
],
"customProductTemplate": "OGh0rLJ1b0eiimYozJ7Z"
},
"network": {
"isNetworkLinkDevice": false,
"showNetworkLink": false
},
"status": {
"needsAttention": false,
"operationsStatus": "OPERATIONS_STATUS_ACTIVE"
},
"audit": {
"addedBy": "3j43hfhbk454d",
"addedByName": "My User",
"addedDate": "2018-03-15 08:35:48",
"modifiedBy": "3j43hfhbk454d",
"modifiedByName": "My User",
"modifiedDate": "2018-03-15 08:39:43"
},
"authorized": true,
"authorizationRequired": true,
"applicationPartners": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Application Partner Name"
}
],
"editParameters": {
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"location": {
"fieldName": "location",
"view": "write",
"type": "string",
"required": true,
"label": "Location",
"labelPlural": "Locations",
"help": "A User editable field that provides for a physical location of the Device."
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "string",
"required": true,
"label": "Image",
"labelPlural": "Images",
"help": "A picture of the Device or Site."
},
"settings": {
"usageTypes": {
"fieldName": "usageTypes",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "List of Usage Types"
},
"streamLabels": {
"fieldName": "streamLabels",
"view": "read",
"type": "anyOf",
"required": false,
"label": "Stream Label",
"labelPlural": "Stream Labels",
"help": "List of Stream Labels"
},
"customProductTemplate": {
"fieldName": "customProductTemplate",
"view": "read",
"type": "oneOf",
"required": false,
"label": "Custom Product Template",
"labelPlural": "Custom Product Templates",
"help": "List of Custom Product Templates"
}
},
"network": {
"isNetworkLinkDevice": {
"fieldName": "isNetworkLinkDevice",
"view": "read",
"type": "string",
"required": false,
"label": "Is Network Link Device",
"labelPlural": "Is Network Link Device",
"help": "Is this a Network Link Device?"
}
},
"status": {
"operationsStatus": {
"fieldName": "operationsStatus",
"view": "write",
"type": "string",
"required": false,
"label": "Operation Status",
"labelPlural": "Operation Statuses",
"help": "Operation Status is optional"
}
},
"audit": {
"addedBy": {
"fieldName": "addedBy",
"view": "read",
"type": "string",
"required": true,
"label": "Added By",
"labelPlural": "Added By",
"help": "CD of User that added the Device"
}
}
}
}
],
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "aALTAIR_DEVICE",
"httpStatus": 200,
"page": {
"number": 1,
"size": 1
},
"result": {
"count": 1,
"total": 1
},
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"enum": [
"ofcVbSsW0JRNvwy2QZOH"
],
"description": "Unique Device code."
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch"
],
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"enum": [
"Bills desk"
],
"description": "Location of the Device as labeled by the User in the Cloud"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/ofcVbSsW0JRNvwy2QZOH/image1.jpg"
],
"description": "URI to image of the Users uploaded image of the Device or Product"
},
"product": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"enum": [
"r1LneacYS2P8en818LS7"
],
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"enum": [
"GE Jasco Appliance Switch Module 45603"
],
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"enum": [
"General Electric"
],
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"enum": [
"45603"
],
"description": "Model name of the Product"
},
"make": {
"type": "string",
"enum": [
"GE Jasco"
],
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"enum": [
"/Factory/images/products/r1LneacYS2P8en818LS7.jpg"
],
"description": "URI to image of the Product"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"qa54NXq0DKgyywN1HpWy"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"name",
"manufacturerName",
"model",
"make",
"imageLink",
"productTypes",
"baseProtocol",
"protocols"
],
"additionalProperties": false,
"description": "Product information"
},
"devicePorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"devicePortCd": {
"type": "string",
"enum": [
"cdW4t2rtfwrttyuNkobLr7P"
],
"description": "Unique identifier for the Device Port"
},
"name": {
"type": "string",
"enum": [
"Ethernet"
],
"description": "The Name of the Device Port (set by Altair)"
},
"productPortCd": {
"type": "string",
"enum": [
"PORT-ETHERNET"
],
"description": "The Port Type (set by Altair)"
}
},
"required": [
"devicePortCd",
"name",
"productPortCd"
],
"additionalProperties": false
},
"description": "List of DevicePorts for this Device"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"POWER_ON"
]
},
"description": {
"type": "string",
"enum": [
"Turns the Power ON"
]
},
"controllable": {
"type": "boolean",
"enum": [
true
]
},
"requiresParam": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"name",
"description",
"controllable",
"requiresParam"
],
"additionalProperties": false
},
"description": "List of Actions"
},
"bridge": {
"type": "string",
"enum": [
"Z-Stick S2-Z-Wave Radio Frequency"
],
"description": "Description of the Bridge being used"
},
"settings": {
"type": "object",
"properties": {
"dataUsagePollSecs": {
"type": "string",
"enum": [
"UD_INC_30SEC",
"UD_INC_15MIN"
],
"description": "Poll interval for meter usage"
},
"usageTypes": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"UD_DTYPE_KWH"
]
},
{
"type": "string",
"enum": [
"UD_DTYPE_KWH_ODM"
]
}
],
"description": "Usage types for a meter"
},
"streamLabels": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"DL_TEMPERATURE"
]
},
{
"type": "string",
"enum": [
"DL_MODE"
]
}
],
"description": "Stream labels for a Device"
},
"customProductTemplate": {
"type": "string",
"enum": [
"OGh0rLJ1b0eiimYozJ7Z"
],
"description": "The CD of the custom product template that has been applied."
}
},
"required": [
"dataUsagePollSecs"
],
"additionalProperties": false,
"description": "Device settings information"
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "boolean",
"enum": [
false
],
"description": "Is this a network link device? (Bridge only.)"
},
"showNetworkLink": {
"type": "boolean",
"enum": [
false
],
"description": "Does the device support network link control? (Bridge only.)"
}
},
"additionalProperties": false,
"description": "Device network information (for bridges)"
},
"status": {
"type": "object",
"properties": {
"needsAttention": {
"type": "boolean",
"enum": [
false
],
"description": "Does the device require attention?"
},
"operationsStatus": {
"type": "string",
"enum": [
"OPERATIONS_STATUS_ACTIVE",
"OPERATIONS_STATUS_INACTIVE"
],
"description": "Device operations status"
}
},
"required": [
"needsAttention",
"operationsStatus"
],
"additionalProperties": false,
"description": "Device status information"
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "string",
"enum": [
"3j43hfhbk454d"
],
"description": "The CD of the User who added the Device"
},
"addedByName": {
"type": "string",
"enum": [
"My User"
],
"description": "The name of the User who added the Device"
},
"addedDate": {
"type": "string",
"enum": [
"2018-03-15 08:35:48"
],
"description": "Date the Device was added"
},
"modifiedBy": {
"type": "string",
"enum": [
"3j43hfhbk454d"
],
"description": "The CD of the User who modified the Device"
},
"modifiedByName": {
"type": "string",
"enum": [
"My User"
],
"description": "The name of the User who modified the Device"
},
"modifiedDate": {
"type": "string",
"enum": [
"2018-03-15 08:39:43"
],
"description": "Date the Device was modified"
}
},
"required": [
"addedBy",
"addedByName",
"addedDate"
],
"additionalProperties": false,
"description": "Device audit information"
},
"authorized": {
"type": "boolean",
"enum": [
true
],
"description": "Is the gateway authorized? Only returned for gateway"
},
"authorizationRequired": {
"type": "boolean",
"enum": [
true
],
"description": "Is gateway authorization required? Only returned for gateway"
},
"applicationPartners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
}
},
"required": [
"partnerCd",
"name"
],
"additionalProperties": false
},
"description": "List of ApplicationPartners"
},
"editParameters": {
"type": "object",
"properties": {
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"deviceCd"
],
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Device CD"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Device CDs"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Unique identifier for the Device."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"name"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Name"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Names"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Name is required, and must be unique within a Site"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"location": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"location"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Location"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Locations"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"A User editable field that provides for a physical location of the Device."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"imageLink": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"imageLink"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Image"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Images"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"A picture of the Device or Site."
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"settings": {
"type": "object",
"properties": {
"usageTypes": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"usageTypes"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Usage Type"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Usage Types"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of Usage Types"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"streamLabels": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"streamLabels"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Stream Label"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Stream Labels"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of Stream Labels"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
},
"customProductTemplate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"customProductTemplate"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"anyOf",
"number",
"string",
"onePlusOf",
"object",
"array"
],
"default": [
"oneOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Custom Product Template"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Custom Product Templates"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"List of Custom Product Templates"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"usageTypes",
"streamLabels",
"customProductTemplate"
],
"additionalProperties": false
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"isNetworkLinkDevice"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"anyOf",
"number",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Is Network Link Device"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Is Network Link Device"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Is this a Network Link Device?"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"isNetworkLinkDevice"
],
"additionalProperties": false
},
"status": {
"type": "object",
"properties": {
"operationsStatus": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"operationsStatus"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Operation Status"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Operation Statuses"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"Operation Status is optional"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"operationsStatus"
],
"additionalProperties": false
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"enum": [
"addedBy"
],
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"anyOf",
"number",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"enum": [
"Added By"
],
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"enum": [
"Added By"
],
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"enum": [
"CD of User that added the Device"
],
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"additionalProperties": false,
"description": "Edit info"
}
},
"required": [
"addedBy"
],
"additionalProperties": false
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink",
"settings",
"network",
"status",
"audit"
],
"additionalProperties": false,
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink",
"product",
"devicePorts",
"actions",
"bridge",
"applicationPartners",
"editParameters"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"page": {
"type": "object",
"properties": {
"number": {
"type": "number",
"description": "The current page number we are on"
},
"size": {
"type": "number",
"description": "The total number of pages that are available"
}
},
"required": [
"number",
"size"
]
},
"result": {
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "The number of records in this block being returned"
},
"total": {
"type": "number",
"description": "The total number of records available"
}
},
"required": [
"count",
"total"
]
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
},
"required": [
"data"
]
}Add a Restore DevicePOST/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}/{month}/{day}/{hour}/{minute}/{second}/{fileName}/actions/restore/{restoreDeviceCd}
Use a Device CD from the Sync File to add back a Device that was removed from the Site.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Devices for this Site
See also: Global Failures
Example URI
POST https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019/04/23/13/49/56/syncFile.json_v2/actions/restore/GACE1Tx8GVmN8E7o6JLN
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
- month
string(required) Example: 04Month
- day
string(required) Example: 23Day
- hour
string(required) Example: 13Hour
- minute
string(required) Example: 49Minute
- second
string(required) Example: 56Second
- fileName
string(required) Example: syncFile.json_v2Name of the Sync File
- restoreDeviceCd
string(required) Example: GACE1Tx8GVmN8E7o6JLNThe Device CD of the Device to add back
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"imageLink": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/ofcVbSsW0JRNvwy2QZOH/image1.jpg",
"product": {
"productCd": "r1LneacYS2P8en818LS7",
"name": "GE Jasco Appliance Switch Module 45603",
"manufacturerName": "General Electric",
"model": "45603",
"make": "GE Jasco",
"imageLink": "/Factory/images/products/r1LneacYS2P8en818LS7.jpg",
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "Z-Wave Switch",
"protocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
]
},
"devicePorts": [
{
"devicePortCd": "cdW4t2rtfwrttyuNkobLr7P",
"name": "Ethernet",
"productPortCd": "PORT-ETHERNET"
}
],
"actions": [
{
"name": "POWER_ON",
"description": "Turns the Power ON",
"controllable": true,
"requiresParam": true
}
],
"bridge": "Z-Stick S2-Z-Wave Radio Frequency",
"settings": {
"dataUsagePollSecs": "UD_INC_30SEC",
"usageTypes": [
"UD_DTYPE_KWH",
"UD_DTYPE_KWH_ODM"
],
"streamLabels": [
"DL_TEMPERATURE",
"DL_MODE"
],
"customProductTemplate": "OGh0rLJ1b0eiimYozJ7Z"
},
"network": {
"isNetworkLinkDevice": false,
"showNetworkLink": false
},
"status": {
"needsAttention": false,
"operationsStatus": "OPERATIONS_STATUS_ACTIVE"
},
"audit": {
"addedBy": "3j43hfhbk454d",
"addedByName": "My User",
"addedDate": "2018-03-15 08:35:48",
"modifiedBy": "3j43hfhbk454d",
"modifiedByName": "My User",
"modifiedDate": "2018-03-15 08:39:43"
},
"authorized": true,
"authorizationRequired": true,
"applicationPartners": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Application Partner Name"
}
],
"editParameters": {
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"location": {
"fieldName": "location",
"view": "write",
"type": "string",
"required": true,
"label": "Location",
"labelPlural": "Locations",
"help": "A User editable field that provides for a physical location of the Device."
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "string",
"required": true,
"label": "Image",
"labelPlural": "Images",
"help": "A picture of the Device or Site."
},
"settings": {
"usageTypes": {
"fieldName": "usageTypes",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "List of Usage Types"
},
"streamLabels": {
"fieldName": "streamLabels",
"view": "read",
"type": "anyOf",
"required": false,
"label": "Stream Label",
"labelPlural": "Stream Labels",
"help": "List of Stream Labels"
},
"customProductTemplate": {
"fieldName": "customProductTemplate",
"view": "read",
"type": "oneOf",
"required": false,
"label": "Custom Product Template",
"labelPlural": "Custom Product Templates",
"help": "List of Custom Product Templates"
}
},
"network": {
"isNetworkLinkDevice": {
"fieldName": "isNetworkLinkDevice",
"view": "read",
"type": "string",
"required": false,
"label": "Is Network Link Device",
"labelPlural": "Is Network Link Device",
"help": "Is this a Network Link Device?"
}
},
"status": {
"operationsStatus": {
"fieldName": "operationsStatus",
"view": "write",
"type": "string",
"required": false,
"label": "Operation Status",
"labelPlural": "Operation Statuses",
"help": "Operation Status is optional"
}
},
"audit": {
"addedBy": {
"fieldName": "addedBy",
"view": "read",
"type": "string",
"required": true,
"label": "Added By",
"labelPlural": "Added By",
"help": "CD of User that added the Device"
}
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "Unique Device code."
},
"name": {
"type": "string",
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"description": "Location of the Device as labeled by the User in the Cloud"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Users uploaded image of the Device or Product"
},
"product": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"description": "Model name of the Product"
},
"make": {
"type": "string",
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Product"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"qa54NXq0DKgyywN1HpWy"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"productTypes",
"baseProtocol",
"protocols"
],
"description": "Product information"
},
"devicePorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"devicePortCd": {
"type": "string",
"enum": [
"cdW4t2rtfwrttyuNkobLr7P"
],
"description": "Unique identifier for the Device Port"
},
"name": {
"type": "string",
"enum": [
"Ethernet"
],
"description": "The Name of the Device Port (set by Altair)"
},
"productPortCd": {
"type": "string",
"enum": [
"PORT-ETHERNET"
],
"description": "The Port Type (set by Altair)"
}
},
"required": [
"devicePortCd",
"name",
"productPortCd"
],
"additionalProperties": false
},
"description": "List of DevicePorts for this Device"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"POWER_ON"
]
},
"description": {
"type": "string",
"enum": [
"Turns the Power ON"
]
},
"controllable": {
"type": "boolean",
"enum": [
true
]
},
"requiresParam": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"name",
"description",
"controllable",
"requiresParam"
],
"additionalProperties": false
},
"description": "List of Actions"
},
"bridge": {
"type": "string",
"description": "Description of the Bridge being used"
},
"settings": {
"type": "object",
"properties": {
"dataUsagePollSecs": {
"type": "string",
"enum": [
"UD_INC_30SEC",
"UD_INC_15MIN"
],
"description": "Poll interval for meter usage"
},
"usageTypes": {
"type": "array",
"description": "Usage types for a meter"
},
"streamLabels": {
"type": "array",
"description": "Stream labels for a Device"
},
"customProductTemplate": {
"type": "string",
"description": "The CD of the custom product template that has been applied."
}
},
"required": [
"dataUsagePollSecs"
],
"description": "Device settings information"
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "boolean",
"description": "Is this a network link device? (Bridge only.)"
},
"showNetworkLink": {
"type": "boolean",
"description": "Does the device support network link control? (Bridge only.)"
}
},
"description": "Device network information (for bridges)"
},
"status": {
"type": "object",
"properties": {
"needsAttention": {
"type": "boolean",
"description": "Does the device require attention?"
},
"operationsStatus": {
"type": "string",
"enum": [
"OPERATIONS_STATUS_ACTIVE",
"OPERATIONS_STATUS_INACTIVE"
],
"description": "Device operations status"
}
},
"required": [
"needsAttention",
"operationsStatus"
],
"description": "Device status information"
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "string",
"description": "The CD of the User who added the Device"
},
"addedByName": {
"type": "string",
"description": "The name of the User who added the Device"
},
"addedDate": {
"type": "string",
"description": "Date the Device was added"
},
"modifiedBy": {
"type": "string",
"description": "The CD of the User who modified the Device"
},
"modifiedByName": {
"type": "string",
"description": "The name of the User who modified the Device"
},
"modifiedDate": {
"type": "string",
"description": "Date the Device was modified"
}
},
"required": [
"addedBy",
"addedByName",
"addedDate"
],
"description": "Device audit information"
},
"authorized": {
"type": "boolean",
"description": "Is the gateway authorized? Only returned for gateway"
},
"authorizationRequired": {
"type": "boolean",
"description": "Is gateway authorization required? Only returned for gateway"
},
"applicationPartners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
}
},
"required": [
"partnerCd",
"name"
],
"additionalProperties": false
},
"description": "List of ApplicationPartners"
},
"editParameters": {
"type": "object",
"properties": {
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"location": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"imageLink": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"settings": {
"type": "object",
"properties": {
"usageTypes": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"streamLabels": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"customProductTemplate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"anyOf",
"number",
"string",
"onePlusOf",
"object",
"array"
],
"default": [
"oneOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"usageTypes",
"streamLabels",
"customProductTemplate"
]
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"anyOf",
"number",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"isNetworkLinkDevice"
]
},
"status": {
"type": "object",
"properties": {
"operationsStatus": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"operationsStatus"
]
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"anyOf",
"number",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"addedBy"
]
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink",
"product",
"devicePorts",
"actions",
"bridge",
"applicationPartners"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}Update a Restore DevicePUT/api/v3.1/sites/{siteCd}/devices/{deviceCd}/syncFiles/{year}/{month}/{day}/{hour}/{minute}/{second}/{fileName}/actions/restore/{restoreDeviceCd}
Use a Device CD from the Sync File to add back a Device that was removed from the Site.
- Types of Responses
- Response 200 - Retrieval successful - body contains array of Devices for this Site
See also: Global Failures
Example URI
PUT https://altairsmartedge.com/api/v3.1/sites/cK4Uae73unb72TYuDJDr/devices/E7o6JLNGACE1Tx8GVmN8/syncFiles/2019/04/23/13/49/56/syncFile.json_v2/actions/restore/GACE1Tx8GVmN8E7o6JLN
URI Parameters
- siteCd
string(required) Example: cK4Uae73unb72TYuDJDrCD of the Site
- deviceCd
string(required) Example: E7o6JLNGACE1Tx8GVmN8The Device CD of the Gateway
- year
string(required) Example: 2019Year
- month
string(required) Example: 04Month
- day
string(required) Example: 23Day
- hour
string(required) Example: 13Hour
- minute
string(required) Example: 49Minute
- second
string(required) Example: 56Second
- fileName
string(required) Example: syncFile.json_v2Name of the Sync File
- restoreDeviceCd
string(required) Example: GACE1Tx8GVmN8E7o6JLNThe Device CD of the Device to add back
Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"deviceCd": "ofcVbSsW0JRNvwy2QZOH",
"name": "GE Jasco Appliance Switch",
"location": "Bills desk",
"imageLink": "/Factory/repository/homes/cK4Uae73unb72TYuDJDr/images/ofcVbSsW0JRNvwy2QZOH/image1.jpg",
"product": {
"productCd": "r1LneacYS2P8en818LS7",
"name": "GE Jasco Appliance Switch Module 45603",
"manufacturerName": "General Electric",
"model": "45603",
"make": "GE Jasco",
"imageLink": "/Factory/images/products/r1LneacYS2P8en818LS7.jpg",
"productTypes": [
{
"name": "AHU"
}
],
"baseProtocol": "Z-Wave Switch",
"protocols": [
{
"protocolCd": "qa54NXq0DKgyywN1HpWy",
"name": "Z-Wave Switch",
"version": "1.0"
}
]
},
"devicePorts": [
{
"devicePortCd": "cdW4t2rtfwrttyuNkobLr7P",
"name": "Ethernet",
"productPortCd": "PORT-ETHERNET"
}
],
"actions": [
{
"name": "POWER_ON",
"description": "Turns the Power ON",
"controllable": true,
"requiresParam": true
}
],
"bridge": "Z-Stick S2-Z-Wave Radio Frequency",
"settings": {
"dataUsagePollSecs": "UD_INC_30SEC",
"usageTypes": [
"UD_DTYPE_KWH",
"UD_DTYPE_KWH_ODM"
],
"streamLabels": [
"DL_TEMPERATURE",
"DL_MODE"
],
"customProductTemplate": "OGh0rLJ1b0eiimYozJ7Z"
},
"network": {
"isNetworkLinkDevice": false,
"showNetworkLink": false
},
"status": {
"needsAttention": false,
"operationsStatus": "OPERATIONS_STATUS_ACTIVE"
},
"audit": {
"addedBy": "3j43hfhbk454d",
"addedByName": "My User",
"addedDate": "2018-03-15 08:35:48",
"modifiedBy": "3j43hfhbk454d",
"modifiedByName": "My User",
"modifiedDate": "2018-03-15 08:39:43"
},
"authorized": true,
"authorizationRequired": true,
"applicationPartners": [
{
"partnerCd": "MZcA2RgUSjLY78G8zhrV",
"name": "Application Partner Name"
}
],
"editParameters": {
"deviceCd": {
"fieldName": "deviceCd",
"view": "read",
"type": "string",
"required": true,
"label": "Device CD",
"labelPlural": "Device CDs",
"help": "Unique identifier for the Device."
},
"name": {
"fieldName": "name",
"view": "write",
"type": "string",
"required": true,
"label": "Name",
"labelPlural": "Names",
"help": "Name is required, and must be unique within a Site"
},
"location": {
"fieldName": "location",
"view": "write",
"type": "string",
"required": true,
"label": "Location",
"labelPlural": "Locations",
"help": "A User editable field that provides for a physical location of the Device."
},
"imageLink": {
"fieldName": "imageLink",
"view": "read",
"type": "string",
"required": true,
"label": "Image",
"labelPlural": "Images",
"help": "A picture of the Device or Site."
},
"settings": {
"usageTypes": {
"fieldName": "usageTypes",
"view": "write",
"type": "anyOf",
"required": false,
"label": "Usage Type",
"labelPlural": "Usage Types",
"help": "List of Usage Types"
},
"streamLabels": {
"fieldName": "streamLabels",
"view": "read",
"type": "anyOf",
"required": false,
"label": "Stream Label",
"labelPlural": "Stream Labels",
"help": "List of Stream Labels"
},
"customProductTemplate": {
"fieldName": "customProductTemplate",
"view": "read",
"type": "oneOf",
"required": false,
"label": "Custom Product Template",
"labelPlural": "Custom Product Templates",
"help": "List of Custom Product Templates"
}
},
"network": {
"isNetworkLinkDevice": {
"fieldName": "isNetworkLinkDevice",
"view": "read",
"type": "string",
"required": false,
"label": "Is Network Link Device",
"labelPlural": "Is Network Link Device",
"help": "Is this a Network Link Device?"
}
},
"status": {
"operationsStatus": {
"fieldName": "operationsStatus",
"view": "write",
"type": "string",
"required": false,
"label": "Operation Status",
"labelPlural": "Operation Statuses",
"help": "Operation Status is optional"
}
},
"audit": {
"addedBy": {
"fieldName": "addedBy",
"view": "read",
"type": "string",
"required": true,
"label": "Added By",
"labelPlural": "Added By",
"help": "CD of User that added the Device"
}
}
}
},
"meta": {
"responseCode": 0,
"responseType": "JSON",
"responseDataType": "ALTAIR_DEVICE",
"httpStatus": 200,
"timeStamp": "2016-01-12T16:05:43-07:00",
"elapsed": 112,
"server": "altairsmartedge.com",
"api": {
"version": "3.1",
"endpoint": "altairsmartedge.com/api/v3.1/{endpoint_being_sought}"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deviceCd": {
"type": "string",
"description": "Unique Device code."
},
"name": {
"type": "string",
"description": "Name of the Device as configured by the User in the Cloud"
},
"location": {
"type": "string",
"description": "Location of the Device as labeled by the User in the Cloud"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Users uploaded image of the Device or Product"
},
"product": {
"type": "object",
"properties": {
"productCd": {
"type": "string",
"description": "Unique identifier for a Product"
},
"name": {
"type": "string",
"description": "Name of the Product"
},
"manufacturerName": {
"type": "string",
"description": "Name of the Manufacturer"
},
"model": {
"type": "string",
"description": "Model name of the Product"
},
"make": {
"type": "string",
"description": "Make of the Product"
},
"imageLink": {
"type": "string",
"description": "URI to image of the Product"
},
"productTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"AHU"
],
"description": "Name of the Product Type"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"description": "Array of Product Types"
},
"baseProtocol": {
"type": "string",
"description": "Name of the current Protocol this Device is using"
},
"protocols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocolCd": {
"type": "string",
"enum": [
"qa54NXq0DKgyywN1HpWy"
],
"description": "The unique ID for this Protocols"
},
"name": {
"type": "string",
"enum": [
"Z-Wave Switch"
],
"description": "The name of the Protocols"
},
"version": {
"type": "string",
"enum": [
"1.0"
],
"description": "Which version of the Protocol is supported."
}
},
"required": [
"protocolCd",
"name",
"version"
],
"additionalProperties": false
},
"description": "Array of Product Protocols"
}
},
"required": [
"productCd",
"productTypes",
"baseProtocol",
"protocols"
],
"description": "Product information"
},
"devicePorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"devicePortCd": {
"type": "string",
"enum": [
"cdW4t2rtfwrttyuNkobLr7P"
],
"description": "Unique identifier for the Device Port"
},
"name": {
"type": "string",
"enum": [
"Ethernet"
],
"description": "The Name of the Device Port (set by Altair)"
},
"productPortCd": {
"type": "string",
"enum": [
"PORT-ETHERNET"
],
"description": "The Port Type (set by Altair)"
}
},
"required": [
"devicePortCd",
"name",
"productPortCd"
],
"additionalProperties": false
},
"description": "List of DevicePorts for this Device"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"POWER_ON"
]
},
"description": {
"type": "string",
"enum": [
"Turns the Power ON"
]
},
"controllable": {
"type": "boolean",
"enum": [
true
]
},
"requiresParam": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"name",
"description",
"controllable",
"requiresParam"
],
"additionalProperties": false
},
"description": "List of Actions"
},
"bridge": {
"type": "string",
"description": "Description of the Bridge being used"
},
"settings": {
"type": "object",
"properties": {
"dataUsagePollSecs": {
"type": "string",
"enum": [
"UD_INC_30SEC",
"UD_INC_15MIN"
],
"description": "Poll interval for meter usage"
},
"usageTypes": {
"type": "array",
"description": "Usage types for a meter"
},
"streamLabels": {
"type": "array",
"description": "Stream labels for a Device"
},
"customProductTemplate": {
"type": "string",
"description": "The CD of the custom product template that has been applied."
}
},
"required": [
"dataUsagePollSecs"
],
"description": "Device settings information"
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "boolean",
"description": "Is this a network link device? (Bridge only.)"
},
"showNetworkLink": {
"type": "boolean",
"description": "Does the device support network link control? (Bridge only.)"
}
},
"description": "Device network information (for bridges)"
},
"status": {
"type": "object",
"properties": {
"needsAttention": {
"type": "boolean",
"description": "Does the device require attention?"
},
"operationsStatus": {
"type": "string",
"enum": [
"OPERATIONS_STATUS_ACTIVE",
"OPERATIONS_STATUS_INACTIVE"
],
"description": "Device operations status"
}
},
"required": [
"needsAttention",
"operationsStatus"
],
"description": "Device status information"
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "string",
"description": "The CD of the User who added the Device"
},
"addedByName": {
"type": "string",
"description": "The name of the User who added the Device"
},
"addedDate": {
"type": "string",
"description": "Date the Device was added"
},
"modifiedBy": {
"type": "string",
"description": "The CD of the User who modified the Device"
},
"modifiedByName": {
"type": "string",
"description": "The name of the User who modified the Device"
},
"modifiedDate": {
"type": "string",
"description": "Date the Device was modified"
}
},
"required": [
"addedBy",
"addedByName",
"addedDate"
],
"description": "Device audit information"
},
"authorized": {
"type": "boolean",
"description": "Is the gateway authorized? Only returned for gateway"
},
"authorizationRequired": {
"type": "boolean",
"description": "Is gateway authorization required? Only returned for gateway"
},
"applicationPartners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partnerCd": {
"type": "string",
"enum": [
"MZcA2RgUSjLY78G8zhrV"
],
"description": "The unique CD for the Application Partner"
},
"name": {
"type": "string",
"enum": [
"Application Partner Name"
],
"description": "The unique name of the Application Partner"
}
},
"required": [
"partnerCd",
"name"
],
"additionalProperties": false
},
"description": "List of ApplicationPartners"
},
"editParameters": {
"type": "object",
"properties": {
"deviceCd": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Text name of this field."
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"name": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"location": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"imageLink": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"settings": {
"type": "object",
"properties": {
"usageTypes": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "write",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"streamLabels": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"anyOf",
"number",
"string",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"anyOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
},
"customProductTemplate": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"oneOf",
"anyOf",
"number",
"string",
"onePlusOf",
"object",
"array"
],
"default": [
"oneOf"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"usageTypes",
"streamLabels",
"customProductTemplate"
]
},
"network": {
"type": "object",
"properties": {
"isNetworkLinkDevice": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"anyOf",
"number",
"oneOf",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"isNetworkLinkDevice"
]
},
"status": {
"type": "object",
"properties": {
"operationsStatus": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"write",
"read",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"oneOf",
"anyOf",
"onePlusOf",
"object",
"array"
],
"default": "string",
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
false,
true
],
"default": false,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"operationsStatus"
]
},
"audit": {
"type": "object",
"properties": {
"addedBy": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field that has required information for editing or viewing"
},
"view": {
"type": "string",
"enum": [
"read",
"write",
"hidden",
"password"
],
"default": "read",
"description": "Specifies write, read, hidden, password"
},
"type": {
"type": "string",
"enum": [
"string",
"oneOf",
"anyOf",
"number",
"onePlusOf",
"object",
"array"
],
"default": [
"string"
],
"description": "The type of data this field holds"
},
"required": {
"type": "boolean",
"enum": [
true,
false
],
"default": true,
"description": "Is this field required"
},
"label": {
"type": "string",
"description": "Text to display on the UI"
},
"labelPlural": {
"type": "string",
"description": "Test to display if there are multiple"
},
"help": {
"type": "string",
"description": "Some help text available for hover or on error"
}
},
"required": [
"fieldName",
"view",
"type",
"required",
"label",
"labelPlural"
],
"description": "Edit info"
}
},
"required": [
"addedBy"
]
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink"
],
"description": "fields will contain arrays of any of the following types"
}
},
"required": [
"deviceCd",
"name",
"location",
"imageLink",
"product",
"devicePorts",
"actions",
"bridge",
"applicationPartners"
]
},
"meta": {
"type": "object",
"properties": {
"responseCode": {
"type": "number",
"description": "A Altair Response Code. Zero (0) is OK."
},
"responseType": {
"type": "string",
"enum": [
"JSON",
"BINARY",
"HTML",
"TEXT"
],
"description": "The type of data being returned"
},
"responseDataType": {
"type": "string",
"description": "The structure of data being returned"
},
"httpStatus": {
"type": "number",
"description": "HTTP status code that was returned"
},
"timeStamp": {
"type": "string",
"description": "The date/time the message started processing"
},
"elapsed": {
"type": "number",
"description": "asdf"
},
"server": {
"type": "string",
"description": "The server this was processed on"
},
"api": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The API version we are returning"
},
"endpoint": {
"type": "string",
"description": "The destination of the request"
}
},
"required": [
"version",
"endpoint"
]
}
},
"required": [
"responseCode",
"responseType",
"responseDataType",
"httpStatus",
"timeStamp",
"server"
]
}
}
}