#%RAML 0.8 title: Stream version: 1 baseUri: https://api.us1.covisint.com/stream/v1 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 } } } - streams: | { "id": "http://api.covisint.com/schema/streams", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of stream definitions.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/stream#" } } - stream: "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"id\": \"http://api.covisint.com/schema/stream\",\n \"type\": \"object\",\n \"description\": \"Schema representing a datahub stream.\",\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 \"streamType\": {\n \"description\": \"Source that creates the stream.\",\n \"enum\": [\n \"DEVICE\",\n \"APPLICATION\"\n \ ],\n \"required\": true\n }, \n \"protocolType\": {\n \"enum\": [\n \"MQTT\",\n \"HTTPS\",\n \"JMS\",\n \ \"STOMP\",\n \"AMQP\",\n \"WSS\"\n ],\n \"required\": true,\n \"description\": \"The communication protocol MQTT/JMS/HTTPS/AMQP/STOMP/WSS supported by the stream.\"\n },\n \"protocolSecurityType\": {\n \"enum\": [\n \"NONE\",\n \"BASIC\"\n ],\n \"required\": true,\n \"description\": \"The protocol security types NONE/BASIC supported by the stream.\"\n },\n \"payloadSecurityType\": {\n \"enum\": [\n \"NONE\",\n \"ENCRYPTED\"\n ],\n \"required\": true,\n \"description\": \"The payload security types NONE/ENCRYPTED supported by the stream.\"\n },\n \"ownerId\": {\n \"type\": \"string\",\n \ \"minLength\": 1,\n \"maxLength\": 60,\n \"required\": true,\t\t\t \ \n \"description\": \"The id of the owner for which this stream is being defined.\"\n },\n \"consumerTopic\": {\n \"type\": \"string\",\n \"required\": false,\n \"minLength\": 1,\n \"maxLength\": 200,\n \"description\": \"The name of the consumer topic for the stream.\"\n \ },\n \"producerTopic\": {\n \"type\": \"string\",\n \"required\": false,\n \"minLength\": 1,\n \"maxLength\": 200,\n \"description\": \"The name of the producer topic for the stream.\"\n },\n \"alertConsumerTopic\": {\n \"type\": \"string\",\n \"required\": false,\n \"minLength\": 1,\n \"maxLength\": 200,\n \"description\": \"The name of the alert Consumer topic for the stream.\"\n },\n \"messageProcessorTopic\": {\n \ \"type\": \"string\",\n \"required\": false,\n \"minLength\": 1,\n \"maxLength\": 200,\n \"description\": \"The name of the message processor topic for the stream.\"\n },\n \"messageProcessorPartitionId\": {\n \"type\": \"string\",\n \"required\": false,\n \"minLength\": 1,\n \"maxLength\": 5,\n \"description\": \"The partition ID for the inbound processing topic.\",\n \"readOnly\": true\n },\n \"streamConfiguration\": {\n \"type\": \"object\",\n \"required\" : false,\t\t\t \n \ \"description\": \"The stream configuration to be employed.\",\n \"properties\": {\n \"logMode\": {\n \"enum\": [\n \"ON\",\n \ \"OFF\",\n \"INFO\",\n \"DEBUG\"\n ],\n \ \"required\": true,\n \"description\": \"The log mode of the stream configuration.\",\n \"readOnly\": true\n },\n \"pullingThreads\": {\n \"type\": \"integer\",\n \"required\": true,\n \"minimum\": 1,\n \"maximum\": 10,\n \"description\": \"The number of threads that will pull.\"\n },\n \"sleepTime\": {\n \"type\": \"integer\",\n \"required\": true,\n \"minimum\": 100,\n \ \"maximum\": 10000,\n \"description\": \"The amount of time between fetches, in milliseconds.\"\n },\n \"quota\": {\n \"type\": \"integer\",\n \"required\": true,\n \"minimum\": 100,\n \"maximum\": 10000,\n \"description\": \"The amount of time between fetches, in milliseconds.\"\n }\n }\n \ },\n \"protocolSecurityAttributes\":{\n \"required\": false,\n \ \"type\":\"array\",\t\t\t\t \n \"description\":\"The list of attribute protocol security attributes associated to the stream.\",\n \ \"minItems\":1,\n \"items\":[\n {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"description\": \"The name of the protocol attribute. userName,password, serviceurl, and etc.\",\n \ \"required\": true\n },\n {\n \ \"type\": \"string\",\n \"description\": \"The value of the protocol attribute. userName,password, serviceurl, and etc.\",\n \ \"required\": true\n }\n ]\n \ }\n ]\n },\n \"payloadSecurityAttributes\":{\n \ \"required\": false,\n \"type\":\"array\",\t\t\t\t \n \ \"description\":\"The list of attribute payload security attributes associated to the stream.\",\n \"minItems\":1,\n \"items\":[ \ \n { \n \"anyOf\": [\n {\n \"type\": \"string\",\n \"description\": \"The name of the payload security attributes. consumerPrivateKey,producerPublicKey etc.\",\n \"required\": true\n },\n {\n \"type\": \"string\",\n \"description\": \"The value of the payload security attributes. producerPrivateKey,consumerPublicKey etc.\",\n \"required\": true\n }\n ]\n }\n ]\n \ }, \n \"streamState\": {\n \"enum\": [\n \"ACTIVE\", \ \n \"INACTIVE\"\n ],\n \"description\": \"The present state types ACTIVE/INACTIVE of stream.\"\n },\n \"encryptionAlgorithmAttributes\": {\n \"required\": true, \n \"type\":\"array\",\t\t\t\t \n \ \"description\":\"The list of encryption algorithm attributes associated to the stream.\",\n \"minItems\":1,\n \"items\":[ \n { \ \n \"anyOf\": [\n {\n \"type\": \"string\",\n \"description\": \"The name of the encryption algorithm attributes. securityStandards, algorithmName, algorithmKeySize etc.\",\n \ \"required\": true\n },\n {\n \ \"type\": \"string\",\n \"description\": \"The value of the encryption algorithm attributes. securityStandards, algorithmName, algorithmKeySize etc.\",\n \"required\": true\n }\n \ ]\n }\n ]\n },\n \"encryptionKey\": {\n \"type\": \"string\",\n \"required\": false,\t\t\t\n \"description\": \"The encryption key to be used for the stream.\"\n },\n \"ackTimeout\": {\n \"type\": \"number\",\n \"required\": false,\t\t\t\n \"description\": \"The value in milliseconds that this stream will send back an acknowledgment of a command.\"\n }\n }\n}\n" - streamDevices: | { "id": "http://api.covisint.com/schema/streamDevice", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of stream definitions.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/streamDevice#" } } - streamDevice: "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \ \"id\": \"http://api.covisint.com/schema/streamDevice\",\n \"type\": \"object\",\n \ \"properties\": {\n \"streamId\": {\n \"type\": \"string\",\n \ \"minLength\": \"1\",\n \"maxLength\": 60,\n \"description\": \"The gateway stream id on which devices will be added.\"\n },\n \"deviceId\": {\n \"type\": \"string\",\n \"minLength\": \"1\",\n \"maxLength\": 60,\n \"description\": \"The id of the device for which this stream is being defined (only applicable for streamType == device).\"\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. <> <> "/streams": description: Collection endpoint for stream resources. post: description: Create a new stream. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.stream.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.stream.v1+json type: string required: true is: - postResponse - secured body: application/vnd.com.covisint.platform.stream.v1+json: schema: stream responses: 201: description: Stream created successfully. body: application/vnd.com.covisint.platform.stream.v1+json: schema: stream 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-requester header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema get: is: - pagableRequest - sortable - getSearchResponse - secured description: Search streams in the realm based on the specified query parameters. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.stream.v1+json type: string required: true queryParameters: id: description: Filter streams by their unique id. Multiple parameter values can be provided, in which case any matching event sources will be returned. type: string required: false name: description: Retrieve attribute types with the specified streamName. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false streamType: description: Retrieve attribute types with the specified streamType. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false realmId: description: Retrieve attribute types with the specified realmId. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false protocolType: description: Retrieve attribute types with the specified protocolType. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false deviceId: description: Retrieve attribute types with the specified deviceId. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+creation" - "-creation" - "+id" - "-id" - "+name" - "-name" - "+streamType" - "-streamType" - "+realmId" - "-realmId" responses: 200: description: Matching streams were retrieved successfully. body: application/vnd.com.covisint.platform.stream.v1+json: schema: streams 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 "/count": description: Endpoint to return the count of streams that match the given query criteria. get: is: - taggable - getSearchResponse - secured description: Count streams based on the given query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: id: description: Retrieve streams count by their unique id. type: string required: false name: description: Retrieve streams count with the specified streamName. type: string required: false streamType: description: Retrieve streams count with the specified streamType. type: string required: false realmId: description: Retrieve streams count with the specified realmId. type: string required: false protocolType: description: Retrieve streams count with the specified protocolType. type: string required: false ownerId: description: Retrieve streams count with the specified ownerId. 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 "/{streamId}": description: Endpoint for an individual stream. uriParameters: streamId: description: Unique id of the stream. type: string get: description: Retrieve the stream by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.stream.v1+json type: string required: true is: - getResponse - secured responses: 200: description: Stream was successfully retrieved by its id. body: application/vnd.com.covisint.platform.stream.v1+json: schema: stream 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 stream. Throws an error if {streamId} does not already exist. headers: is: - secured responses: 204: description: Successfully deleted the stream. 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 "/tasks/activate": post: description: Activates the stream. headers: is: - secured queryParameters: streamId: description: Stream id to activate. responses: 204: description: Stream sucessfully activated. 400: description: "There was a problem with the client's request\n ___ \n \ Substatus 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 "/tasks/deactivate": post: description: Deactivates the stream. headers: is: - secured queryParameters: streamId: description: Stream id to deactivate. responses: 204: description: Stream sucessfully deactivated. 400: description: "There was a problem with the client's request.\n ___ \n \ Substatus 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 "/devices": description: Collection endpoint for devices attached to a particular stream. is: - secured post: description: Registers a device with a Connector Stream. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.stream.device.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.stream.device.v1+json type: string required: true is: - postResponse - secured body: application/vnd.com.covisint.platform.stream.device.v1+json: schema: streamDevice responses: 201: description: Device registered successfully. body: application/vnd.com.covisint.platform.stream.device.v1+json: schema: streamDevice 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: description: Retrieve all device stream definitions attached to the specified stream by given query parameters. is: - pagableRequest - sortable - getSearchResponse - secured headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.stream.device.v1+json type: string required: true queryParameters: id: description: Retrieve device stream definition by specified Id. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false deviceId: description: Retrieve device stream definition by specified deviceId. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+creation" - "-creation" - "+id" - "-id" - "+name" - "-name" - "+deviceId" - "-deviceId" responses: 200: description: The attached devices were successfully retrieved. body: application/vnd.com.covisint.platform.stream.devices.v1+json: schema: streamDevices 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 500: description: | There was an unhandled server-side error. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{id}": description: Individual association endpoint between streams and devices. uriParameters: id: type: string required: true minLength: 1 maxLength: 60 get: description: Retrieve device stream definition by specified Id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.stream.device.v1+json type: string required: true is: - getResponse - secured responses: 200: description: Associated device was successfully retrieved by its id. body: application/vnd.com.covisint.platform.stream.device.v1+json: schema: streamDevice 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 device stream definition for specified Id. is: - deleteResponse responses: 204: description: Device was successfully de associated from the stream. 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-requester header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema