#%RAML 0.8 title: Datahub Tracking API baseUri: https://api.us1.covisint.com/tracking/v1 protocols: - HTTPS schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource.", "required": true }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } } - namedResourceReference: "{\n \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the basic resource reference and adds internationalized name and description.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"properties\" : {\n \"name\" : { \n \"description\": \"Internationalized resource name.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : { \n \"description\": \"Internationalized resource description.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\n }\n}\n" - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource.", "required": true }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.", "required": false }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "required": true, "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "required": true, "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "required": true, "readonly": true } } } } } - resourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/resourceV2\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resourceV2\",\n \ \"type\" : \"object\",\n \"description\" : \"A basic resource (version V2).\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.\",\n \"required\": true,\n \ \"readonly\": true\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.\",\n \"required\": true,\n \"readonly\": true\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.\",\n \ \"required\": true,\n \"readonly\": true\n }\n }\n \ }\n } \n}\n" - realmScopedResource: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the base resource and adds a realm attribute.\",\n \ \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resource#\"\n \ },\n \"properties\" : {\n \"realm\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n \ }\n }\n}\n" - realmScopedResourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResourceV2\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : {\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n }\n }\n} \n" - errorResponseSchema: "{\n \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n \"properties\" : {\n \"status\" : { \n \"type\" : \"number\",\n \"minimum\" : 400,\n \ \"maximum\" : 599,\n \"description\" : \"The HTTP status code.\",\n \ \"required\": true\n },\n \"apiMessage\" : { \n \"type\" : \"string\",\n \ \"description\" : \"A helpful, human-readable description of the error, useful for basic diagnostics.\" \n },\n \"apiStatusCode\" : {\n \"type\" : \"string\",\n \"description\" : \"The API-specific status code.\"\n }\n \ }\n}\n" - serviceCode: "{\n \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\": \"object\",\n \"description\": \"The site/service/location codes granted along with a service.\",\n \"properties\": {\n \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200, \"description\": \"The code value.\" },\n \"codeKind\": { \"type\": \"string\", \"required\": true, \"maxLength\": 36, \"description\": \"The associated business unit.\" }\n }\n} \n" - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "type" : "string", "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type": "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: "{\n \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"A container for phone number details.\",\n \"properties\" : {\n \"number\" : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\" },\n \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\" : \"The phone number type.\" }\n },\n \"required\" : [ \"type\" ]\n} \n" - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: "{\n \"id\" : \"http://api.covisint.com/schema/baseDefinitionResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\": {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n },\n \"properties\": {\n \"name\": {\n \"description\": \"The application name (internationalized).\",\n \ \"required\": true,\n \"$ref\": \"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"description\": {\n \"required\": false,\n \"description\": \"The application description (internationalized).\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }, \n \"properties\":{\n \"type\":\"array\",\n \"description\":\"Properties used by the implementation.\",\n \"required\":false,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The name of the property.\",\n \"required\": true\n },\n \ {\n \"type\": \"string\",\n \"description\": \"The value of the property.\",\n \"required\": true\n }\n \ ]\n }\n ]\n }\n }\n}\n" - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ], "required": true } } } - trackings: | { "id": "http://api.covisint.com/schema/tracking", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of tracking templates", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/tracking#" } } - tracking: "{\n \"id\": \"http://api.covisint.com/schema/tracking\",\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"messageId\": {\n \"type\": \"string\",\n \"required\": true,\n \ \"description\":\"System generated Id(GUID)for the message.\"\n },\n \ \"realm\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\" :\"Represents the reaml the message belongs to.\"\n },\n \"customerMessageID\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"MessageId generated at the client end \"\n },\n \"streamId\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"Id of stream the message belong to\"\n },\n \"deviceId\": {\n \"type\": \"string\",\n \ \"required\": true,\n \"description\": \"Id of a device the message belong to\"\n },\n \"eventId\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"EventId associated with the event route\"\n },\n \ \"commandId\": {\n \"type\": \"string\",\n \"required\": true,\n \ \"description\": \"CommandId associated with the command route\"\n },\n \ \"pathToSourceMessage\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"path to source message\"\n },\n \"dateTimeReceived\": {\n \"type\": \"integer\",\n \"required\": true,\n \"description\": \"time at which event or command received\"\n },\n \"connectorService\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"Name of the connector service\"\n },\n \"discoveryMS\": {\n \"type\": \"integer\",\n \"required\": true,\n \"description\": \"Time taken by the discovery process\"\n },\n \"connectorProcessMS\": {\n \"type\": \"integer\",\n \"required\": true,\n \"description\": \"Time taken by the connector process\"\n },\n \"connectorState\": {\n \"enum\": [\"F\",\"C\"],\n \ \"required\": true,\n \"description\": \"Status of connector either Complete or fail\"\n },\n \"exceptionStackTrace\": {\n \"type\": \"string\",\n \ \"required\": true,\n \"description\": \"Detailed Error or Exception message\"\n },\n \"parentMessageId\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Id of parent message\"\n },\n \"dateTimeDelivered\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"time at which event or command delivered\"\n },\n \"streamName\": {\n \ \"description\": \"Name of the stream.\",\n \"required\": false,\n \ \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"deviceName\": {\n \"description\": \"Name of the device.\",\n \ \"required\": false,\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"parentDeviceTemplateName\" : {\n \"description\": \"Name of the parent device template.\",\n \"required\": false,\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"eventName\" : {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Name of the event \"\n },\n \"commandName\" :{\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Name of the Command\"\n },\n \"parentDeviceTemplateId\" : {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Parent Device Template Id\"\n },\n \n \"senderWireFileAttributes\":{\n \"required\": false,\n \"type\":\"array\",\n \"description\":\"The list of sender Wire File attributes associated to the tracking.\",\n \"minItems\":1,\n \ \"items\":[\n {\n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The key of the sender Wire File attribute. hostname, payload, fileSize, and etc.\",\n \"required\": true\n },\n {\n \ \"type\": \"string\",\n \"description\": \"The value of the sender Wire File attribute. hostname, payload, fileSize, and etc.\",\n \"required\": true\n }\n ]\n \ }\n ]\n },\n \"receiveWireFileAttributes\":{\n \ \"required\": false,\n \"type\":\"array\",\t\t\t\t \n \ \"description\":\"The list of receive Wire File attributes associated to the tracking.\",\n \"minItems\":1,\n \"items\":[\n {\n \ \"anyOf\": [\n {\n \"type\": \"string\",\n \"description\": \"The key of the receive Wire File attribute. hostname, payload, fileSize, and etc.\",\n \"required\": true\n },\n {\n \"type\": \"string\",\n \"description\": \"The value of the receive Wire File attribute. hostname, payload, fileSize, and etc.\",\n \"required\": true\n }\n ]\n }\n ]\n \ },\n \"senderFileAttributes\":{\n \"required\": false,\n \ \"type\":\"array\",\t\t\t\t \n \"description\":\"The list of sender File attributes associated to the tracking.\",\n \"minItems\":1,\n \ \"items\":[\n {\n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The key of the sender File attribute. hostname, payload, fileSize, and etc.\",\n \ \"required\": true\n },\n {\n \ \"type\": \"string\",\n \"description\": \"The value of the sender File attribute. hostname, payload, fileSize, and etc.\",\n \ \"required\": true\n }\n ]\n \ }\n ]\n },\n \"receiveFileAttributes\":{\n \"required\": false,\n \"type\":\"array\",\t\t\t\t \n \"description\":\"The list of receive File attributes associated to the tracking.\",\n \"minItems\":1,\n \ \"items\":[\n {\n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The key of the receive File attribute. hostname, payload, fileSize, and etc.\",\n \ \"required\": true\n },\n {\n \ \"type\": \"string\",\n \"description\": \"The value of the receive File attribute. hostname, payload, fileSize, and etc.\",\n \ \"required\": true\n }\n ]\n \ }\n ]\n }\t\t \n }\n}\n" - processorAudits: | { "id": "http://api.covisint.com/schema/processorAudit", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of processorAudit templates", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/processorAudit#" } } - processorAudit: "{\n \"id\": \"http://api.covisint.com/schema/processorAudit\",\n \ \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \ \"properties\": {\n \"routeName\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\":\"Name of the route associated with the processorAudit.\"\n \ },\n \"eventSource\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\" :\"Id of the eventSource, associated with the processorAudit.\"\n \ },\n \"commandId\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"CommandId associated with the command route.\"\n \ },\n \"routingTopic\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"routingTopic associated with the processorAudit.\"\n \ },\n \"workflowTopic\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"workflowTopic associated with the processorAudit.\"\n \ },\n \"workflowTopology\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"Referance of workflowTopology associated with the processorAudit.\"\n },\n \"connectorService\": {\n \"type\": \"string\",\n \ \"required\": true,\n \"description\": \"Name of the connector service\"\n \ },\n \"pulledFromQueue\": {\n \"type\": \"integer\",\n \"required\": true,\n \"description\": \"pulledFromQueue associated with the processorAudit.\"\n \ },\n \"messageId\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\":\"System generated Id(GUID)for the message.\"\n },\n \ \"pathToTranslatedMessage\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"path to translated message.\"\n },\n \"destinationStreamId\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"destination StreamId associated with the processorAudit.\"\n },\n \"destinationQueue\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"destination queue name associated with the processorAudit.\"\n },\n \"connectorProcessMS\": {\n \"type\": \"integer\",\n \"required\": true,\n \"description\": \"Time taken by the connector process\"\n },\n \"connectorState\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"Status of connector either Complete or fail\"\n },\n \"exceptionStackTrace\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"Detailed Error or Exception message\"\n },\n \"processAuditId\": {\n \"type\": \"string\",\n \ \"required\": false,\n \"description\": \"Id of the process audit\"\n \ },\n \"processTimeMS\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"time taken by processorAudit.\"\n },\n \"ackId\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"acknowledgment Id sent by the device.\"\n },\n \"ackStartTime\": {\n \"type\": \"integer\",\n \"required\": false,\n \"description\": \"acknowledgment start time set by the application topology while sending a command expecting an acknowledgement from the device.\"\n },\n \"commandTTL\": {\n \"type\": \"integer\",\n \"required\": false,\n \"description\": \"the command Expiration time, set by the command Topology.\"\n },\n \"timeOfAck\": {\n \ \"type\": \"integer\",\n \"required\": false,\n \"description\": \"time at which acknowledgment received by the Device Event Topology.\"\n },\n \ \"ackStatus\": {\n \"type\": \"string\",\n \"required\": false,\n \ \"description\": \"status of acknowledgment received by the Device Event Topology.\"\n },\n \"ackErrorCode\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"error code of acknowledgment received by the Device Event Topology.\"\n },\n \"ackDescription\": {\n \"type\": \"string\",\n \ \"required\": false,\n \"description\": \"description of the acknowledgment.\"\n \ },\n \"destinationStreamNames\":{\n \"description\": \"Name of the device.\",\n \"required\": false, \"$ref\":\"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\t \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. <> <> "/trackings": get: is: - pagableRequest - getSearchResponse - secured description: Search tracking messages based on the specified query parameters. headers: Accept: description: Media type example: application/vnd.com.covisint.platform.messaging.tracking.v1+json type: string required: true queryParameters: messageId: description: Retrieve tracking messages with the specified message 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 customerMessageId: description: Retrieve tracking messages with the specified customer message 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 deviceId: description: Retrieve tracking messages with the specified device 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 commandId: description: Retrieve tracking messages with the specified command 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 realmId: description: Retrieve tracking messages with the specified realm. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false streamId: description: Retrieve tracking messages with the specified streamId. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false eventId: description: Retrieve tracking messages with the specified eventId. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false dateTimeReceived: description: Retrieve tracking messages with the dateTimeReceived. type: integer required: false connectorService: description: Retrieve tracking messages with the connectorService. type: string required: false connectorState: description: Retrieve tracking messages with the connectorState. type: string required: false parentMessageId: description: Retrieve tracking messages with the specified parent message 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 dateTimeDelivered: description: Retrieve tracking messages with the dateTimeDelivered. type: integer required: false sortBy: description: Sort the search results. type: string required: false enum: - "+messageId" - "-messageId" - "+streamId" - "-streamId" - "+dateTimeReceived" - "-dateTimeReceived" - "+parentMessageId" - "-parentMessageId" - "+dateTimeDelivered" - "-dateTimeDelivered" responses: 200: description: All tracking messages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.messaging.tracking.v1+json: schema: trackings 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]\nbody: application/vnd.com.covisint.error.v1+jsonschema: errorResponseSchema\n" "/count": description: Endpoint to return the count of trackings that match the given query criteria. get: is: - taggable - getSearchResponse - secured description: Retrieve count of tracking messages based on specified query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: messageId: description: Retrieve tracking count with the specified message id. type: string required: false customerMessageId: description: Retrieve tracking count with the specified customer message id. type: string required: false deviceId: description: Retrieve tracking count with the specified device id. type: string required: false commandId: description: Retrieve tracking count with the specified command id. type: string required: false realmId: description: Retrieve tracking count with the specified realm. type: string required: false streamId: description: Retrieve tracking count with the specified streamId. type: string required: false eventId: description: Retrieve tracking count with the specified eventId. type: string required: false dateTimeReceived: description: Retrieve tracking count with the dateTimeReceived. type: integer required: false connectorService: description: Retrieve tracking count with the connectorService. type: string required: false connectorState: description: Retrieve tracking count with the connectorState. type: string required: false parentMessageId: description: Retrieve tracking count with the specified parent message id. type: string required: false dateTimeDelivered: description: Retrieve tracking count with the dateTimeDelivered. type: integer required: false responses: 200: description: The number of matching trackings 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 "/{messageId}": description: Endpoint for an individual tracking. uriParameters: messageId: description: id of the message. type: string get: description: Retrieve tracking message based on messageId. headers: Accept: description: The media type for v1 trackings. example: application/vnd.com.covisint.platform.messaging.tracking.v1;fetchattributetypes=true;fetcheventtemplates=true;fetchcommandtemplates=true type: string required: true is: - getResponse - secured responses: 200: description: Successfully retrieved the requested tracking. body: application/vnd.com.covisint.platform.tracking.v1+json: schema: tracking 400: description: "There was a problem with the client's request.\n___ \nSubstatus codes and error messages are mentioned below:\n + framework:request:io:read - There was an error while reading the request body.\n + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n \ + framework:request:header:missing - Missing request header: {headerName}.\n \ + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \ \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/processorAudits": get: is: - pagableRequest - getSearchResponse - secured description: Search processorAudit based on the given filter criteria parameters. headers: Accept: description: Media type example: application/vnd.com.covisint.platform.messaging.processoraudit.v1+json type: string required: true queryParameters: routeName: description: Retrieve processorAudit messages with the specified routeName. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false eventSource: description: Retrieve processorAudit messages with the specified eventSource. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false commandId: description: Retrieve processorAudit messages with the specified command 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 routingTopic: description: Retrieve processorAudit messages with the specified routingTopic. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false workflowTopic: description: Retrieve processorAudit messages with the specified workflowTopic. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false workflowTopology: description: Retrieve processorAudit messages with the specified workflowTopology. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false connectorService: description: Retrieve processorAudit messages with the specified connectorService. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false messageId: description: Retrieve processorAudit messages with the specified message 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 destinationStreamId: description: Retrieve processorAudit messages with the specified destinationStreamId. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false destinationQueue: description: Retrieve processorAudit messages with the specified destinationQueue. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false realmId: description: Retrieve processorAudit messages with the specified realm. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false connectorState: description: Retrieve processorAudit messages with the specified connectorState. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false parentMessageId: description: Retrieve processorAudit messages with the specified parent message 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 processAuditId: description: Retrieve processorAudit messages with the specified processAuditId. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false ackId: description: Retrieve processorAudit messages with the ackId. type: string required: false ackStatus: description: Retrieve processorAudit messages with the ackStatus. type: string required: false ackErrorCode: description: Retrieve processorAudit messages with the ackErrorCode. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+messageId" - "-messageId" - "+routeName" - "-routeName" - "+parentMessageId" - "-parentMessageId" - "+processAuditId" - "-processAuditId" responses: 200: description: All processorAudit messages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.messaging.processoraudit.v1+json: schema: processorAudits 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 trackings that match the given query criteria. get: is: - taggable - getSearchResponse - secured description: Retrieve count of processorAudit messages based on specified query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: routeName: description: Retrieve processorAudit count with the specified routeName. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false eventSource: description: Retrieve processorAudit count with the specified eventSource. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false commandId: description: Retrieve processorAudit count with the specified command 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 routingTopic: description: Retrieve processorAudit count with the specified routingTopic. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false workflowTopic: description: Retrieve processorAudit count with the specified workflowTopic. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false workflowTopology: description: Retrieve processorAudit count with the specified workflowTopology. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false connectorService: description: Retrieve processorAudit count with the specified connectorService. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false messageId: description: Retrieve processorAudit count with the specified message 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 destinationStreamId: description: Retrieve processorAudit count with the specified destinationStreamId. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false destinationQueue: description: Retrieve processorAudit count with the specified destinationQueue. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false realmId: description: Retrieve processorAudit count with the specified realm. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false connectorState: description: Retrieve processorAudit count with the specified connectorState. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false parentMessageId: description: Retrieve processorAudit count with the specified parent message 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 processAuditId: description: Retrieve processorAudit count with the specified processAuditId. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false ackId: description: Retrieve processorAudit count with the ackId. type: string required: false ackStatus: description: Retrieve processorAudit count with the ackStatus. type: string required: false ackErrorCode: description: Retrieve processorAudit count with the ackErrorCode. type: string required: false responses: 200: description: The number of matching trackings 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 "/{processorAuditId}": description: Endpoint for an individual processorAudit. uriParameters: processorAuditId: description: id of the message. type: string get: description: Retrieve a specific processorAudit message by Id. headers: Accept: description: The media type for v1 processorAudit. example: application/vnd.com.covisint.platform.messaging.processorAudit.v1;fetchattributetypes=true;fetcheventtemplates=true;fetchcommandtemplates=true type: string required: true is: - getResponse - secured responses: 200: description: Successfully retrieved the requested processorAudit. body: application/vnd.com.covisint.platform.processorAudit.v1+json: schema: processorAudit 400: description: "There was a problem with the client's request.\n___ \nSubstatus codes and error messages are mentioned below:\n + framework:request:io:read - There was an error while reading the request body.\n + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n \ + framework:request:header:missing - Missing request header: {headerName}.\n \ + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \ \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema