#%RAML 0.8 title: IOT-Solution API baseUri: https://api.covapp.io/iotsolution/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" : { "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 } } } - iotSolutions: | { "id": "http://api.covisint.com/schema/iotSolutions", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of IOT Solutions definitions.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/iotSolution#" } } - iotSolution: | { "id": "http://api.covisint.com/schema/iotSolution", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "extends": { "$ref": "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "state": { "description": "State of the IotSolution configuration.", "enum": [ "PENDING", "ACTIVE" ], "required": true } }, "lastArchivalDate": { "description": "Last archival date of the iot solution.", "type": "date", "required": false }, "kafkaConfiguration": { "type": "array", "description": "The list of kafkaConfiguration properties associated to the iot solution.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the zookeeperConnect, kMetaDataBrokerList, kRequestRequiredAcks, zookeeper.session.timout.ms, numberOfThreads, auto.commit.intervals.ms, zookeper.sync.time.ms, AvailableWorkflowAppPartions, kPartitionerClass, kafkaBufferSize, kafkaSessionTimeout, zookeeperSessionTimeout, zookeeperConnectionTimeout, zookeeperHost, AvailableEventAppPartitions, AvailableCommandAppPartions, kafkaHost, kafkaPort, kafkaClientId.", "required": true }, { "type": "string", "description": "value of the kafkaConfiguration properties.", "required": true } ] } ] }, "capsConfiguration": { "type": "array", "description": "The list of custom adapdter protocol properties associated to the iot solution.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the protocol.name, protocol.description, caps.plugin.host, internal.device.attribute, async.device", "required": true }, { "type": "string", "description": "value of the capsConfiguration properties.", "required": true } ] } ] }, "capsDataBaseConfiguration": { "type": "array", "description": "The list of CAPS database properties associated to the iot solution.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the db.host, db.port, db.schema, db.userName, db.password", "required": true }, { "type": "string", "description": "value of the capsDataBaseConfiguration properties.", "required": true } ] } ] }, "jmsConfiguration": { "type": "array", "description": "The list of jmsConfiguration properties associated to the iot solution.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the jmsConfiguration property. java.naming.factory.initial, java.naming.provider.url.", "required": true }, { "type": "string", "description": "value of the jmsConfiguration property.", "required": true } ] } ] }, "mqttConfiguration": { "type": "array", "description": "The list of mqttConfiguration properties associated to the iot solution.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the mqttConfiguration property. broker.url, client.id.", "required": true }, { "type": "string", "description": "value of the mqttConfiguration.", "required": true } ] } ] }, "stormStreamConfiguration": { "type": "array", "description": "The list of stormStreamConfiguration properties associated to the iot platform.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the stormStreamConfiguration property. nimbus.host, topologyDebug, storm.zookeeper.port, nimbus.thrift.port, storm.zookeeper.servers, topology.tick.tuple.freq.secs", "required": true }, { "type": "string", "description": "value of the stormStreamConfiguration property. ", "required": true } ] } ] }, "applicationTopologyConfiguration": { "type": "array", "description": "The list of applicationTopologyConfiguration properties associated to the iot platform.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the applicationTopologyConfiguration property. kafkaEmitterMaxThreads,connectorTupleTick, kafkaTupleTick, commandProducerMaxThreads, applicationDeliveryMaxThreads ", "required": true }, { "type": "string", "description": "value of the applicationTopologyConfiguration. ", "required": true } ] } ] }, "deviceTopologyConfiguration": { "type": "array", "description": "The list of deviceTopologyConfiguration properties associated to the iot platform.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the deviceTopologyConfiguration property.kafkaEmitterMaxThreads, connectorTupleTick, kafkaTupleTick, commandProducerMaxThreads, applicationDeliveryMaxThreads", "required": true }, { "type": "string", "description": "value of the deviceTopologyConfiguration. ", "required": true } ] } ] }, "firmwareUpdateConfiguration": { "type": "array", "description": "The list of firmwareUpdateConfiguration properties associated to the iot platform.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the firmwareUpdateConfiguration property.kafkaEmitterMaxThreads, replication, connectorTupleTick, numberOfPartition, producerMaxThreads, topic, kafkaTupleTick, consumerGroup, register, topicType", "required": true }, { "type": "string", "description": "value of the firmwareUpdateConfiguration. ", "required": true } ] } ] }, "orchestrationConfiguration": { "type": "array", "description": "The list of orchestration configurations properties associated to the iot platform.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the orchestration property. serviceURL, database info, userId, password", "required": false }, { "type": "string", "description": "value of the orchestration configuraton. ", "required": false } ] } ] }, "gatewayTopologyConfiguration": { "type": "array", "description": "The list of gateway topology configuration properties associated to the iot platform", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the gatewayTopology configuration property.kafkaEmitterMaxThreads, connectorTupleTick, kafkaTupleTick, commandProducerMaxThreads, applicationDeliveryMaxThreads", "required": false }, { "type": "string", "description": "value of the orchestration configuraton. ", "required": false } ] } ] }, "deviceBroadcastConfiguration": { "type": "array", "description": "The list of deviceBroadcastConfiguration properties associated to the iot platform.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the deviceBroadcastConfiguration property.kafkaEmitterMaxThreads, replication, connectorTupleTick, numberOfPartition, producerMaxThreads, topic, kafkaTupleTick, consumerGroup, register, topicType", "required": true }, { "type": "string", "description": "value of the deviceBroadcastConfiguration. ", "required": true } ] } ] }, "messagingTopologyConfiguration": { "type": "array", "description": "The list of messagingTopologyConfiguration properties associated to the iot platform.", "required": true, "minItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the messagingTopologyConfiguration kafkaEmitterMaxThreads, connectorTupleTick, auth.bolt.parallelism.hint, valueadd.bolt.parallelism.hint, kafka.spout.parallelism.hint, dispatch.bolt.parallelism.hint, routing.bolt.parallelism.hint, kafkaTupleTick, commandProducerMaxThreads, applicationDeliveryMaxThreads and timeseries.bolt.parallelism.hint", "required": true }, { "type": "string", "description": "value of the messagingTopologyConfiguration.", "required": true } ] } ] }, "commandEventAckTemplate": { "type": "array", "description": "The list of commandEventAckTemplate properties associated to the iot platform.", "required": true, "minItems": 1, "maxItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the commandEventAckTemplate property.EventAckTemplate2", "required": true }, { "type": "string", "description": "value of the commandEventAckTemplate. ", "required": true } ] } ] }, "ackTemplates": { "type": "array", "description": "The list of AckTemplates associated to the iot solution.", "required": true, "minItems": 1, "maxItems": 1, "items": [ { "anyOf": [ { "type": "string", "description": "name of the AckTemplate property.Duplicate_Event_ACK", "required": true }, { "type": "string", "description": "value of the EventTemplate.", "required": true } ] } ] }, "authenticationPolicyConfiguration": { "type": "array", "description": "The list of authenticationPolicyConfiguration properties associated to the iot platform.", "required": false, "minItems": 0, "items": [ { "anyOf": [ { "type": "string", "description": "name of the authenticationPolicyConfiguration property.authenticationPolicyId, passwordPolicyId", "required": false }, { "type": "string", "description": "value of the authenticationPolicyConfiguration. ", "required": true } ] } ] } } - deliveryScriptTemplates: "{\n \"id\": \"http://api.covisint.com/schema/deliveryScriptTemplate\",\n \ \"$schema\": \"http://json-schema.org/draft-04/schema\",\n \"description\": \"Collection of delivery script templates.\",\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"http://api.covisint.com/schema/deliveryScriptTemplate#\"\n \ }\n} \n" - deliveryScriptTemplate: "{\n \"$schema\": \"http://json-schema.org/draft-04/deliveryScriptTemplate#\",\n \ \"id\": \"http://api.covisint.com/schema/deliveryScriptTemplate\",\n \"type\": \"object\",\n \"description\": \"Schema representing delivery script templates for caps\",\n \"extends\": {\n \"$ref\": \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n \ },\n \"properties\": {\n \"name\": {\n \"description\": \"name of the camel script\",\n \"type\": \"string\",\n \"required\": false\n },\n \"description\": {\n \"description\": \"description of the script template\",\n \"type\": \"string\",\n \"required\": false\n },\n \"customProtocolType\": {\n \"description\": \"type of custom protocol e.g. HTTPS,calAmp etc.\",\n \"type\": \"string\",\n \ \"required\": false\n },\n \"protocolType\": {\n \"description\": \"type of protocol e.g. CAPS,MQTT etc.\",\n \"type\": \"string\",\n \"required\": false\n },\n \"direction\": {\n \"description\": \"direction of the template script e.g. ACTIVE_SENDING,PASSIVE_REVEIVING,BOTH etc.\",\n \"type\": \"string\",\n \"required\": false\n },\n \"routeletCapable\": {\n \"description\": \"the the script editable\",\n \"type\": \"boolean\",\n \"required\": false\n },\n \"scriptBody\": {\n \ \"description\": \"Script body\",\n \"type\": \"string\",\n \ \"required\": false\n },\n \"modification\": {\n \"description\": \"last modification time\",\n \"type\": \"long\",\n \"required\": false\n }\n \n \n \n }\n} \n" - documentinfos: "{\n \"id\": \"http://api.covisint.com/schema/documentinfos\",\n \ \"$schema\": \"http://json-schema.org/draft-04/schema\",\n \"description\": \"Collection of document information.\",\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"http://api.covisint.com/schema/documentinfo#\"\n }\n} \n" - documentinfo: "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \ \"id\": \"http://api.covisint.com/schema/documentinfo\",\n \"type\": \"object\",\n \ \"description\": \"Schema representing document info for orchestration\",\n \ \"extends\":{ \n \"$ref\":\"http://api.covisint.com/schema/realmScopedResource#\"\n \ },\n \"properties\": {\n \"supportedDocType\": {\n \"description\": \"type of document to be processed e.g: xml,csv etc\",\n \"type\": \"string\",\n \ \"required\": true\n },\n \"supportedDocTemplateType\": {\n \ \"description\": \"document template type supported for orchestration e.g: HL7,WITSML,SWIFT etc\",\n \"type\": \"string\",\n \"required\": true\n },\n \"docTemplateVersion\": {\n \"description\": \"version of supported document template type\",\n \"type\": \"number\",\n \"required\": 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. <> <> "/documentinfo": description: Collection endpoint to create new document information required for orchestration . is: - secured post: description: create documents info that can be transformed and supported by the stream. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json type: string required: true is: - postResponse - secured body: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json: schema: documentinfo responses: 201: description: documentinfo created successfully. body: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json: schema: documentinfo 400: description: "There was a problem with the client's request.\n ___ \n Substatus 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: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 get: is: - pagableRequest - getSearchResponse - secured description: Search document info based on the given filter criteria parameters. headers: Accept: description: Media type example: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json type: string required: true queryParameters: supportedDocType: description: Retrieve dociInfo with the specified Type . Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false supportedDocTemplateType: description: Retrieve documentinfo with the specified id. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false docTemplateVersion: description: Retrieve documentinfo with the specified config id. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+time" - "+supportedDocType" - supportedDocTemplateType - docTemplateVersion responses: 200: description: All documentinfo that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json: schema: documentinfo 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: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 "/{id}": description: Endpoint for an individual document Infomation. uriParameters: id: description: Unique id of the docment info. type: string get: description: Retrieve the configuration by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json type: string required: true is: - getResponse - secured responses: 200: description: documentinfo was successfully retrieved by its id. body: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json: schema: documentinfo 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.\t\t\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 delete: description: Delete an existing documentinfo. Throws an error if {id} does not already exist. headers: is: - secured responses: 204: description: Successfully deleted the documentinfo. 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.\t\t\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 404: description: | The requested stream was not found. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | There was an unhandled server-side error. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema put: description: Updates an existing documentinfo. Throws an error if {documentinfoId} does not already exist. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json type: string required: true Content-Type: description: The Content type example: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json type: string required: true is: - putResponseV2 - secured body: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json: schema: documentinfo responses: 200: description: Successfully updated the requested documentinfo. body: application/vnd.com.covisint.platform.messaging.server.document-info.v1+json: schema: iotSolution 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. \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 "/count": description: Endpoint to return the count of document info that match the given query criteria. get: is: - taggable - getSearchResponse - secured description: Retrieve count of document info based on the specified query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: supportedDocType: description: Retrieve document info with the specified Type . Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false supportedDocTemplateType: description: Retrieve configuration with the specified config id. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false docTemplateVersion: description: Retrieve configuration with the specified config id. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false responses: 200: description: The number of matching document infos were returned. body: text/plain: 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 "/iotSolutions/deliveryScriptTemplate": description: Collection endpoint to create new delivery script template for CAPS server. is: - secured post: description: create delivery script template that can be transformed and supported by the stream. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json type: string required: true is: - postResponse - secured body: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json: schema: deliveryScriptTemplate responses: 201: description: deliveryScriptTemplate created successfully. body: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json: schema: deliveryScriptTemplate 400: description: "There was a problem with the client's request.\n ___ \n Substatus 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: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 get: is: - pagableRequest - getSearchResponse - secured description: Search delivery Script Template based on the given filter criteria parameters. headers: Accept: description: Media type example: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json type: string required: true queryParameters: protocolType: description: Retrieve deliveryScriptTemplate with the specified Type . Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false customProtocolType: description: Retrieve deliveryScriptTemplate with the specified id. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false direction: description: Retrieve deliveryScriptTemplate with the specified config id. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false responses: 200: description: All deliveryScriptTemplate that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json: schema: deliveryScriptTemplate 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.\t\t\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 "/{id}": description: Endpoint for an individual delivery Script Template. uriParameters: id: description: Unique id of the delivery Script Template. type: string get: description: Retrieve the configuration by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json type: string required: true is: - getResponse - secured responses: 200: description: deliveryScriptTemplate was successfully retrieved by its id. body: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json: schema: deliveryScriptTemplate 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.\t\t\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 delete: description: Delete an existing deliveryScriptTemplate. Throws an error if {id} does not already exist. headers: is: - secured responses: 204: description: Successfully deleted the deliveryScriptTemplate. 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.\t\t\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 404: description: | The requested stream was not found. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | There was an unhandled server-side error. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema put: description: Updates an existing documentinfo. Throws an error if {id} does not already exist. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json type: string required: true Content-Type: description: The Content type example: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json type: string required: true is: - putResponseV2 - secured body: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json: schema: deliveryScriptTemplate responses: 200: description: Successfully updated the requested deliveryScriptTemplate. body: application/vnd.com.covisint.platform.iotsolution.delivery-script.v1+json: schema: iotSolution 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. \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 "/count": description: Endpoint to return the count of document info that match the given query criteria. get: is: - taggable - getSearchResponse - secured description: Retrieve count of document info based on the specified query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: protocolType: description: Retrieve deliveryScriptTemplate with the specified Type . Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false customProtocolType: description: Retrieve configuration with the specified config id. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false direction: description: Retrieve configuration with the specified config id. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false responses: 200: description: The number of matching delivery Script Templates were returned. body: text/plain: 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