#%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", "maxLength" : 36, "description" : "The unique identifier for the resource.", "required": true }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } } - namedResourceReference: "{\n \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the basic resource reference and adds internationalized name and description.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"properties\" : {\n \"name\" : { \n \"description\": \"Internationalized resource name.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : { \n \"description\": \"Internationalized resource description.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\n }\n}\n" - resource: "{\n \"id\" : \"http://api.covisint.com/schema/resource\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resource\",\n \"type\" : \"object\",\n \"description\" : \"A basic resource.\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \ \"required\": true\n },\n \"version\": {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \ \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \ \"creator\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \ \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \"required\": false\n },\n \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \ \"required\": false \n }\n }\n }\n }\n}\n" - resourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/resourceV2\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resourceV2\",\n \ \"type\" : \"object\",\n \"description\" : \"A basic resource (version V2).\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \"required\": false\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \"required\": false \n \ }\n }\n }\n } \n}\n" - realmScopedResource: | { "id" : "http://api.covisint.com/schema/realmScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the base resource and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resource#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available", "required": false } } } - realmScopedResourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResourceV2\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : {\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This is mandatory if x-realm header is NOT available\",\n \ \"required\": false\n }\n }\n} \n" - errorResponseSchema: "{\n \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n \"properties\" : {\n \"status\" : { \n \"type\" : \"number\",\n \"minimum\" : 400,\n \ \"maximum\" : 599,\n \"description\" : \"The HTTP status code.\",\n \ \"required\": true\n },\n \"apiMessage\" : { \n \"type\" : \"string\",\n \ \"description\" : \"A helpful, human-readable description of the error, useful for basic diagnostics.\" \n },\n \"apiStatusCode\" : {\n \"type\" : \"string\",\n \"description\" : \"The API-specific status code.\"\n }\n \ }\n}\n" - serviceCode: "{\n \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\": \"object\",\n \"description\": \"The site/service/location codes granted along with a service.\",\n \"properties\": {\n \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200, \"description\": \"The code value.\" },\n \"codeKind\": { \"type\": \"string\", \"required\": true, \"maxLength\": 36, \"description\": \"The associated business unit.\" }\n }\n} \n" - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "type" : "string", "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type": "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: "{\n \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"A container for phone number details.\",\n \"properties\" : {\n \"number\" : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\" },\n \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\" : \"The phone number type.\" }\n },\n \"required\" : [ \"type\" ]\n} \n" - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - 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 ],\n \"required\": true,\n \ \"description\": \"The communication protocol MQTT/JMS/HTTPS/AMQP/STOMP 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 \"ownerSecurityType\": {\n \"enum\": [\n \"NONE\",\n \"REALM\",\n \"BASIC\",\n \"JWT\"\n \ ],\n \"required\": true,\n \"description\": \"The device security types NONE/REALM/BASIC/JWT 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 \"description\": \"The id of the owner for which this stream is being defined (only applicable for streamType == device).\"\n },\n \"consumerTopic\": {\n \"type\": \"string\",\n \"required\": true,\n \"minLength\": 1,\n \"maxLength\": 200,\n \"description\": \"The name of the consumer topic for the stream.\",\n \"readOnly\": true\n },\n \"producerTopic\": {\n \"type\": \"string\",\n \"required\": true,\n \"minLength\": 1,\n \"maxLength\": 200,\n \"description\": \"The name of the producer topic for the stream.\",\n \"readOnly\": true\n },\n \"alertConsumerTopic\": {\n \"type\": \"string\",\n \"required\": true,\n \"minLength\": 1,\n \"maxLength\": 200,\n \"description\": \"The name of the alert Consumer topic for the stream.\",\n \"readOnly\": true\n },\n \"messageProcessorTopic\": {\n \"type\": \"string\",\n \"required\": true,\n \"minLength\": 1,\n \"maxLength\": 200,\n \"description\": \"The name of the message processor topic for the stream.\",\n \"readOnly\": true\n },\t \n \ \"streamConfiguration\": {\n \"type\": \"object\",\n \"description\": \"The stream configuration to be employed.\",\n \"properties\": {\n \"logMode\": {\n \"type\": \"string\",\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 \"type\":\"array\",\n \"description\":\"The list of attribute protocol security attributes associated to the stream.\",\n \ \"required\":true,\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 \"type\":\"array\",\n \ \"description\":\"The list of attribute payload security attributes associated to the stream.\",\n \"required\":true,\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 \"ownerSecurityAttributes\":{\n \ \"type\":\"array\",\n \"description\":\"The list of attribute owner security attributes associated to the stream.\",\n \"required\":true,\n \ \"minItems\":1,\n \"items\":[ \n { \n \"anyOf\": [\n {\n \"type\": \"string\",\n \"description\": \"The name of the owner security attributes. password,salt etc.\",\n \"required\": true\n },\n {\n \"type\": \"string\",\n \"description\": \"The value of the owner security attributes. salt,salt etc.\",\n \"required\": true\n }\n \ ]\n }\n ]\n }, \n \"streamState\": {\n \"enum\": [\n \"ACTIVE\", \n \"INACTIVE\"\n \ ],\n \"required\": true,\n \"description\": \"The present state types ACTIVE/INACTIVE of stream.\"\n } \n }\n} \n" - streamDevices: | { "id": "http://api.covisint.com/schema/deviceRegistrations", "$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 unique stream id\"\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: description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 403: description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getResponse: responses: 404: &3 description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 406: &1 description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: &2 description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getSearchResponse: responses: 406: *1 500: *2 - postResponse: responses: 406: *1 415: &4 description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: *2 - deleteResponse: responses: 500: *2 - putResponse: responses: 404: *3 406: *1 409: &5 description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 415: *4 500: *2 - putResponseV2: responses: 404: *3 406: *1 409: description: | There is a conflict in identifying the resource being acted on. The unique identifier in the URL and body are different. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 415: *4 500: *2 - putCreateResponse: responses: 406: *1 409: *5 415: *4 500: *2 - pagableRequest: queryParameters: page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false minimum: 1 default: 50 maximum: 200 - taggable: queryParameters: tag: description: Get the resource based on specified tag. Multiple parameters are allowed and the search results will be a union. type: string required: false - sortable: queryParameters: sortBy: description: Sort the results based on some criteria. example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). type: string required: false - searchable: description: Search resources based on the given filter parameters. Search is case-insensitive. <> <> "/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 based on the given 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 protocalType: description: Retrieve attribute types with the specified protocalType. 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 "/{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 put: description: Updates an existing stream. Throws an error if {streamId} does not already exist. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.stream.v1+json type: string required: true Content-Type: description: The Content type example: application/vnd.com.covisint.platform.stream.v1+json type: string required: true is: - putResponseV2 - secured body: application/vnd.com.covisint.platform.stream.v1+json: schema: stream responses: 200: description: Successfully updated the requested stream. 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 "/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.streamDevice.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.streamDevice.v1+json type: string required: true is: - postResponse - secured body: application/vnd.com.covisint.platform.streamDevice.v1+json: schema: streamDevice responses: 201: description: Device registered successfully. body: application/vnd.com.covisint.platform.streamDevice.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: List all devices attached to this stream. is: - pagableRequest - sortable - getSearchResponse - secured headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.deviceRegistration.v1+json type: string required: true queryParameters: id: description: Retrieve attribute types with the specified streamID. 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 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 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" - "+deviceId" - "-deviceId" responses: 200: description: The attached devices were successfully retrieved. body: application/vnd.com.covisint.platform.streamDevices.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 "/{deviceId}": description: Individual association endpoint between streams and devices. uriParameters: deviceId: type: string required: true minLength: 1 maxLength: 60 get: description: Retrieves the device associated with the stream by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.streamDevice.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.streamDevice.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.platform.stream.v1+json: schema: errorResponseSchema delete: description: Removes a device from the given stream. 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