#%RAML 0.8 title: Device API baseUri: "https://api.us1.covisint.com/device/v4" protocols: [HTTPS] schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource." }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } , "required":[ "id" ] } - namedResourceReference: | { "id" : "http://api.covisint.com/schema/namedScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the basic resource reference and adds internationalized name and description.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceReference#" }, "properties" : { "name" : { "description": "Internationalized resource name.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized resource description.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" } } } - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource." }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - resourceV2: | { "id" : "http://api.covisint.com/schema/resourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resourceV2", "type" : "object", "description" : "A basic resource (version V2).", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource." }, "version": { "type" : "string", "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - realmScopedResource: | { "id" : "http://api.covisint.com/schema/realmScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the base resource and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resource#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.", "readonly": true } } , "required":[ "realm" ] } - realmScopedResourceV2: | { "id" : "http://api.covisint.com/schema/realmScopedResourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceV2#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.", "readonly": true } } , "required":[ "realm" ] } - errorResponseSchema: | { "id" : "http://api.covisint.com/schema/errorResponseSchema", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of an HTTP 4xx/5xx error response.", "properties" : { "status" : { "type" : "number", "minimum" : 400, "maximum" : 599, "description" : "The HTTP status code." }, "apiMessage" : { "type" : "string", "description" : "A helpful, human-readable description of the error, useful for basic diagnostics." }, "apiStatusCode" : { "type" : "string", "description" : "The API-specific status code." } } , "required":[ "status" ] } - serviceCode: | { "id" : "http://api.covisint.com/schema/serviceCodes", "$schema" : "http://json-schema.org/draft-04/schema", "type": "object", "description": "The site/service/location codes granted along with a service.", "properties": { "code": { "type": "string", "maxLength": 200, "description": "The code value." }, "codeKind": { "type": "string", "maxLength": 36, "description": "The associated business unit." } } , "required":[ "code", "codeKind" ] } - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type" : "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: | { "id" : "http://api.covisint.com/idm/schema/phone", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for phone number details.", "properties" : { "number" : { "type" : "string","maxLength" : 100, "description" : "The phone number." }, "type" : { "enum" : [ "main", "mobile", "fax" ], "description" : "The phone number type." } }, "required" : [ "type" ] } - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.", "extends": { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "name": { "description": "The application name (internationalized).", "$ref": "http://api.covisint.com/schema/internationalString#" }, "description": { "description": "The application description (internationalized).", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "properties":{ "type":"array", "description":"Properties used by the implementation.", "minItems":0, "items":[ { "anyOf": [ { "type": "string", "description": "The name of the property." }, { "type": "string", "description": "The value of the property." } ] } ] } , "required":[ "items" ] } , "required":[ "name" ] } - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } , "required":[ "type" ] } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ] } } , "required":[ "type" ] } - dataType: | { "id" : "http://api.covisint.com/schema/dataType", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Data type enum.", "enum":[ "string", "integer", "bool", "decimal" ] } - attribute: | { "id" : "http://api.covisint.com/schema/attribute", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "An attribute.", "properties" : { "oneOf" : [ { "attributeTypeId" : { "type" : "string", "description" : "The attribute type id." } }, { "attributeType" : { "description" : "The full attribute type definition.", "$ref" : "http://api.covisint.com/schema/attributeType#" } } ], "value" : { "type" : "any", "description" : "The attribute value." } } , "required":[ "attributeTypeId" ] } - attributes: | { "id" : "http://api.covisint.com/schema/attributes", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Collection of attributes.", "items" : { "$ref" : "http://api.covisint.com/schema/attribute#" } } - expression: | { "id" : "http://api.covisint.com/schema/expression#", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "The DSL for defining conditional expressions.", "oneOf" : [ { "type" : "object", "properties" : { "any" : { "type" : "array", "description" : "An aggregate expression representing an 'any' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "properties" : { "all" : { "type" : "array", "description" : "An aggregate expression representing an 'all' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "description" : "A simple leaf-node expression. The format of this expression is: '(f:, v:())'. The supported expressions are: equal, notEqual, startsWith, endsWith, matches, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual. The field name can be a simple field name i.e. 'id' or hierarchical field name using dot-notation like 'resource.id' / 'resource.tag[0]' . The value corresponding to the field name provided should always be a simple data type and cannot be an array or an object.", "properties" : { "expr" : { "type" : "string" } } , "required":[ "expr" ] } ] } - devices: | { "id": "http://api.covisint.com/schema/devices", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of devices.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/device#" } } - device: | { "id": "http://api.covisint.com/schema/device", "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "description": "Schema representing a device type.", "extends": { "$ref": "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "name": { "description": "Name of the device.", "$ref": "http://api.covisint.com/idm/schema/internationalString#" }, "description": { "description": "Description of the device.", "$ref": "http://api.covisint.com/idm/schema/internationalString#" }, "attributes": { "type": "object", "description": "The list of attributes associated to the device.", "properties": { "standard": { "type": "array", "description": "The list of standard attributeTypes associated to the device that are refered from the Device Template used.These attributes only once during device registration.", "items": { "oneOf": [ { "attributeTypeId": { "type": "string", "description": "The attributeType id.", "required": true } }, { "attributeType": { "description": "The full attribute type definition.", "$ref": "http://api.covisint.com/schema/attributeType#" } } ], "value": { "type": "any", "description": "The attribute value.", "required": false } } }, "extended": { "type": "array", "description": "The list of attributes associated directly to the device,not available with the device template used.These attribute value can be change mutiple time during device lifetime.", "items": { "oneOf": [ { "attributeTypeId": { "type": "string", "description": "The attributeType id.", "required": true } }, { "attributeType": { "description": "The full attribute type definition.", "$ref": "http://api.covisint.com/schema/attributeType#" } } ], "value": { "type": "any", "description": "The attribute value.", "required": false } } } } }, "observableEvents": { "type": "array", "description": "The list of event ids that can be observed or generated by the device.", "minItems": 1, "items": { "type": "string", "description": "The id of the device generated event that can be observed in IOT Core Platform." } }, "supportedCommands": { "type": "array", "description": "The list of commands ids supported by the device.", "minItems": 1, "items": { "type": "string", "description": "The id of the command supported by the device." } }, "parentDeviceTemplateId": { "type": "string", "description": "The id of the device template used or being refered to create the device." }, "state": { "type": "object", "description": "The lifecycle and operational state of the device.", "properties": { "lifecycleState": { "description": "Valid lifecycle states of device.", "enum": [ "CREATED", "PENDING_ACTIVATION", "ACTIVE", "LOCKED", "SUSPENDED", "DELETED" ] }, "operationalState": { "description": "Valid operational states of the device.", "enum": [ "STANDBY", "ONLINE", "OFFLINE" ] } } }, "isActive": { "type": "boolean", "description": "Whether or not device is active.", "default": false }, "tags": { "description": "The list of tags associated to the device.", "$ref": "http://api.covisint.com/idm/schema/tags#" }, "orgId": { "type": "string", "description": "The id of the person/application used or being refered to create the device." }, "periodOfInactivity":{ "type":"number", "description":"Max limit in minutes till which a device is supposed to be at the same location." }, "emailId":{ "type":"string", "description":"Email id of the receipent to which notification will be sent, if a device is idle to more that periodOfInactivity" }, "smsNo":{ "type":"string", "description":"Sms number id of the receipent to which notification will be sent, if a device is idle to more that periodOfInactivity" }, "deviceLastSeenInstant": { "type": "string", "description": "The last seen time of the Device in UTC" }, "healthRuleId": { "description": "health rule assosciated with device template.", "type": "string", "readOnly": true }, "deviceHealthAlertCriteria":{ "type":"object", "description":"device health alert criteria", "properties": { "id": { "type": "string", "description": "the id of device health alert criteria." }, "deviceHealthChangeAlerts": { "type": "array", "description": "the list of device health change alert.", "minItems": 1, "items": { "type": "object", "properties": { "fromState": { "type": "string", "description": "The from state device health change alert.", "minLength": 1, "maxLength": 40 }, "toState": { "type": "string", "description": "The to state device health change alert.", "minLength": 1, "maxLength": 40 } }, "required" : ["fromState","toState"] } }, "deviceHealthUpdateAlerts":{ "type": "array", "description": "the list of device health update alert.", "minItems": 1, "items": { "type": "object", "properties": { "alertTimeInterval": { "type": "number", "description": "The alert time interval of device health update alert.", "minLength": 1, "maxLength": 40 }, "alertState": { "description": "Valid alert state of device health update alert.", "enum": [ "OK", "CRITICAL", "WARNING", "FAILURE", "SUSPENDED" ] } }, "required" : ["alertTimeInterval","alertState"] } }, "deviceHealthAlerts": { "description": "The list of device health alerts.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "deviceHealthAlert": { "type": "number", "description": "The device health alert associated with a The device health alert criteria." } } } } }, "required": ["id"] }, "deviceHealthState":{ "type":"object", "description":"device health state", "properties": { "id": { "type": "string", "description": "the id of device health state." }, "healthState": { "description": "Valid health state of device health state.", "enum": [ "OK", "CRITICAL", "WARNING", "FAILURE", "SUSPENDED" ] }, "previousHealthState": { "description": "Valid previous health state of device health state.", "enum": [ "OK", "CRITICAL", "WARNING", "FAILURE", "SUSPENDED" ] }, "lastMessageReceived": { "type": "number", "description": "The last message received of device health state.", "minLength": 1, "maxLength": 40 }, "lastSuccessfulMessageReceived": { "type": "number", "description": "The last successful message received of device health state.", "minLength": 1, "maxLength": 40 }, "lastSuccessfulHealthMessageAge": { "type": "number", "description": "The last successful health message age of device health state.", "minLength": 1, "maxLength": 10 }, "isActive": { "type": "boolean", "description": "Whether or not device health state is active.", "default": false } }, "required": ["id"] }, "tagging": { "description": "tags with device.", "type": "string", "readOnly": true } }, "required" : ["isActive","operationalState" ,"state","parentDeviceTemplateId","name"] } - deviceGeofenceState: | { "$schema": "http://json-schema.org/draft-04/schema", "description": "Device Geofence State", "type": "object", "properties":{ "deviceId" :{ "type":"string", "description":"deviceId fro which device geofence state is defined " }, "geofenceId" :{ "type":"string", "description":"geofenceId fro which device geofence state is defined " }, "deviceState" :{ "type":"boolean", "description":"state of the device, if true than device is inside the geofence, else false " }, "geofenceName":{ "description":"Name of the geofence", "$ref": "http://api.covisint.com/idm/schema/internationalString#" }, "deviceDistance":{ "description":"Distance of the device from the nearest vertex of the goefence", "type":"double" } } } - deviceGeofenceStateHistory: | { "$schema": "http://json-schema.org/draft-04/schema", "description": "Device Geofence State History", "type": "object", "properties":{ "deviceId" :{ "type":"string", "description":"deviceId fro which device geofence state is defined " }, "geofenceId" :{ "type":"string", "description":"geofenceId fro which device geofence state is defined " }, "deviceState" :{ "type":"boolean", "description":"state of the device, if true than device is inside the geofence, else false " }, "timeStamp" :{ "type":"number", "description":"Time stamp in epoc millisecond, of device entering or exiting from the geofence." }, "latitude" :{ "type" : "string", "description":"latitude of the device." }, "longitude" :{ "type": "string", "description":"longitude of the device" }, "messageId" :{ "type":"string", "description" :" message id of the event which has changed the device state." } } } - deviceGeofenceStateResponse: | { "$schema": "http://json-schema.org/draft-04/schema", "description": "Represents all the deviceGeofenceState for a device", "properties": { "deviceId":{ "description":"device id", "type":"string" }, "deviceGeofenceState":{ "type": "array", "items": { "$ref": "http://api.covisint.com/schema/deviceGeofenceState#" } } } } - deviceGeofenceStateHistoryResponse: | { "$schema": "http://json-schema.org/draft-04/schema", "description": "Represents all the deviceGeofenceStateHistory for a device", "properties": { "deviceGeofenceStates":{ "type": "array", "items": { "$ref": "http://api.covisint.com/schema/deviceGeofenceStateHistory#" } } } } traits: - secured: displayName: secured - unsecured: displayName: unsecured - getResponse: displayName: getResponse - getSearchResponse: displayName: getSearchResponse - postResponse: displayName: postResponse - deleteResponse: displayName: deleteResponse - putResponse: displayName: putResponse - putResponseV2: displayName: putResponseV2 - putCreateResponse: displayName: putCreateResponse - taskResponse: displayName: taskResponse - pagableRequest: displayName: pagableRequest - taggable: displayName: taggable - sortable: displayName: sortable - searchable: displayName: searchable /devices: description: "Collection endpoint for devices.[Since:1.0]" get: description: "Search devices in the realm based on the specified query parameters. Wildcard search and range based search are also supported.[Flow-name:device-search-devices]" headers: Accept: description: The media type for v1 devices. Specify parameter fetchattributetypes with a value of true to return the full attribute type information nested within the device resource, opposed to just the attribute type id being returned. Specify parameter fetcheventtemplates with a value of true to return the full event template information nested within the device resource, opposed to just the event template id being returned. Specify parameter fetchcommandtemplates with a value of true to return the full command template information nested within the device resource, opposed to just the command template id being returned.Specify parameter fetchdevicehealthalertcriteria to fetch the health alert criteria assosciated to a device. Specify parameter fetchrules to fetch the detailed rules assosciated to a device template. type: string required: true repeat: false example: application/vnd.com.covisint.platform.device.v2+json;fetchattributetypes=true;fetcheventtemplates=true;fetchcommandtemplates=true;fetchdevicehealthalertcriteria=true;fetchrules=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve devices with the specified id. Wild card search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false parentDeviceTemplateId: description: Retrieve devices based on the specified device template. Wild card search is supported. Search results will be a union when multiple parameters are provided. type: string required: false repeat: false name: description: Retrieve devices with the specified name. Wild card search is supported. Multiple parameters are allowed and the search results will be a union. Example - .../devices?name=beagleboard will match all devices whose name exactly equals "beagleboard". .../devices?name=?Feagleboard will match all devices whose name ends with "eagleboard" and starts with a single wildcard character. .../devices?name=*board will match all devices whose name ends with "board" ..../devices?name=beagle* will match all devices whose name starts with "beagle". type: string required: false repeat: false description: description: Retrieve devices with the specified description. Wild card search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false state.lifecycleState: description: Retrieve devices in the specified lifecycle state. Wild card search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false state.operationalState: description: Retrieve devices in the specified operational state. Wild card search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false active: description: Retrieve devices that are either active or inactive. Wild card search is supported. Multiple parameters are allowed and the search results will be a union. type: boolean required: false repeat: false deviceHealth: description: Retrieve devices with given healthstate. Multiple parameters are allowed and the search results will be a union.Supported enum are OK,WARNING,CRITICAL,FAILURE,SUSPENDED type: string required: false repeat: false geofenceId: description: Retrieve a list of devices by geofenceId grouped inside/outside of a GeoFence[By default only if it inside the given geofence].Explicitely geofenceState = false or true should be given as per the requirement. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false geofenceName: description: Retrieve a list of devices by geofenceName grouped inside/outside of a GeoFence[By default only if it inside the given geofence].Explicitely geofenceState = false or true should be given as per the requirement. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false geofenceState: description: Retrieve a list of devices by geofenceState grouped inside/outside of a GeoFence[By default only if it inside the given geofence]. type: string required: false repeat: false commandArg: description: Retrieve a list of devices by command arg name. type: string required: false repeat: false commandId: description: Retrieve a list of devices by command Id. type: string required: false repeat: false orgId: description: Retrieve a list of devices by orgId. type: string required: false repeat: false gps_enabled: description: If value set to true it retrives a list of devices which are having lat/long else if false retrieves all the device irrespective of lat/long type: string required: false repeat: false tagName: description: Retrieve the devices assosciated with the tagging resource, Need to provide both tagName and tagValue to retrieve the devices. type: string required: false repeat: false tagValue: description: Retrieve the devices assosciated with the tagging resource, Need to provide both tagName and tagValue to retrieve the devices. type: string required: false repeat: false creation: description: Retrieve attribute types with the specified creation. Range search is supported. Multiple parameters are allowed and the search results will be a union. The pattern would be creation=>value1&creation=1466612312576&creation=<1466612312579 will provide devices >= 1466612312576 and <=1466612312579. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: 50 sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+creation, "-creation", +state, "-state"] example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). tag: description: Retrieve devices with the given tag value. Wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: boolean required: false repeat: false default: true responses: "200": description: All devices that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.device.v2+json: schema: devices "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing query parameters: {paramName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [searchable, pagableRequest, sortable, taggable, getSearchResponse, secured] /count: description: "Endpoint to return the count of devices that match the given query criteria.[Since:1.0]" get: description: "Retrieve count of devices based on the specified query parameters.[Flow-name:device-count-devices]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve count of devices with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false parentDeviceTemplateId: description: Retrieve devices based on the specified device template. Search results will be a union when multiple parameters are provided. type: string required: false repeat: false attribute: description: "Retrieve devices with 'attribute name'. Multiple parameters are allowed and the search results will be a union. Range based search is supported. Wildcard based search is also supported. The value of parameter needs to be :. Example - ../devices?attribute=score:>204 displays all devices with attribute name 'score' having value '>=' 204. .../devices?attribute=car:hyn* displays all devices with attribute name 'car' having value starting with 'hyn'." type: string required: false repeat: false name: description: Retrieve count of devices with the specified name. Multiple parameters are allowed and the search results will be a union. Example - .../devices?name=beagleboard will match all devices whose name exactly equals "beagleboard". .../devices?name=?Feagleboard will match all devices whose name ends with "eagleboard" and starts with a single wildcard character. .../devices?name=*board will match all devices whose name ends with "board" ..../devices?name=beagle* will match all devices whose name starts with "beagle". type: string required: false repeat: false creation: description: Retrieve attribute types with the specified creation. Range search is supported. Multiple parameters are allowed and the search results will be a union. The pattern would be creation=>value1&creation=1466612312576&creation=<1466612312579 will provide devices >= 1466612312576 and <=1466612312579. type: string required: false repeat: false description: description: Retrieve count of devices with the specified description. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false state.lifecycleState: description: Retrieve count of devices in the specified lifecycle state. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false state.operationalState: description: Retrieve count of devices in the specified operational state. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false active: description: Retrieve devices that are either active or inactive. type: boolean required: false repeat: false tag: description: Retrieve count of devices with the given tag value. Multiple parameters are allowed and the search results will be a union. type: boolean required: false repeat: false default: true responses: "200": description: The number of matching devices were returned. body: plain/text: "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [taggable, getSearchResponse, secured] /{deviceId}: description: Endpoint for an individual device. uriParameters: deviceId: description: id of the device. type: string required: false repeat: false get: description: "Retrieve the specified device based on its unique id.[Flow-name:device-get-device]" headers: Accept: description: The media type for v1 devices. Specify parameter fetchattributetypes with a value of true to return the full attribute type information nested within the device resource, opposed to just the attribute type id being returned. Specify parameter fetcheventtemplates with a value of true to return the full event template information nested within the device resource, opposed to just the event template id being returned. Specify parameter fetchcommandtemplates with a value of true to return the full command template information nested within the device resource, opposed to just the command template id being returned. type: string required: true repeat: false example: application/vnd.com.covisint.platform.device.v2+json;fetchattributetypes=true;fetcheventtemplates=true;fetchcommandtemplates=true;fetchdevicehealthalertcriteria=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: Successfully retrieved the requested device. body: application/vnd.com.covisint.platform.device.v2+json: schema: device "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName}. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, secured] put: description: "Updates the requested device. Throws an error if the device doesn't already exist.[Flow-name:device-update-device]" headers: Accept: description: Media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.device.v2+json Content-Type: description: The content type type: string required: true repeat: false example: application/vnd.com.covisint.platform.device.v2+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.device.v2+json: schema: device responses: "200": description: Successfully updated the device. body: application/vnd.com.covisint.platform.device.v2+json: schema: device "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | There is a conflict in identifying the resource being acted on. The unique identifier in the URL and body are different. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [putResponseV2, secured] /geofences/{geofenceId}/deviceGeofencesHistory: description: get the device geofence state uriParameters: geofenceId: displayName: geofenceId type: string required: true repeat: false is: [secured] get: description: "get Device geofence state, for all the active geofences [Flow-name:device-geofence-state-history]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.deviceGeofenceStateHistory.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: successfully fetched all the devoice geofence state. body: application/vnd.com.covisint.platform.deviceGeofenceStateHistory.v1+json: schema: deviceGeofenceStateHistoryResponse "404": description: The device/geofence did not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] "500": description: An unhandled error occurred on the server. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /deviceState: description: get the device geofence state is: [secured] get: description: "get Device geofence state, for all the active geofences [Flow-name:device-geofence-state]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.deviceGeofenceState.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: successfully fetched all the devoice geofence state. body: application/vnd.com.covisint.platform.deviceGeofenceState.v1+json: schema: deviceGeofenceStateResponse "404": description: The device did not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] "500": description: An unhandled error occurred on the server. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tags/{tag}: description: Device tags endpoint. uriParameters: tag: description: The tag value. type: string required: true repeat: false minLength: 1 maxLength: 2000 put: description: "Tags the specified device.[Flow-name:device-tag-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The tag was successfully added. "404": description: The device did not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] "500": description: An unhandled error occurred on the server. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] delete: description: "Removes a tag from the device.[Flow-name:device-untag-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The tag was successfully removed. "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] "404": description: The specified tag was not associated to the device, or the device did not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled error occurred on the server. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/activate: post: description: "Activates the device.[Flow-name:device-activate-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: Device sucessfully activated. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/deactivate: post: description: "Deactivates the device.[Flow-name:device-deactivate-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: Device sucessfully deactivated. "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/register: post: description: "Register the device and set the lifecycle state to Active. [Since:3.0][Flow-name:device-register-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: reason: description: Reason to register the device. type: string required: false repeat: false responses: "200": description: Device sucessfully registered. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/suspend: post: description: "Suspend device operation.[Since:3.0][Flow-name:device-suspend-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: reason: description: Reason to suspend the device. type: string required: false repeat: false responses: "204": description: Device sucessfully suspended. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/unsuspend: post: description: "Unsuspend device and resume operation.[Since:3.0][Flow-name:device-unsuspend-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: reason: description: Reason to unsuspend the device. type: string required: false repeat: false responses: "204": description: Device sucessfully unsuspended. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/lock: /tasks/unlock: post: description: "unlocks the device.[Since:3.0][Flow-name:device-unlock-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: reason: description: Reason to unlock the device. type: string required: false repeat: false responses: "204": description: Device sucessfully unlocked. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/delete: post: description: "Set the device lifecycle state to deleted.[Since:3.0][Flow-name:device-delete-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: reason: description: Reason to delete a device. type: string required: false repeat: false responses: "204": description: Device sucessfully deleted. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/reset: post: description: "Reset the device and set the lifecycle state to Pending Activation.[Since:3.0][Flow-name:device-reset-device]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: Device sucessfully reset. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/online: /tasks/offline: /deviceHealthState: description: Device Health State endpoints. # uriParameters: # deviceId: # description: id of the device. # type: string # required: true # repeat: false get: description: "Retrieve the specified device health state of device based on its unique id.[Flow-name:device-get-device-health-state][Since:3.0]" headers: Accept: description: The media type for v1 devices. Specify parameter fetchattributetypes with a value of true to return the full attribute type information nested within the device resource, opposed to just the attribute type id being returned. Specify parameter fetcheventtemplates with a value of true to return the full event template information nested within the device resource, opposed to just the event template id being returned. Specify parameter fetchcommandtemplates with a value of true to return the full command template information nested within the device resource, opposed to just the command template id being returned.Specify parameter fetchdevicehealthalertcriteria to fetch the health alert criteria assosciated to a device. type: string required: true repeat: false example: application/vnd.com.covisint.platform.device.v2+json;fetchattributetypes=true;fetcheventtemplates=true;fetchcommandtemplates=true;fetchdevicehealthalertcriteria=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: Successfully retrieved the requested device. body: application/vnd.com.covisint.platform.device.v2+json: schema: device "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName}. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, secured] put: description: "Update the device health state of the specified device.[Flow-name:device-update-device-health-state][Since:3.0]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: healthState: description: The health state value. type: string required: true repeat: false minLength: 1 maxLength: 2000 reason: description: The reason for update value. type: string required: true repeat: false minLength: 1 maxLength: 2000 responses: "204": description: The device health state was successfully added. "404": description: The device did not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] "500": description: An unhandled error occurred on the server. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/createDeviceFromTemplate: post: description: "Create a new device based on the given deviceTemplateId.[Flow-name:device-create-device][Since:1.0]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.device.v2+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: deviceTemplateId: description: The id of the device template on which to model the device. type: string required: false repeat: false responses: "201": description: Successfully created a new device, which is returned in the response entity body. body: application/vnd.com.covisint.platform.device.v2+json: schema: device "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, secured] /tasks/migrateDeviceToNewTemplate: post: description: "Upgrade the device with the latest version of its device template. This syncs the standard attributes, events and commands of device with current device template version.[Flow-name:device-update-template-version][Since:1.0]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.device.v2+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: deviceTemplateId: description: The id of the new parent device template. type: string required: false repeat: false deviceId: description: The device ids to upgrade. type: string required: false repeat: false responses: "201": description: Sucessfully updated the specified device(s) to the requested parent template and the new device is returned in the body. body: application/vnd.com.covisint.platform.device.v2+json: schema: device "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, secured] /devices/{deviceId}/deviceHealthState/activate: description: Device Health State Activate endpoints. uriParameters: deviceId: description: id of the device. type: string required: true repeat: false post: description: "Activates the device health state.[Flow-name:device-activate-device-health-state][Since:3.0]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "201": description: Sucessfully activated the specified device(s) health state. body: application/vnd.com.covisint.platform.device.v2+json: schema: device "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, secured] /devices/{deviceId}/deviceHealthState/deactivate: description: Device Health State Deactivate endpoints. uriParameters: deviceId: description: id of the device. type: string required: true repeat: false post: description: "Deactivates the device health state.[Flow-name:device-deactivate-device-health-state][Since:3.0]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "201": description: Sucessfully deactivated the specified device(s) health state. body: application/vnd.com.covisint.platform.device.v2+json: schema: device "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, secured] /devices/{deviceId}/tagging: description: Device Tagging. uriParameters: deviceId: description: id of the device. type: string required: true repeat: false put: description: "Update the device by assigning the mentioned tags to device.[Flow-name:assign-tagName-tagValue-device][Since:3.0]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: tagId: description: The id of the tag resource to be passed. Either tagId or tagName and tagValue combination of query parameters is required. type: string required: false repeat: false tagName: description: The tagName to be passed. Either tagId or tagName and tagValue combination of query parameters is required. type: string required: false repeat: false tagValue: description: The tagValue to be passed. Either tagId or tagName and tagValue combination of query parameters is required. type: string required: false repeat: false responses: "204": description: Successfully updated the device with the tag assignment. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] delete: description: "Delete the assosciation of the tagName and tagValue pair from device.[Flow-name:delete-tagName-tagValue-device][Since:3.0]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: tagId: description: The id of the tag resource to be passed. Either tagId or tagName and tagValue combination of query parameters is required. type: string required: false repeat: false tagName: description: The tagName to be passed. Either tagId or tagName and tagValue combination of query parameters is required. type: string required: false repeat: false tagValue: description: The tagValue to be passed. Either tagId or tagName and tagValue combination of query parameters is required. type: string required: false repeat: false responses: "204": description: Successfully updated the device by deleting the tag association. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] get: description: "Get all tagNames and tagValues assosciated with the device.[Flow-name:get-tagName-tagValue-device][Since:3.0]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: Successfully get the device with tag associations. body: application/vnd.com.covisint.platform.device.v2+json: schema: device "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /devices/search/tagging: description: Search Devices by Tagging(tagName & tagValue). get: description: "Search Devices by tagName and tagValue pair from device.[Flow-name:search-devices-tagName-tagValue][Since:3.0]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: tagName: description: The tagName to be passed. Either tagId or tagName and tagValue combination of query parameters is required. type: string required: false repeat: false tagValue: description: The tagValue to be passed. Either tagId or tagName and tagValue combination of query parameters is required. type: string required: false repeat: false responses: "204": description: Successfully retrieved list of devices with given tagName & tagValue. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured]