#%RAML 0.8 title: Datahub Tracking API baseUri: https://api.us1.covisint.com/tracking/v2 protocols: - HTTPS schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource.", "required": true }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } } - namedResourceReference: "{\n \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the basic resource reference and adds internationalized name and description.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"properties\" : {\n \"name\" : { \n \"description\": \"Internationalized resource name.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : { \n \"description\": \"Internationalized resource description.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\n }\n}\n" - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource.", "required": true }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.", "required": false }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "required": true, "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "required": true, "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "required": true, "readonly": true } } } } } - resourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/resourceV2\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resourceV2\",\n \ \"type\" : \"object\",\n \"description\" : \"A basic resource (version V2).\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.\",\n \"required\": true,\n \ \"readonly\": true\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.\",\n \"required\": true,\n \"readonly\": true\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.\",\n \ \"required\": true,\n \"readonly\": true\n }\n }\n \ }\n } \n}\n" - realmScopedResource: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the base resource and adds a realm attribute.\",\n \ \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resource#\"\n \ },\n \"properties\" : {\n \"realm\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n \ }\n }\n}\n" - realmScopedResourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResourceV2\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : {\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n }\n }\n} \n" - errorResponseSchema: "{\n \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n \"properties\" : {\n \"status\" : { \n \"type\" : \"number\",\n \"minimum\" : 400,\n \ \"maximum\" : 599,\n \"description\" : \"The HTTP status code.\",\n \ \"required\": true\n },\n \"apiMessage\" : { \n \"type\" : \"string\",\n \ \"description\" : \"A helpful, human-readable description of the error, useful for basic diagnostics.\" \n },\n \"apiStatusCode\" : {\n \"type\" : \"string\",\n \"description\" : \"The API-specific status code.\"\n }\n \ }\n}\n" - serviceCode: "{\n \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\": \"object\",\n \"description\": \"The site/service/location codes granted along with a service.\",\n \"properties\": {\n \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200, \"description\": \"The code value.\" },\n \"codeKind\": { \"type\": \"string\", \"required\": true, \"maxLength\": 36, \"description\": \"The associated business unit.\" }\n }\n} \n" - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type" : "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: "{\n \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"A container for phone number details.\",\n \"properties\" : {\n \"number\" : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\" },\n \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\" : \"The phone number type.\" }\n },\n \"required\" : [ \"type\" ]\n} \n" - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: "{\n \"id\" : \"http://api.covisint.com/schema/baseDefinitionResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\": {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n },\n \"properties\": {\n \"name\": {\n \"description\": \"The application name (internationalized).\",\n \ \"required\": true,\n \"$ref\": \"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"description\": {\n \"required\": false,\n \"description\": \"The application description (internationalized).\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }, \n \"properties\":{\n \"type\":\"array\",\n \"description\":\"Properties used by the implementation.\",\n \"required\":false,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The name of the property.\",\n \"required\": true\n },\n \ {\n \"type\": \"string\",\n \"description\": \"The value of the property.\",\n \"required\": true\n }\n \ ]\n }\n ]\n }\n }\n}\n" - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ], "required": true } } } - dataType: "{\n \"id\" : \"http://api.covisint.com/schema/dataType\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Data type enum.\",\n \"enum\":[ \n \"string\",\n \"integer\",\n \"bool\",\n \ \"decimal\"\n ]\n}\n" - attribute: "{\n \"id\" : \"http://api.covisint.com/schema/attribute\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"An attribute.\",\n \"properties\" : {\n \"oneOf\" : [\n {\n \"attributeTypeId\" : {\n \"type\" : \"string\",\n \"description\" : \"The attribute type id.\",\n \"required\" : true\n }\n },\n { \n \"attributeType\" : {\n \"description\" : \"The full attribute type definition.\",\n \"$ref\" : \"http://api.covisint.com/schema/attributeType#\" \n }\n }\n ],\n \ \"value\" : {\n \"type\" : \"any\",\n \"description\" : \"The attribute value.\",\n \"required\" : false\n }\n }\n}\n" - attributes: "{\n \"id\" : \"http://api.covisint.com/schema/attributes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"array\",\n \"description\" : \"Collection of attributes.\",\n \"items\" : { \n \"$ref\" : \"http://api.covisint.com/schema/attribute#\"\n \ }\n}\n" - expression: "{\n \"id\" : \"http://api.covisint.com/schema/expression#\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"The DSL for defining conditional expressions.\",\n \"oneOf\" : [\n {\n \"type\" : \"object\",\n \"properties\" : {\n \"any\" : {\n \"type\" : \"array\",\n \"description\" : \"An aggregate expression representing an 'any' condition.\",\n \"items\" : {\n \"$ref\" : \"http://api.covisint.com/schema/expression#\"\n }\n }\n \ }\n },\n {\n \"type\" : \"object\",\n \"properties\" : {\n \"all\" : {\n \"type\" : \"array\",\n \"description\" : \"An aggregate expression representing an 'all' condition.\",\n \"items\" : {\n \"$ref\" : \"http://api.covisint.com/schema/expression#\"\n \ }\n }\n }\n },\n {\n \"type\" : \"object\",\n \"description\" : \"A simple leaf-node expression. The format of this expression is: '(f:, v:())'. The supported expressions are: equal, notEqual, startsWith, endsWith, matches, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual. The field name can be a simple field name i.e. 'id' or hierarchical field name using dot-notation like 'resource.id' / 'resource.tag[0]' . The value corresponding to the field name provided should always be a simple data type and cannot be an array or an object.\",\n \"properties\" : {\n \"expr\" : {\n \"type\" : \"string\",\n \"required\" : \"true\"\n }\n }\n }\n ]\n}\n \n" - 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 \ \"partitionId\": {\n \"type\": \"string\",\n \"required\": false,\n \ \"description\": \"Used for storing in DB.\"\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 \"batchMessageId\": {\n \ \"type\": \"string\",\n \"required\": true,\n \"description\": \"batchMessageId belongs to the message \"\n },\n \"sourceStreamId\": {\n \ \"type\": \"string\",\n \"required\": true,\n \"description\": \"Id of source stream the message belong to\"\n },\n \"destinationStreamId\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"Id of destination 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 \"dateTimeReceived\": {\n \"type\": \"integer\",\n \ \"required\": true,\n \"description\": \"time at which event or command received\"\n },\n \"processTimeMs\": {\n \"type\": \"integer\",\n \"required\": true,\n \"description\": \"Time taken by the process\"\n },\n \"processingState\": {\n \"enum\": [\n \"PROCESSING\",\n \"FAIL\",\n \"COMPLETE\",\n \ \"PENDING_BATCH\",\n \"AWAITING_PICKUP\",\n \"UNKNOWN\"\n \ ]\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 \"destinationQueue\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"Destination Queue for the message\"\n },\n \"eventSource\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"Event source for the message\"\n },\n \"routingTopic\": {\n \"type\": \"string\",\n \ \"required\": true,\n \"description\": \"Routing Topic for the message\"\n \ },\n \"streamNames\": {\n \"description\": \"Name of the stream.\",\n \ \"required\": false,\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"deviceNames\": {\n \"description\": \"Name of the device.\",\n \ \"required\": false,\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"parentDeviceTemplateNames\": {\n \"description\": \"Name of the parent device template.\",\n \"required\": false,\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"eventTemplateNames\": {\n \"required\": false,\n \"description\": \"Name of the event \",\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"commandTemplateNames\": {\n \"required\": false,\n \"description\": \"Name of the Command\",\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"deviceSearchNames\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Device Search Names\"\n },\n \"streamSearchNames\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Stream Search Names\"\n },\n \"parentDeviceTemplateSearchNames\": {\n \ \"type\": \"string\",\n \"required\": false,\n \"description\": \"Parent Device Template search names\"\n },\n \"parentDeviceTemplateId\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Parent Device Template Id\"\n },\n \"errorBolts\": {\n \"type\": \"set\",\n \"required\": false,\n \"description\": \"Names of the bolts with the error\"\n },\n \"senderWireBlob\": {\n \"type\": \"byte array\",\n \ \"required\": false,\n \"description\": \"Encoded sender wire message\"\n \ },\n \"receiverWireBlob\": {\n \"type\": \"byte array\",\n \"required\": false,\n \"description\": \"Encoded receiver wire message\"\n },\n \"receiverFileBlob\": {\n \"type\": \"byte array\",\n \"required\": false,\n \"description\": \"Encoded receiver file message\"\n },\n \"senderFileBlob\": {\n \"type\": \"byte array\",\n \"required\": false,\n \"description\": \"Encoded sender file message\"\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 \"senderCodeId\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Sender Code Id of the trading partner.\"\n },\n \ \"senderCodeValue\": {\n \"type\": \"integer\",\n \"required\": false,\n \"description\": \"Sender Code Value of the trading partner.\"\n \ },\n \"senderCodeQualifier\": {\n \"type\": \"integer\",\n \"required\": false,\n \"description\": \"Sender Code Qualifier of the trading partner.\"\n \ },\n \"receiverCodeId\": {\n \"type\": \"integer\",\n \"required\": false,\n \"description\": \"Receiver Code Id of the trading partner.\"\n \ },\n \"receiverCodeValue\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Receiver Code Value of the trading partner.\"\n \ },\n \"receiverCodeQualifier\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Receiver Code Qualifier of the trading partner.\"\n \ },\n \"senderTradingPartnerId\": {\n \"type\": \"integer\",\n \"required\": false,\n \"description\": \"Sender Trading Partner Id of the trading partner.\"\n \ },\n \"receiverTradingPartnerId\": {\n \"type\": \"integer\",\n \"required\": false,\n \"description\": \"Receiver Trading Partner Id of the trading partner.\"\n \ },\n \"senderMessageInfo\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Sender message info of the trading partner.\"\n \ },\n \"receiverMessageInfo\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Receiver message info of the trading partner.\"\n \ },\n \"commonMessageInfo\": {\n \"type\": \"integer\",\n \"required\": false,\n \"description\": \"Common message info of the trading partner.\"\n \ },\n \"senderTradingPartnerSearchNames\": {\n \"type\": \"string\",\n \ \"required\": false,\n \"description\": \"Sender Trading Partner search names\"\n },\n \"receiverTradingPartnerSearchNames\": {\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"Receiver Trading Partner search names\"\n },\n \"senderTradingPartnerNames\": {\n \"required\": false,\n \"description\": \"Name of the event \",\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"receiverTradingPartnerNames\": {\n \"required\": false,\n \"description\": \"Name of the Command\",\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"processorAudits\": {\n \"required\": false,\n \"type\": \"array\",\n \"description\": \"The list of processor audits associated to the tracking.\",\n \"minItems\": 1,\n \"items\": [\n {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"name of the processor audit\",\n \"required\": true\n },\n \t\t\t\t\"startTime\": {\n \"type\": \"integer\",\n \"description\": \"start time of the processor audit\",\n \"required\": false\n },\n \"processTimeMs\": {\n \"type\": \"integer\",\n \"description\": \"Time taken by the processor audit\",\n \"required\": false\n },\n \"exceptionTime\": {\n \"type\": \"integer\",\n \"description\": \"Time taken by the exception in processor audit\",\n \"required\": false\n },\n \ \"customMessage\": {\n \"type\": \"string\",\n \"description\": \"custom messgae of the processor audit\",\n \"required\": false\n \ },\n \"extendedData\": {\n \"type\": \"string\",\n \ \"description\": \"Extended Data of the processor audit\",\n \"required\": false\n },\n \"exceptionType\": {\n \"type\": \"string\",\n \ \"description\": \"exception type of the processor audit\",\n \"required\": false\n },\n \"throwTrace\": {\n \"type\": \"string\",\n \ \"description\": \"Throw trace of the processor audit\",\n \"required\": false\n },\n \"nestedTrace\": {\n \"type\": \"string\",\n \ \"description\": \"nested trace of the processor audit\",\n \"required\": false\n },\n \"exceptionIn\": {\n \"type\": \"string\",\n \ \"description\": \"exception message of the processor audit\",\n \"required\": false\n },\n \"messageFailure\": {\n \"type\": \"string\",\n \ \"description\": \"Message Failure message of the processor audit\",\n \ \"required\": false\n },\n \"processingState\": {\n \"enum\": [\n \"PROCESSING\",\n \"FAIL\",\n \ \"COMPLETE\",\n \"PENDING_BATCH\",\n \"AWAITING_PICKUP\",\n \ \"UNKNOWN\"\n ],\n \"required\": true,\n \"description\": \"Status of connector either Complete or fail\"\n }\n }\n ]\n \ },\n \"processorAudits\": {\n \"required\": false,\n \"type\": \"array\",\n \"description\": \"The list of audit infos associated to the tracking.\",\n \"minItems\": 1,\n \"items\": [\n {\n \"processorName\": {\n \"type\": \"string\",\n \"description\": \"name of the audit info\",\n \"required\": true\n },\n \"text\": {\n \"type\": \"integer\",\n \"description\": \"Message in audit Info\",\n \"required\": false\n },\n \"dateTime\": {\n \"type\": \"integer\",\n \"description\": \"Time of the audit info\",\n \"required\": false\n }\n }\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\",\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\",\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 \"relationType\": {\n \"description\": \"The Type of message relation with tracking\",\n \"enum\": [\n \"MESSAGE\",\n \ \"ACK\",\n \"COMPOUND\"\n ],\n \"required\": false\n \ },\n \"streamType\": {\n \"description\": \"The Type of sourceStream\",\n \ \"enum\": [\n \"DEVICE\",\n \"APPLICATION\",\n \"MESSAGING\",\n \ \"SYNC\"\n ],\n \"required\": false\n },\n \"destinationStreams\": {\n \"required\": false,\n \"type\": \"array\",\n \"description\": \"The list of destination streams.\",\n \"minItems\": 1,\n \"items\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the Stream.\",\n \"required\": true,\n \"$ref\": \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"streamId\": {\n \"type\": \"string\",\n \ \"required\": true,\n \"description\": \"id of the destination stream\"\n },\n \"realm\": {\n \"type\": \"string\",\n \"required\": true,\n \"description\": \"realm of the destination stream\"\n }\n }\n }\n ]\n \ },\n \"receiveFileAttributes\": {\n \"required\": false,\n \"type\": \"array\",\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 }\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 do not require any authentication. headers: SolutionInstanceId: description: The solution instance id. example: abcd123e-0109-441c-8a20-123a456b789c 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": description: Collection endpoint for tracking resources. 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.messagetracker.v1+json;fetchall=true;fetchpayload=true;fetchprocessoraudits=true;fetchauditinfos=true type: string required: true queryParameters: 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 batchMessageId: description: Retrieve tracking messages with the specified batch 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 destinationStreamId: description: Retrieve tracking 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 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 sourceStreamId: description: Retrieve tracking messages with the specified sourceStreamId. Case-insensitive, wildcard and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false sourceType: description: Retrieve tracking messages with the specified sourceType. 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 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 destinationStreamNames: description: Retrieve tracking messages with the destinationStreamNames. type: string required: false eventTemplateNames: description: Retrieve tracking messages with the eventTemplateNames. type: string required: false commandTemplateNames: description: Retrieve tracking messages with the commandTemplateNames. type: string required: false deviceNames: description: Retrieve tracking messages with the deviceNames. type: string required: false streamNames: description: Retrieve tracking messages with the sourceStreamNames. type: string required: false parentDeviceTemplateNames: description: Retrieve tracking messages with the parentDeviceTemplateNames. type: string required: false parentDeviceTemplateId: description: Retrieve tracking messages with the parentDeviceTemplateId. type: string required: false errorBolts: description: Retrieve tracking messages with the errorBolts. type: string required: false senderTradingPartnerNames: description: Retrieve tracking messages with the senderTradingPartnerNames. type: string required: false receiverTradingPartnerNames: description: Retrieve tracking messages with the receiverTradingPartnerNames. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+dateTimeReceived" - "-dateTimeReceived" 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.messagetracker.v1+json: schema: trackings 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+jsonschema: 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 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 sourceStreamId: 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 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: text/plain: 400: description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] 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;fetchall=true;fetchpayload=true;fetchprocessoraudits=true;fetchauditinfos=true type: string required: true is: - getResponse - secured responses: 200: description: Successfully retrieved the requested tracking. body: application/vnd.com.covisint.platform.messagetracker.v1+json: schema: tracking 400: description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName}. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] 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