#%RAML 0.8 title: Device Template API baseUri: https://api.us1.covisint.com/devicetemplate/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.", "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: | { "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.", "required": true }, "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.", "required": false }, "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.", "required": true, "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.", "required": true, "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.", "required": true, "readonly": true } } } } } - 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 read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.\",\n \"required\": true,\n \ \"readonly\": true\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"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.\",\n \"required\": true,\n \"readonly\": true\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"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.\",\n \ \"required\": true,\n \"readonly\": true\n }\n }\n \ }\n } \n}\n" - realmScopedResource: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the base resource and adds a realm attribute.\",\n \ \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resource#\"\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 read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n \ }\n }\n}\n" - 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 read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \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." } } } } - baseDefinitionResource: "{\n \"id\" : \"http://api.covisint.com/schema/baseDefinitionResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\": {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n },\n \"properties\": {\n \"name\": {\n \"description\": \"The application name (internationalized).\",\n \ \"required\": true,\n \"$ref\": \"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"description\": {\n \"required\": false,\n \"description\": \"The application description (internationalized).\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }, \n \"properties\":{\n \"type\":\"array\",\n \"description\":\"Properties used by the implementation.\",\n \"required\":false,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The name of the property.\",\n \"required\": true\n },\n \ {\n \"type\": \"string\",\n \"description\": \"The value of the property.\",\n \"required\": true\n }\n \ ]\n }\n ]\n }\n }\n}\n" - 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 } } } - 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": true } } } - deviceTemplates: "{ \n \"id\":\"http://api.covisint.com/schema/deviceTemplates\",\n \ \"$schema\":\"http://json-schema.org/draft-04/schema\",\n \"description\":\"Collection of device templates\",\n \"type\":\"array\",\n \"items\":{ \n \"$ref\":\"http://api.covisint.com/schema/deviceTemplate#\"\n \ }\n}\n \n" - deviceTemplate: "{ \n \"$schema\":\"http://json-schema.org/draft-04/schema#\",\n \ \"id\":\"http://api.covisint.com/schema/deviceTemplate\",\n \"type\":\"object\",\n \ \"description\":\"Schema representing a device template.\",\n \"extends\":{ \ \n \"$ref\":\"http://api.covisint.com/schema/realmScopedResourceV2#\"\n \ },\n \"properties\":{ \n \"name\":{ \n \"description\":\"Name of the device template.\",\n \"required\":true,\n \"$ref\":\"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"description\":{ \n \"description\":\"Description of the device template.\",\n \"required\":false,\n \"$ref\":\"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"attributeTypes\":{ \n \"type\":\"array\",\n \"description\":\"The list of attribute templates associated to the device template. If the media type parameter 'fetchAttributeTypes' is sent in the Accept media type header, then the full attribute type is retrieved. Otherwise, just the attribute type id is included.\",\n \"required\":false,\n \"minItems\":0,\n \"items\":[ \ \n { \n \"anyOf\": [\n {\n \"type\": \"string\",\n \"description\": \"The id of the attribute template.\",\n \ \"required\": true\n },\n {\n \ \"$ref\": \"http://api.covisint.com/idm/schema/attributeType#\",\n \ \"description\": \"The attribute type definition.\",\n \"required\": true\n }\n ]\n }\n ]\n },\n \ \"eventTemplates\":{ \n \"type\":\"array\",\n \"description\":\"The list of event template that are associated to the device template. If the media type parameter 'fetchEventTemplates' is sent in the Accept media type header, then the full event template is retrieved. Otherwise, just the event template id is included.\",\n \"required\":false,\n \"minItems\":0,\n \"$ref\":\"http://api.covisint.com/idm/schema/eventTemplate#\",\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The id of the event template.\",\n \"required\": true\n },\n \ {\n \"$ref\": \"http://api.covisint.com/idm/schema/eventTemplate#\",\n \ \"description\": \"The event template definition.\",\n \"required\": true\n }\n ]\n }\n ]\n },\n \ \"commandTemplates\":{ \n \"type\":\"array\",\n \"description\":\"The list of command template that are associated to the device template. If the media type parameter 'fetchCommandTemplate' is sent in the Accept media type header, then the full command template is retrieved. Otherwise, just the command template id is included.\",\n \"required\":false,\n \"minItems\":0,\n \"$ref\":\"http://api.covisint.com/idm/schema/commandTemplate#\",\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The id of the command template.\",\n \"required\": true\n \ },\n {\n \"$ref\": \"http://api.covisint.com/idm/schema/commandTemplate#\",\n \ \"description\": \"The command template definition.\",\n \"required\": true\n }\n ]\n }\n ]\n },\n \ \"isActive\":{ \n \"type\":\"boolean\",\n \"description\":\"Whether or not this deviceTemplate is active.\",\n \"default\":false,\n \"readOnly\": true\n },\n \"tags\":{ \n \"description\":\"The list of tags associated to the device template.\",\n \"$ref\":\"http://api.covisint.com/schema/tags#\",\n \ \"readOnly\": true\n },\n \"successorDeviceTemplateId\": {\n \ \"description\": \"The id of the device template that succeeds this one. This is typically used when a new firmware version is available and the template needs to be revised to accomodate for any new/deprecated attributes and features of the new firmware. In this scenario, a new template is created and is marked as a successor to the old one.\",\n \"type\": \"string\",\n \ \"required\": false,\n \"readOnly\": true\n }\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: &6 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: &7 description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - unsecured: usage: Apply this to any method that needs to be unsecured. Requests with this trait does not require any authentication. headers: SolutionInstanceId: description: The solution instance id. example: ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk required: true responses: 400: description: Bad request. Please provide the valid solution instance id. 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 - taskResponse: responses: 401: *6 403: *7 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. <> <> "/deviceTemplates": description: Collection endpoint for device templates. is: - secured get: is: - searchable: since: '' entitlement: "[Entitlement:devicetmpl-search-device-templates]" - pagableRequest - sortable - taggable - getSearchResponse description: Search device templates in the realm based on the specified query parameters. headers: Accept: description: The media type for v1 devices. Specify parameter fetchattributetypes with a value of true to return the full attribute type information nested within the device template resource, opposed to just the attribute type id being returned. Specify parameter fetcheventtemplates with a value of true to return the full event template information nested within the device template resource, opposed to just the event template id being returned. Specify parameter fetchcommandtemplates with a value of true to return the full command template information nested within the device template resource, opposed to just the command template id being returned. example: application/vnd.com.covisint.platform.deviceTemplate.v1+json;fetchattributetypes=true;fetcheventtemplates=true;fetchcommandtemplates=true type: string required: true queryParameters: id: description: Retrieve device templates with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false name: description: Retrieve device templates with the specified name. Multiple parameters are allowed and the search results will be a union. type: string required: false description: description: Retrieve device templates with the specified description. Multiple parameters are allowed and the search results will be a union. type: string required: false active: description: Retrieve device templates based on their active status. type: boolean required: false attributeTypes.id: description: Retrieve device templates referencing an attribute type of the given attribute type id. Multiple parameters are allowed and the search results will be a union. type: string required: false eventTemplates.id: description: Retrieve device templates referencing an event of the given event id. Multiple parameters are allowed and the search results will be a union. type: string required: false commandTemplates.id: description: Retrieve device templates referencing a command of the given command id. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: type: string required: false enum: - "+creation" - "-creation" responses: 200: description: All device templates that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.deviceTemplate.v1+json: schema: deviceTemplates 400: description: "There was a problem with the client's request.\n ___ \nSubstatus codes and error messages are mentioned below:\n + framework:request:io:read - There was an error while reading the request body.\n + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n + framework:request:header:missing - Missing request header: {headerName}\n + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \n" 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 "/count": description: Endpoint to return the count of device template that match the given query criteria. get: is: - taggable - getSearchResponse - secured description: Count Device Template based on the given query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: id: description: Retrieve count of device templates with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false name: description: Retrieve count of device templates with the specified name. Multiple parameters are allowed and the search results will be a union. type: string required: false description: description: Retrieve count of device templates with the specified description. Multiple parameters are allowed and the search results will be a union. type: string required: false active: description: Retrieve count of device templates based on their active status. type: boolean required: false attributeTypes.id: description: Retrieve count of device templates referencing an attribute type of the given attribute type id. Multiple parameters are allowed and the search results will be a union. type: string required: false eventTemplates.id: description: Retrieve count of device templates referencing an event of the given event id. Multiple parameters are allowed and the search results will be a union. type: string required: false commandTemplates.id: description: Retrieve count of device templates referencing a command of the given command id. Multiple parameters are allowed and the search results will be a union. type: string required: false responses: 200: description: The number of matching streams were returned. body: plain/text: 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:header:missing - Missing request header: {headerName} \ \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] \ \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema post: description: Create a new device template. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.deviceTemplate.v1+json type: string required: true Content-Type: description: The content type. example: application/vnd.com.covisint.platform.deviceTemplate.v1+json type: string required: true queryParameters: succeedsTemplateId: description: The id of the device template that this one will succeed. type: string required: false is: - postResponse body: application/vnd.com.covisint.platform.deviceTemplate.v1+json: schema: deviceTemplate responses: 201: description: Device template successfully created. body: application/vnd.com.covisint.platform.deviceTemplate.v1+json: schema: deviceTemplate 400: description: "There was a problem with the client's request.\n ___ \nSubstatus codes and error messages are mentioned below:\n + framework:request:io:read - There was an error while reading the request body.\n + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n + framework:request:header:missing - Missing request header: {headerName}\n + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \ \n" 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 "/{deviceTemplateId}": description: Endpoints for individual device template. is: - secured uriParameters: deviceTemplateId: description: unique id of the device template. type: string minLength: 1 get: description: Retrieves the requested device template. headers: Accept: description: The media type for v1 devices. Specify parameter fetchattributetypes with a value of true to return the full attribute type information nested within the device template resource, opposed to just the attribute type id being returned. Specify parameter fetcheventtemplates with a value of true to return the full event template information nested within the device template resource, opposed to just the event template id being returned. Specify parameter fetchcommandtemplates with a value of true to return the full command template information nested within the device template resource, opposed to just the command template id being returned. example: application/vnd.com.covisint.platform.deviceTemplate.v1+json;fetchattributetypes=true;fetcheventtemplates=true;fetchcommandtemplates=true type: string required: true is: - getResponse responses: 200: description: Successfully retrieved the requested device template. body: application/vnd.com.covisint.platform.deviceTemplate.v1+json: schema: deviceTemplate 400: description: "There was a problem with the client's request.\n ___ \nSubstatus codes and error messages are mentioned below:\n + framework:request:io:read - There was an error while reading the request body.\n + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n + framework:request:header:missing - Missing request header: {headerName}\n + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \n" 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 "/tags/{tag}": description: Tag endpoint for device templates. is: - secured uriParameters: tag: description: The tag value. minLength: 1 maxLength: 2000 required: true type: string put: description: Tags the specified device template. responses: 204: description: The tag was successfully added. 400: description: "There was a problem with the client's request.\n___ \nSubstatus codes and error messages are mentioned below:\n + framework:request:io:read - There was an error while reading the request body.\n + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n \ + framework:request:header:missing - Missing request header: {headerName}\n \ + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 404: description: The device template did not exist. 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 delete: description: Removes a tag from the device template. responses: 204: description: The tag was successfully removed. 400: description: "There was a problem with the client's request.\n___ \nSubstatus codes and error messages are mentioned below:\n + framework:request:io:read - There was an error while reading the request body.\n + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n \ + framework:request:header:missing - Missing request header: {headerName}\n \ + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 404: description: The specified tag was not associated to the device template, or the device template did not exist. 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 "/tasks/activate": description: Activation endpoint for device templates. is: - secured post: description: Activates the device template. Has no effect on an already-active device template. queryParameters: deviceTemplateId: description: id of the device template to activate. responses: 204: description: Device template successfully activated. 400: description: "There was a problem with the client's request.\n ___ \nSubstatus codes and error messages are mentioned below:\n + framework:request:io:read - There was an error while reading the request body.\n + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n + framework:request:header:missing - Missing request header: {headerName}\n + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \n" 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 "/tasks/deactivate": description: Dctivation endpoint for device templates. is: - secured post: description: Deactivate the device template. Has no effect on an already-inactive device template. queryParameters: deviceTemplateId: description: id of the device template to deactivate. responses: 204: description: Device template successfully deactivated. 400: description: "There was a problem with the client's request.\n ___ \nSubstatus codes and error messages are mentioned below:\n + framework:request:io:read - There was an error while reading the request body.\n + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n + framework:request:header:missing - Missing request header: {headerName}\n + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \n" 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