#%RAML 0.8 title: Advanced Queueing API baseUri: https://apistg.np.covapp.io/aqs/v1 protocols: - HTTPS schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource.", "required": true }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } } - namedResourceReference: "{\n \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the basic resource reference and adds internationalized name and description.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"properties\" : {\n \"name\" : { \n \"description\": \"Internationalized resource name.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : { \n \"description\": \"Internationalized resource description.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\n }\n}\n" - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource.", "required": true }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.", "required": false }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "required": true, "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "required": true, "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "required": true, "readonly": true } } } } } - resourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/resourceV2\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resourceV2\",\n \ \"type\" : \"object\",\n \"description\" : \"A basic resource (version V2).\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.\",\n \"required\": true,\n \ \"readonly\": true\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.\",\n \"required\": true,\n \"readonly\": true\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.\",\n \ \"required\": true,\n \"readonly\": true\n }\n }\n \ }\n } \n}\n" - realmScopedResource: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the base resource and adds a realm attribute.\",\n \ \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resource#\"\n \ },\n \"properties\" : {\n \"realm\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n \ }\n }\n}\n" - realmScopedResourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResourceV2\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : {\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n }\n }\n} \n" - errorResponseSchema: "{\n \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n \"properties\" : {\n \"status\" : { \n \"type\" : \"number\",\n \"minimum\" : 400,\n \ \"maximum\" : 599,\n \"description\" : \"The HTTP status code.\",\n \ \"required\": true\n },\n \"apiMessage\" : { \n \"type\" : \"string\",\n \ \"description\" : \"A helpful, human-readable description of the error, useful for basic diagnostics.\" \n },\n \"apiStatusCode\" : {\n \"type\" : \"string\",\n \"description\" : \"The API-specific status code.\"\n }\n \ }\n}\n" - serviceCode: "{\n \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\": \"object\",\n \"description\": \"The site/service/location codes granted along with a service.\",\n \"properties\": {\n \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200, \"description\": \"The code value.\" },\n \"codeKind\": { \"type\": \"string\", \"required\": true, \"maxLength\": 36, \"description\": \"The associated business unit.\" }\n }\n} \n" - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type" : "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: "{\n \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"A container for phone number details.\",\n \"properties\" : {\n \"number\" : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\" },\n \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\" : \"The phone number type.\" }\n },\n \"required\" : [ \"type\" ]\n} \n" - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: "{\n \"id\" : \"http://api.covisint.com/schema/baseDefinitionResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\": {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n },\n \"properties\": {\n \"name\": {\n \"description\": \"The application name (internationalized).\",\n \ \"required\": true,\n \"$ref\": \"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"description\": {\n \"required\": false,\n \"description\": \"The application description (internationalized).\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }, \n \"properties\":{\n \"type\":\"array\",\n \"description\":\"Properties used by the implementation.\",\n \"required\":false,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The name of the property.\",\n \"required\": true\n },\n \ {\n \"type\": \"string\",\n \"description\": \"The value of the property.\",\n \"required\": true\n }\n \ ]\n }\n ]\n }\n }\n}\n" - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ], "required": true } } } - 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" - messages: "{\"id\":\"http://api.covisint.com/schema/messages\",\n \"$schema\":\"http://json-schema.org/draft-04/schema\",\n \"description\":\"Collection of message definitions.\",\n \"type\":\"array\",\n \"items\":{ \n \"$ref\":\"http://api.covisint.com/schema/message#\"\n }\n}\n" - message: "{ \n\"$schema\":\"http://json-schema.org/draft-04/schema#\",\n\"id\":\"http://api.covisint.com/schema/message\",\n\"type\":\"object\",\n\"description\":\"Schema representing message.\",\n\"extends\":{ \n \"$ref\":\"http://api.covisint.com/schema/realmScopedResourceV2#\"\n},\n\"properties\":{ \ \n \"messageId\": {\n \"type\": \"string\",\n \"description\": \"Unique id for this message.\",\n \"required\": false\n },\n \"deviceId\": {\n \"type\": \"string\",\n \"description\": \"Device id associated with the message.\",\n \"required\": true\n },\n \"streamId\": {\n \ \"type\": \"string\",\n \"description\": \"Stream id associated with the message.\",\n \"required\": true\n },\n \"eventControlNumber\": {\n \"type\": \"string\",\n \"description\": \"Control number generated by device.\",\n \"required\": true\n },\n \"messageType\": {\n \"description\": \"Type of message .\",\n \"enum\": [\n \ \"ACK\",\n \"COMMAND\",\n \"EVENT\"\n ],\n \ \"required\": true\n },\n \"ackTemplateId\": {\n \"type\": \"string\",\n \"description\": \"id of the device stream.\",\n \"required\": false\n },\n \"payload\": {\n \"type\": \"string\",\n \"description\": \"Workflow id for additional processing of message.\",\n \"required\": false\n },\n \"deliveryStatus\": {\n \"description\": \"Delivery status of message .\",\n \"enum\": [\n \"PENDING\",\n \"RETRY\",\n \ \"PENDING_ACK\"\n ],\n \"required\": false\n \ },\n \"ackId\": {\n \"type\": \"string\",\n \"description\": \"The acknowledgement identifier that was sent on the incoming command.\",\n \"required\": false\n },\n \"ackStartTime\": {\n \"type\": \"string\",\n \"description\": \"The epoch time that the acknowledgment id was generated.\",\n \"required\": false\n },\n \"commandTTL\": {\n \"type\": \"string\",\n \"description\": \"The epoch time to live that the Command is considered to be processed.\",\n \ \"required\": false\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. <> <> "/messages": description: Root endpoint of message. get: is: - pagableRequest - getSearchResponse - secured description: Retrieve the message by its streamId. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.aqs.v1+json type: string required: true queryParameters: streamId: description: stream identifier. type: string required: true responses: 200: description: Messages successfully retrieved for supplied streamID. body: application/vnd.com.covisint.platform.messaging.aqs.v1+json: schema: messages 400: description: "There was a problem with the client's request.\n___ \nSubstatus codes and error messages are mentioned below:\n+ framework:request\n+ framework:request:io\n+ framework:request:io:read - Invalid input. There was an error while parsing.\n+ framework:request:io:read:parsing\n+ framework:request:io:write\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:param:missing - Missing request parameter. \n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema post: description: Creates a new message. headers: Accept: description: Media type for a message. example: application/vnd.com.covisint.platform.messaging.aqs.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.messaging.aqs.v1+json type: string required: true is: - postResponse body: application/vnd.com.covisint.platform.messaging.aqs.v1+json: schema: message responses: 201: description: A new message was created successfully. body: application/vnd.com.covisint.platform.messaging.aqs.v1+json: schema: message 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 "/count": description: Endpoint for an individual message. get: description: Retrieve the message by its messageId. headers: Accept: description: Media type. example: text/plain type: string required: true is: - getResponse queryParameters: streamId: description: stream identifier. type: string required: true responses: 200: description: Message was successfully retrieved by its id. body: application/vnd.com.covisint.platform.messaging.aqs.v1+json: schema: message 400: description: "There was a problem with the client's request.\n___ \nSubstatus codes and error messages are mentioned below:\n+ framework:request\n+ framework:request:io\n+ framework:request:io:read - Invalid input. There was an error while parsing.\n+ framework:request:io:read:parsing\n+ framework:request:io:write\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:param:missing - Missing request parameter. \n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \ \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{messageId}": description: Endpoint for an individual message. uriParameters: messageId: description: Unique id of an message. type: string get: description: Retrieve the message by its messageId. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.aqs.v1+json type: string required: true is: - getResponse responses: 200: description: Message was successfully retrieved by its id. body: application/vnd.com.covisint.platform.messaging.aqs.v1+json: schema: message 400: description: "There was a problem with the client's request.\n___ \nSubstatus codes and error messages are mentioned below:\n+ framework:request\n+ framework:request:io\n+ framework:request:io:read - Invalid input. There was an error while parsing.\n+ framework:request:io:read:parsing\n+ framework:request:io:write\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:param:missing - Missing request parameter. \n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] \ \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/rollback": post: description: Increments the retry count untill it reaches maximum limit. responses: 204: description: Message sucessfully rolled back. 400: description: "There was a problem with the client's request\n ___ \n \ Substatus codes and error messages are mentioned below:\n+ framework:request:io:read - There was an error while reading the request body.\n+ framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/delivered": post: description: Deletes the message from the queue as it is successfully delivered. responses: 204: description: Deletes the message sucessfully from queue. 400: description: "There was a problem with the client's request.\n ___ \n \ Substatus codes and error messages are mentioned below:\n+ framework:request:io:read - There was an error while reading the request body.\n+ framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/failed": post: description: Deletes the message from the queue as the message delivery is failed aftermaximum retry. responses: 204: description: Deletes the message sucessfully from queue. 400: description: "There was a problem with the client's request.\n ___ \n \ Substatus codes and error messages are mentioned below:\n+ framework:request:io:read - There was an error while reading the request body.\n+ framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/pendingAck": put: description: Updates delivery status as pending acknowledgement. responses: 204: description: Updates the delivery status as pending ack. 400: description: "There was a problem with the client's request.\n ___ \n \ Substatus codes and error messages are mentioned below:\n+ framework:request:io:read - There was an error while reading the request body.\n+ framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/mailbox": get: description: Retrieve mailbox message by its messageId. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.aqs.v1+json type: string required: true is: - getResponse responses: 200: description: Message was successfully retrieved by its id. body: application/vnd.com.covisint.platform.messaging.aqs.v1+json: schema: message 400: description: "There was a problem with the client's request.\n___ \nSubstatus codes and error messages are mentioned below:\n+ framework:request\n+ framework:request:io\n+ framework:request:io:read - Invalid input. There was an error while parsing.\n+ framework:request:io:read:parsing\n+ framework:request:io:write\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:param:missing - Missing request parameter. \n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema