#%RAML 0.8 title: Asset Tracker API baseUri: "https://api.covisintlabs.com/assettracker/v1" 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" ] } ] } - geofences: | { "id": "http://api.covisint.com/schema/geofence", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of geofence definitions.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/geofence#" } } - 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"] } - geofence: | { "id": "http://api.covisint.com/schema/geofence", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "description": "Schema representing a geofence.", "extends": { "$ref": "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "active" :{ "type":"boolean", "description":"to activate or deactive a geofence, by default a geofence is deactive " }, "maxSearchRadius":{ "type":"string", "description":"maximum search radius in decimal value. Example 3000 or 300.2, all values will be considered to be in meters." }, "name": { "description": "The geofence name (internationalized).", "$ref": "http://api.covisint.com/schema/internationalString#" }, "description": { "description": "The geofence description (internationalized).", "$ref": "http://api.covisint.com/schema/internationalString#" }, "dwellTime":{ "description": "Dwell time of the geofence.", "type":"object", "$ref": "http://api.covisint.com/schema/geofenceDwellTime#" }, "polygon": { "type": "array", "description": "Polygon of the geofence", "items": { "type": "object", "properties": { "latitude": { "type": "string", "description": "The latitude in decimal format." }, "longitude": { "type": "string", "description": "The longitude in decimal format." } }, "required" : [ "latitude", "longitude" ] } }, "tags": { "description": "The tags associated with this document.", "$ref": "http://api.covisint.com/idm/schema/tags#", "readOnly": true } }, "required" : [ "name", "polygon","maxSearchRadius"] } - gateways: | { "id": "http://api.covisint.com/schema/gateways", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of gateway definitions.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/gateway#" } } - assettrackers: | { "id": "http://api.covisint.com/schema/assettrackers", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of assettrackers.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/assettracker#" } } - assetResponse: | { "id": "http://api.covisint.com/schema/AssetResponse", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of AssetResponse.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/ConnectorResponse#" }, "headerColumns" :{ "type":"Object", "description":"Object headers, where we will have field mapping." }, "rows" : { "type":"Object", "description":"Rows, map of strings." } } - assettracker: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/assettracker", "type": "object", "description": "Schema representing a assettracker.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "assetNumber" :{ "type":"string", "description":"Asset Number." }, "assetName" :{ "type":"string", "description":"Asset Name." }, "assetDescription" :{ "type":"string", "description":"Asset Description." }, "assetServiceDate" :{ "type":"object", "description":"Asset service date." }, "assetTrackingStatus" :{ "type":"number", "description":"Asset tracking status. Possible values(0,1,2)" }, "locations" :{ "type":"array", "description":"Attached locations.", "properties":{ "id":{ "type":"string", "description":"uuid of the asset location" }, "locationId":{ "type":"string", "description":"location id" }, "isHomeLocation":{ "type":"boolean", "description":"Is home location or not" }, "isCurrentLocation":{ "type":"boolean", "description":"Is current location or not" } }, "required":["locationId"] }, "trackingDevices" :{ "type":"array", "description":"Attached tracking devices.", "properties":{ "name":{ "description": "Name of the tracking device.", "$ref": "http://api.covisint.com/idm/schema/internationalString#" }, "description":{ "description": "Description of the tracking device.", "$ref": "http://api.covisint.com/idm/schema/internationalString#" }, "deviceId":{ "type":"string", "description":"Id of the tracking device" }, "latitude":{ "type":"number", "description":"Latitude tracking device" }, "longitude":{ "type":"number", "description":"Longitude of the tracking device" }, "standaradAttributes":{ "type":"object", "description":"Standarad attributes attached to this tracking device" }, "ownerType":{ "type":"string", "description":"Owner type of the tracking device " }, "deviceHealth":{ "type":"string", "description":"Health of the tracking device. ['OK(0)','ALERT(1)']." }, "deviceStatus":{ "description":"Status of the tracking device. Supported enum are ACTIVE,INACTIVE and an additional internal state of MISSING.", "enum": [ "ACTIVE", "INACTIVE" ] } }, "required":["deviceId"] } }, "required": ["assetNumber","assetName", "assetServiceDate","locations","trackingDevices"] } - trackingdevice: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/trackingdevice", "type": "object", "description": "Schema representing a trackingdevice.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "deviceId" :{ "type":"string", "description":"device Id" } }, "required": ["deviceId"] } - trackingdeviceV2: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/trackingdevice", "type": "object", "description": "Schema representing a trackingdevice.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties":{ "name":{ "description": "Name of the tracking device.", "$ref": "http://api.covisint.com/idm/schema/internationalString#" }, "description":{ "description": "Description of the tracking device.", "$ref": "http://api.covisint.com/idm/schema/internationalString#" }, "deviceId":{ "type":"string", "description":"Id of the tracking device" }, "latitude":{ "type":"number", "description":"Latitude tracking device" }, "longitude":{ "type":"number", "description":"Longitude of the tracking device" }, "standaradAttributes":{ "type":"object", "description":"Standarad attributes attached to this tracking device" }, "ownerType":{ "type":"string", "description":"Owner type of the tracking device " } } } - location: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/location", "type": "object", "description": "Schema representing a location.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "locationName" :{ "type":"string", "description":"Name of the location." }, "locationDescription" :{ "type":"string", "description":"Description of the location." }, "siteName" :{ "type":"string", "description":"Name of the site." }, "geofenceId" :{ "type":"object", "description":"Id of the geofence associated with this location." }, "active" :{ "type":"boolean", "description":"Asset tracking status." } }, "required": ["locationName","geofenceId"] } - locations: | { "id": "http://api.covisint.com/schema/locations", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of locations.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/location#" } } - assetlocation: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/assetlocation", "type": "object", "description": "Schema representing an assetlocation.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "locationId" :{ "type":"string", "description":"Name of the location." }, "assetTrackerId" :{ "type":"string", "description":"Description of the location." }, "isHomeLocation" :{ "type":"boolean", "description":"Name of the site." }, "isCurrentLocation" :{ "type":"boolean", "description":"Id of the geofence associated with this location." } }, "required": ["locationId","assetTrackerId"] } - assetlocations: | { "id": "http://api.covisint.com/schema/assetlocations", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of assetlocations.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/assetlocation#" } } - assetalert: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/assetalert", "type": "object", "description": "Schema representing an assetalert.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "violationMessage" :{ "type":"string", "description":"Violation causing message" }, "creationInstant" :{ "type":"string", "description":"Creation instant of the violation" }, "assetName" :{ "type":"string", "description":"Name of the Asset." }, "siteName" :{ "type":"string", "description":"Name of the site." }, "locationName" :{ "type":"string", "description":"Name of the Location." }, "assetTrackerId" :{ "type":"string", "description":"Id of the assettracker associated with this alert." } } } - assetalerts: | { "id": "http://api.covisint.com/schema/assetalerts", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of assetalerts.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/assetalert#" } } - violation: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/violation", "type": "object", "description": "Schema representing an violation.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "violationMessage" :{ "type":"string", "description":"Violation causing message" }, "violatedAttributeName" :{ "type":"string", "description":"Nmae of the violation" }, "violatedAttributeValue" :{ "type":"string", "description":"Value of the attribute." }, "attributeViolationStatus" :{ "type":"string", "description":"Status of violated attribute." }, "violatedDeviceId" :{ "type":"string", "description":"Device Id" }, "expressionOperator" :{ "type":"string", "description":"Expression operator. Ex:<,>,<=,>=,==,!=" }, "expressionValue" :{ "type":"string", "description":"Value to be compared in expression" } }, "required":["violatedAttributeName","violatedAttributeValue","attributeViolationStatus","violationMessage","violatedDeviceId","expressionOperator", "expressionValue"] } - violations: | { "id": "http://api.covisint.com/schema/violations", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of violations.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/violation#" } } 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 /locations: description: "Collection endpoint for locations. [Since:1.0]" post: description: "Create a new location.[Flow-name:create-location]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.assettracker.location.v1+json Content-Type: description: The content media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.assettracker.location.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 body: application/vnd.com.covisint.platform.assettracker.location.v1+json: schema: location responses: "201": description: location successfully created. body: application/vnd.com.covisint.platform.assettracker.location.v1+json: schema: location "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 an error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:data:illegal - The following properties contained illegal values: Origin location : {originLocationId} does not exist, Destination location : {destinationLocationId} does not exist 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] get: description: "Search locations in a realm based on specified query parameters.[Flow-name:search-locations][Since:1.0][visibility:public]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.assettracker.location.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 queryParameters: id: description: Filter assettrackers by their unique id. Multiple parameter values can be provided, in which case any matching event sources will be returned. type: string required: false repeat: false locationName: description: Retrieve assettrackers with the specified assetName. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false siteName: description: Retrieve assettrackers with the specified assetNumber. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false creation: description: Retrieve assettrackers 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=value1&creation=value1&creation=value1&creation=