#%RAML 0.8 title: Device API baseUri: https://api.us1.covisint.com/device/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", "maxLength" : 36, "description" : "The unique identifier for the resource.", "required": true }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } } - namedResourceReference: "{\n \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the basic resource reference and adds internationalized name and description.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"properties\" : {\n \"name\" : { \n \"description\": \"Internationalized resource name.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : { \n \"description\": \"Internationalized resource description.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\n }\n}\n" - resource: "{\n \"id\" : \"http://api.covisint.com/schema/resource\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resource\",\n \"type\" : \"object\",\n \"description\" : \"A basic resource.\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \ \"required\": true\n },\n \"version\": {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \ \"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.\",\n \"required\": false\n },\n \ \"creator\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \ \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \"required\": false\n },\n \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \ \"required\": false \n }\n }\n }\n }\n}\n" - resourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/resourceV2\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resourceV2\",\n \ \"type\" : \"object\",\n \"description\" : \"A basic resource (version V2).\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"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.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \"required\": false\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \"required\": false \n \ }\n }\n }\n } \n}\n" - 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 is mandatory if x-realm header is NOT available", "required": false } } } - realmScopedResourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResourceV2\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : {\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This is mandatory if x-realm header is NOT available\",\n \ \"required\": false\n }\n }\n} \n" - errorResponseSchema: "{\n \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n \"properties\" : {\n \"status\" : { \n \"type\" : \"number\",\n \"minimum\" : 400,\n \ \"maximum\" : 599,\n \"description\" : \"The HTTP status code.\",\n \ \"required\": true\n },\n \"apiMessage\" : { \n \"type\" : \"string\",\n \ \"description\" : \"A helpful, human-readable description of the error, useful for basic diagnostics.\" \n },\n \"apiStatusCode\" : {\n \"type\" : \"string\",\n \"description\" : \"The API-specific status code.\"\n }\n \ }\n}\n" - serviceCode: "{\n \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\": \"object\",\n \"description\": \"The site/service/location codes granted along with a service.\",\n \"properties\": {\n \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200, \"description\": \"The code value.\" },\n \"codeKind\": { \"type\": \"string\", \"required\": true, \"maxLength\": 36, \"description\": \"The associated business unit.\" }\n }\n} \n" - 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" : { "type" : "string", "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: "{\n \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"A container for phone number details.\",\n \"properties\" : {\n \"number\" : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\" },\n \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\" : \"The phone number type.\" }\n },\n \"required\" : [ \"type\" ]\n} \n" - 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." } } } } - deviceTypes: "{\n \"id\" : \"http://api.covisint.com/schema/deviceTypes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of device types\",\n \"type\" : \"array\",\n \"items\" : { \n \"$ref\": \"http://api.covisint.com/schema/deviceType#\"\n }\n}\n" - deviceType: "{\n \"id\" : \"http://api.covisint.com/schema/deviceType\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"Schema representing a device type\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n },\n \"properties\" : { \n \"name\" : {\n \"description\": \"Internationalized name. Language code must be a valid ISO language code.\",\n \"required\": true,\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : {\n \"description\": \"Internationalized description. Language code must be a valid ISO language code.\",\n \"required\": false,\n \ \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"manufacturer\" : {\n \"description\": \"Manufacturer of the device type\",\n \"required\": false,\n \"type\":\"string\",\n \"maxLength\" : 128\n },\n \"model\" : {\n \"description\": \"Model of the device type\",\n \"required\": false,\n \"type\":\"string\",\n \"maxLength\" : 128\n },\n \"deviceTypeProperties\": {\n \"description\": \"Additional properties if one exists for the device type\",\n \"$ref\": \"http://api.covisint.com/schema/deviceType.properties#\",\n \ \"required\": false\n },\n \"associationTypes\":{\n \"description\": \"The association types for the device type. Read only.\",\n \"$ref\": \"http://api.covisint.com/schema/deviceType.associationTypes#\",\n \ \"required\": false\n }\n }\n}\n" - deviceType.associationTypes: "{\n \"id\" : \"http://api.covisint.com/schema/deviceType.associationTypes\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of association types that are defined for the device type.\",\n \ \"type\" : \"array\",\n \"items\" : { \n \"$ref\": \"http://api.covisint.com/schema/deviceType.associationType#\"\n \ }\n}\n" - deviceType.associationType: "{\n \"id\" : \"http://api.covisint.com/schema/deviceType.associationType\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing a device type association type\",\n \ \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n \ },\n \"properties\" : { \n \"name\" : {\n \"description\": \"Internationalized name. Language code must be a valid ISO language code.\",\n \ \"required\": true,\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : {\n \"description\": \"Internationalized description. Language code must be a valid ISO language code.\",\n \"required\": false,\n \ \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"deviceType\": {\n \"description\": \"The device type that is associated. Read only\",\n \"$ref\": \"http://api.covisint.com/schema/deviceType#\",\n \ \"required\": true\n }\n }\n}\n" - deviceType.properties: "{\n \"id\" : \"http://api.covisint.com/schema/deviceType.properties\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing additional properties for a device type\",\n \ \"properties\" : { \n \"additionalProperties\": {\n \"description\": \"Additional properties for a device. This must be in a valid JSON format.\",\n \ \"type\": \"string\",\n \"maxLength\" : 2000,\n \"required\": true\n }\n }\n}\n" - devices: "{\n \"id\" : \"http://api.covisint.com/schema/devices\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of devices\",\n \"type\" : \"array\",\n \"items\" : { \n \"$ref\": \"http://api.covisint.com/schema/device#\"\n \ }\n}\n" - device: "{\n \"id\" : \"http://api.covisint.com/schema/device\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"Schema representing a device\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n \ },\n \"properties\" : { \n \"deviceUuid\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\": \"A unique device id like a serial number or a RFID tag\",\n \"required\": true\n }, \n \"name\" : {\n \"description\": \"Internationalized name. Language code must be a valid ISO language code.\",\n \"required\": true,\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : {\n \"description\": \"Internationalized description. Language code must be a valid ISO language code.\",\n \"required\": false,\n \ \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"deviceType\": {\n \"description\": \"Device type associated with the device. Read only.\",\n \"$ref\": \"http://api.covisint.com/schema/deviceType#\",\n \ \"required\": true\n },\n \"owner\": {\n \"description\": \"Owner of the device. Mandatory for POST. Read only for PUT.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\": false\n },\n \"deviceProperties\": {\n \"description\": \"Additional properties if one exists for the device\",\n \"$ref\": \"http://api.covisint.com/schema/device.properties#\",\n \ \"required\": false\n },\n \"deviceClaimCode\": { \n \"description\": \"The device claim code for the device. Read only.\",\n \"$ref\": \"http://api.covisint.com/schema/device.claimCode#\",\n \ \"required\":false\n }\n }\n}\n" - device.properties: "{\n \"id\" : \"http://api.covisint.com/schema/device.properties\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Additional properties for a device\",\n \"properties\" : { \n \"additionalProperties\": {\n \"description\": \"Additional properties for a device. This must be in a valid JSON format.\",\n \"type\": \"string\",\n \"maxLength\" : 2000,\n \"required\": true\n }\n }\n}\n" - device.associations: "{\n \"id\" : \"http://api.covisint.com/schema/device.associations\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of device associations for the device.\",\n \"type\" : \"array\",\n \ \"items\" : { \n \"$ref\": \"http://api.covisint.com/schema/device.association#\"\n \ }\n}\n" - device.association: "{\n \"id\" : \"http://api.covisint.com/schema/device.association\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Schema representing a device association\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n },\n \"properties\" : { \n \"device\": { \n \"description\": \"The device for which the associations exists\",\n \"$ref\": \"http://api.covisint.com/schema/device#\",\n \ \"required\":true\n },\n \"subject\": { \n \"description\": \"Resource which is associated with the device.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\":true,\n \"properties\" : {\n \"type\": {\n \"required\":true\n \ }\n }\n },\n \"associationType\": { \n \"description\": \"The association type\",\n \"$ref\": \"http://api.covisint.com/schema/devicetype.associationType#\",\n \ \"required\":true\n }\n }\n} \n" - deviceassociation.request: "{\n \"id\" : \"http://api.covisint.com/schema/deviceassociation.request\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Schema representing a device association request\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n },\n \"properties\" : { \n \"device\": { \n \"description\": \"The device for which the associations exists. Read only.\",\n \"$ref\": \"http://api.covisint.com/schema/device#\",\n \ \"required\":true\n },\n \"invitee\": { \n \"description\": \"Resource which is associated with the device. Could be another device or a person\",\n \ \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \"required\":false\n \ },\n \"associationType\": { \n \"description\": \"The association type. Read only.\",\n \"$ref\": \"http://api.covisint.com/schema/devicetype.associationType#\",\n \ \"required\":true\n },\n \"isVerificationRequired\": { \n \"description\": \"Set this to true if the device association needs a verification step by owner\",\n \ \"type\": \"boolean\",\n \"default\":true,\n \"required\":false\n \ },\n \"expiresIn\": { \n \"description\": \"The time, in milliseconds since the epoch, when the request expires.\",\n \"type\": \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"required\":false\n },\n \ \"email\": { \n \"description\": \"If the request is associated to an email address\",\n \"type\": \"string\",\n \"maxLength\": 500,\n \"required\":false\n \ },\n \"deviceRequestCode\": { \n \"description\": \"The device request code that was generated. Read only\",\n \"$ref\": \"http://api.covisint.com/schema/device.requestCode#\",\n \ \"required\":false\n }, \n \"status\": { \n \"description\": \"Status of the device association request. Read only\",\n \"type\": \"string\",\n \ \"required\":false,\n \"enum\": [\"OPEN\", \"PENDING\", \"APPROVED\", \"REJECTED\", \"EXPIRED\"]\n }\n }\n} \n" - deviceassociation.requests: "{\n \"id\" : \"http://api.covisint.com/schema/deviceassociation.requests\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of device association requests for the device.\",\n \"type\" : \"array\",\n \"items\" : { \n \"$ref\": \"http://api.covisint.com/schema/deviceassociation.request#\"\n \ }\n} \n" - device.requestCode: "{\n \"id\" : \"http://api.covisint.com/schema/device.requestCode\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Schema representing a device request code\",\n \"properties\" : { \n \ \"deviceAssociationRequest\": { \n \"description\": \"The device association request for which the code is generated\",\n \"$ref\": \"http://api.covisint.com/schema/deviceassociation.request#\",\n \ \"required\":true\n },\n \"requestCode\": { \n \"description\": \"Unique code generated for the device request, this is auto-generated for the request\",\n \"type\": \"string\",\n \"maxLength\" : 64,\n \"required\":true\n \ }\n }\n} \n" - device.claimCode: "{\n \"id\" : \"http://api.covisint.com/schema/device.claimCode\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Schema representing a device claim code\",\n \"properties\" : { \n \ \"device\": { \n \"description\": \"The device for which the claim code is generated\",\n \"$ref\": \"http://api.covisint.com/schema/device#\",\n \ \"required\":true\n },\n \"claimCode\": { \n \"description\": \"Unique code generated for the device claim, this is auto-generated when a device is created or for a claim request\",\n \"type\": \"string\",\n \"maxLength\" : 64,\n \"required\":true\n },\n \"isClaimVerified\": { \n \"description\": \"Claim is verified by the device\",\n \"type\": \"boolean\",\n \"default\":false,\n \ \"required\":true\n }\n }\n} \n" traits: - secured: usage: Apply this to any method that needs to be secured. Requests with this trait require authentication using a bearer token. headers: Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk required: true responses: 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 - getResponse: responses: 404: &3 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: &1 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: &2 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 - getSearchResponse: responses: 406: *1 500: *2 - postResponse: responses: 406: *1 415: &4 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: *2 - deleteResponse: responses: 500: *2 - putResponse: responses: 404: *3 406: *1 409: &5 description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + 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} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 415: *4 500: *2 - putResponseV2: responses: 404: *3 406: *1 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: *4 500: *2 - putCreateResponse: responses: 406: *1 409: *5 415: *4 500: *2 - pagableRequest: queryParameters: page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false minimum: 1 default: 50 maximum: 200 - taggable: queryParameters: tag: description: Get the resource based on specified tag. Multiple parameters are allowed and the search results will be a union. type: string required: false - sortable: queryParameters: sortBy: description: Sort the results based on some criteria. example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). type: string required: false - searchable: description: Search resources based on the given filter parameters. Search is case-insensitive. <> <> "/deviceTypes": is: - secured description: Collection endpoint for device types. get: is: - getSearchResponse - pagableRequest description: Search device types based on the given filter parameters. headers: Accept: description: Media type. Setting includeProperties media type attribute to true inlines the device type's additional properties in the representation. example: application/vnd.com.covisint.platform.deviceType.v1+json;includeProperties=true type: string required: true queryParameters: name.text: description: Retrieve only device types with the specified name. Multiple parameters are supported and the search results will be a union. type: string required: false description.text: description: Retrieve only device types with the specified description. Multiple parameters are supported and the search results will be a union. type: string required: false manufacturer: description: Retrieve only device types with the specified manufacturer. Multiple parameters are supported and the search results will be a union. type: string required: false model: description: Retrieve only deviceTypes with the specified model. Multiple parameters are supported and the search results will be a union. type: string required: false sortBy: description: Sort the search results according to the supported sortable properties. type: string required: false enum: - "+creation" - "-creation" responses: 200: description: All device types that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.deviceType.v1+json: schema: deviceTypes 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + 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 post: is: - postResponse description: Creates a new device type. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.deviceType.v1+json type: string required: true body: application/vnd.com.covisint.platform.deviceType.v1+json: schema: deviceType responses: 201: description: A new device type was created. body: application/vnd.com.covisint.platform.deviceType.v1+json: schema: deviceType 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + device.type.invalid.iso.language.code - The following language codes are invalid: {languageCodes} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{deviceTypeId}": description: Endpoint for a device type. uriParameters: deviceTypeId: description: Unique identifier for the device type. type: string required: true is: - secured get: is: - getResponse description: Returns a device type by its unique identifier. headers: Accept: description: Media type. Setting includeProperties media type attribute to true inlines the device type's additional properties in the representation. example: application/vnd.com.covisint.platform.deviceType.v1+json;includeProperties=true type: string required: true responses: 200: description: The device type was successfully retrieved. body: application/vnd.com.covisint.platform.deviceType.v1+json: schema: deviceType 400: description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema put: is: - putResponse description: Updates an existing device type. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.deviceType.v1+json type: string required: true body: application/vnd.com.covisint.platform.deviceType.v1+json: schema: deviceType responses: 200: description: The device type was successfully updated. body: application/vnd.com.covisint.platform.deviceType.v1+json: schema: deviceType 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + 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] + device.type.invalid.iso.language.code - The following language codes are invalid: {languageCodes} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Deletes a device type only if there are no devices attached to it. headers: responses: 204: description: The device type was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + device.type.delete.unsupported - Device type {deviceTypeId} cannot be deleted as it has associated devices. 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: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/associationTypes": is: - secured description: Collection endpoint for association types for a device type. get: is: - getSearchResponse - pagableRequest description: Search association types based on the given filter parameters. headers: Accept: description: Media type. Setting includeDeviceType media type attribute to true inlines the association type's device type in the representation. example: application/vnd.com.covisint.platform.deviceType.associationType.v1+json;includeDeviceType=true type: string required: true queryParameters: name.text: description: Retrieve only association types with the specified name. Multiple parameters are supported and the search results will be a union. type: string required: false description.text: description: Retrieve only association types with the specified description. Multiple parameters are supported and the search results will be a union. type: string required: false sortBy: description: Sort the search results according to the supported sortable properties. type: string required: false enum: - "+creation" - "-creation" responses: 200: description: All associationTypes that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.deviceType.associationType.v1+json: schema: deviceType.associationTypes 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + 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 post: is: - postResponse description: Creates a new association type. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.deviceType.associationType.v1+json type: string required: true body: application/vnd.com.covisint.platform.deviceType.associationType.v1+json: schema: deviceType.associationType responses: 201: description: A new association types was created. body: application/vnd.com.covisint.platform.deviceType.associationType.v1+json: schema: deviceType.associationType 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + association.type.invalid.iso.language.code - The following language codes are invalid: {lamguageCodes} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 409: description: | There was a problem with the client's request Substatus codes and error messages are mentioned below: + 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 "/{associationTypeId}": description: Endpoint for an association type. uriParameters: associationTypeId: description: Unique identifier for the association type. type: string required: true is: - secured get: is: - getResponse description: Returns a association type by its unique identifier. headers: Accept: description: Media type. Setting includeDeviceType media type attribute to true inlines the association type's device type in the representation. example: application/vnd.com.covisint.platform.deviceType.associationType.v1+json;includeDeviceType=true type: string required: true responses: 200: description: The association type was successfully retrieved. body: application/vnd.com.covisint.platform.deviceType.associationType.v1+json: schema: deviceType.associationType 400: description: "There was a problem with the client's request\n ___\n \ Substatus codes are mentioned below:\n + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema put: is: - putResponse description: Updates an existing association type. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.deviceType.associationType.v1+json type: string required: true body: application/vnd.com.covisint.platform.deviceType.associationType.v1+json: schema: deviceType.associationType responses: 200: description: The associationType was successfully updated. body: application/vnd.com.covisint.platform.deviceType.associationType.v1+json: schema: deviceType.associationType 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + 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] + association.type.invalid.iso.language.code - The following language codes are invalid: {languageCodes} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Deletes a association type. headers: responses: 204: description: The association type was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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 404: description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/devices": is: - secured description: Collection endpoint for devices. get: is: - getSearchResponse - pagableRequest description: Search devices based on the given filter parameters. headers: Accept: description: Media type. Setting includeProperties media type attribute to true inlines the device's additional properties in the representation. Setting includeDeviceType media type attribute to true inlines the device's device type in the representation. example: application/vnd.com.covisint.platform.device.v1+json;includeProperties=true;includeDeviceType=true type: string required: true queryParameters: owner.id: description: Retrieve only devices with the specified owner id. type: string required: true owner.type: description: Retrieve only devices with the specified owner type. type: string required: false deviceType.id: description: Retrieve only devices with the specified device type. Multiple parameters are supported and the search results will be a union. type: string required: false deviceUuid: description: Retrieve only devices with the specified device UUID. Multiple parameters are supported and the search results will be a union. type: string required: false name.text: description: Retrieve only devices with the specified name. Multiple parameters are supported and the search results will be a union. type: string required: false description.text: description: Retrieve only devices with the specified description. Multiple parameters are supported and the search results will be a union. type: string required: false sortBy: description: Sort the search results according to the supported sortable properties. type: string required: false enum: - "+creation" - "-creation" 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.v1+json: schema: devices 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + 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 post: is: - postResponse description: Adds a new device. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.device.v1+json type: string required: true body: application/vnd.com.covisint.platform.device.v1+json: schema: device responses: 201: description: The device was successfully created. body: application/vnd.com.covisint.platform.device.v1+json: schema: device 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:resource:missing - The following resources were not found: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + device.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} + device.deviceUuid.duplicate - The device with deviceUuid {deviceUuid} already exists body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{id}": description: Endpoint for a Device. uriParameters: id: description: Unique identifier for the device. type: string required: true is: - secured get: is: - getResponse description: Returns a device by its unique identifier. headers: Accept: description: Media type. Setting includeProperties media type attribute to true inlines the device's additional properties in the representation. Setting includeDeviceType media type attribute to true inlines the device's device type in the representation. example: application/vnd.com.covisint.platform.device.v1+json;includeProperties=true;includeDeviceType=true type: string required: true responses: 200: description: The device was successfully retrieved. body: application/vnd.com.covisint.platform.device.v1+json: schema: device 400: description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema put: is: - putResponse description: Updates an existing device. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.device.v1+json type: string required: true body: application/vnd.com.covisint.platform.device.v1+json: schema: device responses: 200: description: The device was successfully updated. body: application/vnd.com.covisint.platform.device.v1+json: schema: device 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + 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] + device.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Deletes a device. headers: responses: 204: description: The device was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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 404: description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/claimDevice": is: - secured description: Generates a new claim code for the device and ownerId. post: is: - postResponse description: Generates a new claim code for the device and ownerId. Device is associated with the new claim code and ownerId. Claim code is marked as verified false. headers: queryParameters: deviceId: description: The unique identifier of the device. type: string required: true ownerId: description: The unique identifier of the owner resource. type: string required: true ownerType: description: Resource type for the owner (E.g. - PERSON). type: string required: false responses: 204: description: Claim code is succesfully generated. 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + device.owner.invalid.claim - The device has already been claimed by ownerId {ownerId}. + device.multiple.deviceIds.not.allowed - Multiple deviceIds are not allowed. + device.multiple.ownerIds.not.allowed - Multiple ownerIds are not allowed. + device.multiple.ownerTypes.not.allowed - Multiple ownerTypes are not allowed. + device.invalid.deviceId - The device id {deviceId} does not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 404: description: | Resource not found. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/verifyClaim": is: - secured description: Marks the claim code as verified. post: is: - postResponse description: Verifies the claim code on the device. headers: queryParameters: deviceId: description: The device id. type: string required: true claimCode: description: Claim code for the device. type: string required: true responses: 204: description: Claim code is successfully verified. 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + device.claimCode.invalid - The claimCode {claimCode} is invalid. + device.claimCode.verification.duplicate - The claim is already verified. + device.multiple.deviceIds.not.allowed - Multiple deviceIds are not allowed. + device.multiple.claimCodes.not.allowed - Multiple claimCodes are not allowed. + device.invalid.deviceId - The device id {deviceId} does not exist. 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: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/deviceAssociationRequests": is: - secured description: Collection endpoint for device association requests. get: is: - getSearchResponse - pagableRequest description: Search device association requests based on the given filter parameters. If no parameters are supplied, service will default to return device association requests for devices where the requestor is the owner of the device. device.owner.id=x-requestor. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.deviceassociation.request.v1+json type: string required: true queryParameters: email: description: Retrieve only device association requests with the specified email address. Multiple parameters are supported and the search results will be a union. type: string required: false invitee.id: description: Retrieve only device association requests with the specified invitee id. Multiple parameters are supported and the search results will be a union. type: string required: false device.owner.id: description: Retrieve only device association requests with the specified owner id of the device. Multiple parameters are supported and the search results will be a union. type: string required: false device.id: description: Retrieve only device association requests with the specified device id. Multiple parameters are supported and the search results will be a union. type: string required: false status: description: Retrieve only device association requests with the specified status. Multiple parameters are supported and the search results will be a union. type: string enum: - OPEN - PENDING - APPROVED - REJECTED required: false sortBy: description: Sort the search results according to the supported sortable properties. type: string required: false enum: - "+creation" - "-creation" responses: 200: description: All device association requests that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.deviceassociation.request.v1+json: schema: deviceassociation.requests 400: description: "There was a problem with the client's request\n___\nSubstatus codes and error messages are mentioned below:\n+ framework:request\n+ framework:request:io\n+ framework:request:io:read - Invalid input. There was an error while parsing.\n+ framework:request:io:read:parsing\n+ framework:request:io:write\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:param:missing - Missing request parameter: {queryParameterName}\n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]\t\t \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema post: is: - postResponse description: Creates a new device association request in OPEN status. Response includes a device request code for the request. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.deviceassociation.request.v1+json type: string required: true body: application/vnd.com.covisint.platform.deviceassociation.request.v1+json: schema: deviceassociation.request responses: 201: description: A new device association request was created in OPEN status. body: application/vnd.com.covisint.platform.deviceassociation.request.v1+json: schema: deviceassociation.request 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + device.association.request.invalid.expiresIn - The expiresIn value is in the past. + device.association.request.invalid.email.format - Invalid email id format {emailId} + framework:resource:missing - The following resources were not found: Device - {deviceId} + framework:resource:missing - The following resources were not found: Association type - {associationTypeId} and Device - {deviceId} + framework:resource:missing - The following resources were not found: Association type - {associationTypeId} for the given Device - {deviceId} + device.association.request.duplicate.device.association - The device association already exists for inviteeId {inviteeId} and inviteeType {inviteeType} + device.association.request.duplicate - The device association request already exists for deviceId - {deviceId}, associationTypeId - {associationTypeId} and inviteeId - {inviteeId}. + device.association.request.duplicate - The device association request already exists for deviceId - {deviceId}, associationTypeId - {associationTypeId} and email - {email}. + device.association.request.duplicate - The device association request already exists for deviceId - {deviceId}, associationTypeId - {associationTypeId} and inviteeId - {inviteeId} / email - {email}. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{deviceAssociationRequestId}": description: Endpoint for a device association request. uriParameters: deviceAssociationRequestId: description: Unique identifier for the device association request. type: string required: true is: - secured get: is: - getResponse description: Returns a device association request by it's unique identifier. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.deviceassociation.request.v1+json type: string required: true responses: 200: description: The device association request was successfully retrieved. body: application/vnd.com.covisint.platform.deviceassociation.request.v1+json: schema: deviceassociation.request 400: description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Deletes a device association request. headers: responses: 204: description: The device association request was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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 404: description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/acceptDeviceAssociationRequest": is: - secured description: Accepts the device association request. post: is: - postResponse description: Verifies the device request code, and changes the status of device association request. Device request should be in OPEN status and not expired. Status of device association request will be APPROVED if the device association request does not need any verification, else the status of device association request will be moved to PENDING. Device association for the resource will be created when the device association request is APPROVED. headers: queryParameters: deviceRequestCode: description: Request code for the device association request. type: string required: true inviteeId: description: Identifier for the invited resource. type: string required: true inviteeType: description: Type for the invited resource (E.g. - PERSON) type: string required: true responses: 204: description: Request code is succesfully verified and device association is updated. 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + device.association.request.multiple.deviceRequestCodes.not.allowed - Multiple deviceRequestCodes are not allowed + device.association.request.multiple.inviteeIds.not.allowed - Multiple inviteeIds are not allowed + device.association.request.multiple.inviteeTypes.not.allowed - Multiple inviteeTypes are not allowed + device.association.request.invalid.deviceRequestCode - The device request code {deviceRequestCode} does not exist. + device.association.request.status.invalid - The device association request is not in OPEN status . + device.association.request.expired - The device association request cannot be accepted as the request has expired. + device.association.request.conflict.inviteeId - The supplied inviteeId {inviteeId} does not match the inviteeId of the device association request. + device.association.request.conflict.inviteeType - The supplied inviteeType {inviteeType} does not match the inviteeType of the device association request. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/approveDeviceAssociationRequest": is: - secured description: Owner approves the device association request. Request must be in PENDING status. post: is: - postResponse description: Owner approves the device association request. Request must be in PENDING status. headers: queryParameters: ownerId: description: The unique identifier of the device owner. type: string required: true deviceAssociationRequestId: description: The unique identifier for a device association request. type: string required: true responses: 204: description: The device association request was approved. 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + device.association.request.multiple.deviceAssociationRequestIds.not.allowed - Multiple deviceAssociationRequestIds are not allowed + device.association.request.multiple.ownerIds.not.allowed - Multiple ownerIds are not allowed + device.association.request.invalid.deviceAssociationRequestId - The device association request id {deviceAssociationRequestId} does not exist. + device.association.request.status.invalid - The device association request is not in PENDING status . + device.association.request.conflict.ownerId - The supplied ownerId {ownerId} does not match the device ownerId of the device association request. + device.association.request.duplicate.device.association - The device association already exists for inviteeId {inviteeId} and inviteeType {inviteeType} 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: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/rejectDeviceAssociationRequest": is: - secured description: Owner rejects the device association request. Request must be in PENDING status. post: is: - postResponse description: Owner rejects the device association request. Request must be in PENDING status. headers: queryParameters: ownerId: description: The unique identifier of the device owner. type: string required: true deviceAssociationRequestId: description: The unique identifier for a device association. type: string required: true responses: 204: description: The device association request was rejected. 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + device.association.request.multiple.deviceAssociationRequestIds.not.allowed - Multiple deviceAssociationRequestIds are not allowed + device.association.request.multiple.ownerIds.not.allowed - Multiple ownerIds are not allowed + device.association.request.invalid.deviceAssociationRequestId - The device association request id {deviceAssociationRequestId} does not exist. + device.association.request.status.invalid - The device association request is not in PENDING status . + device.association.request.conflict.ownerId - The supplied ownerId {ownerId} does not match the device ownerId of the device association request. 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: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/deviceAssociations": is: - secured description: Collection endpoint for device associations. get: is: - getSearchResponse - pagableRequest description: Search device associations based on the given filter parameters. If no parameters are supplied, service will default to return device associations where the requestor is the subject of device association. subject.id=x-requestor. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.device.association.v1+json type: string required: true queryParameters: subject.id: description: Retrieve all device associations with the specified subject id in the association. Multiple parameters are supported and the search results will be a union. type: string required: false device.owner.id: description: Retrieve all device associations with the specified owner id for the device. Multiple parameters are supported and the search results will be a union. type: string required: false device.deviceUuid: description: Retrieve only device associations with the specified device UUID. Multiple parameters are supported and the search results will be a union. type: string required: false sortBy: description: Sort the search results according to the supported sortable properties. type: string required: false enum: - "+creation" - "-creation" responses: 200: description: All device associations that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.device.association.v1+json: schema: device.associations 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + 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 post: is: - postResponse description: Creates a new device association. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.device.association.v1+json type: string required: true body: application/vnd.com.covisint.platform.device.association.v1+json: schema: device.association responses: 201: description: A new device association was created. body: application/vnd.com.covisint.platform.device.association.v1+json: schema: device.association 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + framework:resource:missing - The following resources were not found: Association type {associationTypeId} and device {deviceId} + framework:resource:missing - The following resources were not found: Association type {associationTypeId} for the given device {deviceId} + device.association.duplicate - The device association already exists. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{deviceAssociationId}": description: Endpoint for a device association. uriParameters: deviceAssociationId: description: Unique identifier for the device association. type: string required: true is: - secured get: is: - getResponse description: Returns a device association by its unique identifier. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.device.association.v1+json type: string required: true responses: 200: description: The device association was successfully retrieved. body: application/vnd.com.covisint.platform.device.association.v1+json: schema: device.association 400: description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema put: is: - putResponse description: Updates an existing device association. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.device.association.v1+json type: string required: true body: application/vnd.com.covisint.platform.device.association.v1+json: schema: device.association responses: 200: description: The device association was successfully updated. body: application/vnd.com.covisint.platform.device.association.v1+json: schema: device.association 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + 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] + framework:resource:missing - The following resources were not found: {resources} + framework:resource:missing - The following resources were not found: Association type {associationTypeId} and device {deviceId} + framework:resource:missing - The following resources were not found: Association type {associationTypeId} for the given device {deviceId} + device.association.duplicate - The device association cannot be updated as it results in duplicate device association for subject.id - {subjectId}, device.id - {deviceId} and associationType.id - {associationTypeId}. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Deletes a device association. headers: responses: 204: description: The device association was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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 404: description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema