#%RAML 0.8 title: Analytics Definition API baseUri: https://apistg.np.covapp.io/analyticsdefinition/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 } } } - analyticsDefinitions: "{\"id\":\"http://api.covisint.com/schema/analyticsDefinitions\",\n \"$schema\":\"http://json-schema.org/draft-04/schema\",\n \"description\":\"Collection of analytics definitions.\",\n \"type\":\"array\",\n \"items\":{ \n \"$ref\":\"http://api.covisint.com/schema/analyticsDefinition#\"\n }\n}\n" - analyticsDefinition: "{ \n\"$schema\":\"http://json-schema.org/draft-04/schema#\",\n\"id\":\"http://api.covisint.com/schema/analyticsDefinition\",\n\"type\":\"object\",\n\"description\":\"Schema representing analyticsDefinition.\",\n\"extends\":{ \n \"$ref\":\"http://api.covisint.com/schema/realmScopedResourceV2#\"\n},\n\"properties\":{ \ \n \"name\":{ \n \"description\":\"Name of the analytics definition.\",\n \ \"required\":true,\n \"$ref\":\"http://api.covisint.com/idm/schema/internationalString#\"\n },\n \"description\":{ \n \"description\":\"Description of the analytics definition.\",\n \ \"required\":false,\n \"$ref\":\"http://api.covisint.com/idm/schema/internationalString#\"\n },\n \"timeWindow\":{ \n \"description\":\"Time Window for which statistics/frequency will be calculated.\",\n \"enum\":[ \n \"1 Minute\",\n \"2 Minutes\",\n \ \"5 Minutes\",\t\t\t\n \"15 Minutes\", \t\t\t\n \"30 Minutes\",\n \"45 Minutes\",\t\t\t\n \"60 Minutes\",\n \"1440 Minutes\",\n \"10080 Minutes\"\n ],\n \"required\":true\n },\n \"analyticsTypeMetaInformation\":{ \ \n \"type\":\"object\",\n \"description\":\"Set of analyticsType groupby on which analytics need to be performed.\",\n \"properties\":{\n \"type\":\"array\",\n \ \"description\":\"Represents values on which AnalyticsAggregation model will be calculated.\",\n \"minItems\":0,\n \"items\":{ \n \"$ref\":\"http://api.covisint.com/schema/analyticsType#\"\n \ } \n }\n },\n \"target\":{ \n \"type\":\"object\",\n \ \"description\":\"Represents set of values for which statistics/frequency need to be calculated.\",\n \"properties\":{ \n \"operations\":{ \n \ \"type\":\"string\",\n \"enum\":[ \n \"STATISTICS\",\n \ \"FREQUENCY\"\n ],\n \"description\":\"Represents the operation to be performed by analytics engine\",\n \"required\":true\n \ },\n \"type\":{ \n \"type\":\"string\",\n \"enum\":[ \ \n \"EVENT_ATTRIBUTE_ID\"\n ],\n \"description\":\"Represents type category for target calculation.\",\n \"required\":true\n },\n \ \"name\":{ \n \"type\":\"string\",\n \"description\":\"User defined name, which will appear on AnalyticsAggregation report.\",\n \"required\":true\n \ },\n \"id\":{ \n \"type\":\"string\",\n \"required\":true,\n \ \"description\":\"Represents value to be used for calculation corresponding to category mentioned by type.\"\n },\n \"where\":{ \n \"type\":\"object\",\n \ \"description\":\"Label represent where clause for value match\",\n \ \"properties\":{ \n \"value\":{ \n \"type\":\"string\",\n \ \"description\":\"represents value use for where clause filtering.\",\n \ \"required\":false\n }\n },\n \"required\":false\n \ }\n },\n \"required\":true\n },\n \"output\":{ \n \"type\":\"object\",\n \ \"description\":\"Represents where and how the analytics aggregation output for this definition will be routed.\",\n \"properties\":{ \n \"streamId\":{ \ \n \"type\":\"string\",\n \"description\":\"UUID corresponding to source stream Id through which the streaming will happen.\",\n \"required\":true\n \ },\n \"senderCodeId\":{ \n \"type\":\"string\",\n \"description\":\"UUID corresponding to senderCodeId trading partner sending the analytics aggregation output to the trading partner represented by receiverCodeId.\",\n \"required\":true\n \ },\n \"receiverCodeId\":{ \n \"type\":\"string\",\n \"description\":\"UUID corresponding to receiverCodeId trading partner receiving the analytics aggregation output from the trading partner represented by senderCodeId.\",\n \"required\":true\n \ },\n \"documentInfoId\":{ \n \"type\":\"string\",\n \"required\":true,\n \ \"description\":\"UUID corresponding to documentInfoId which represents document information in format supportedDocType:supportedDocTemplateType:docTemplateVersion.\"\n \ }\n },\n \"required\":false\n },\n \"isActive\":{ \n \"type\":\"boolean\", \ \n \"description\":\"The status of the analytic definition. If inactive analytics will not be performed.\",\n \"required\":true\n }\n }\n}\n \n" - analyticsType: "{ \n\"$schema\":\"http://json-schema.org/draft-04/schema#\",\n\"id\":\"http://api.covisint.com/schema/analyticsType\",\n\"type\":\"object\",\n\"description\":\"Schema representing analyticsType to represent the value on which we want to do analytics.\",\n\"properties\":{ \ \n \"type\":{ \n \"enum\":[ \n \"SOURCE_STREAM_ID\",\n \"DESTINATION_STREAM_ID\",\t\t\t\n \ \"DEVICE_ID\",\n \"DEVICE_ATTRIBUTE_ID\",\n \"EVENT_ATTRIBUTE_ID\",\n \ \"DEVICE_TEMPLATE_ID\",\n \"EVENT_TEMPLATE_ID\"\t\t\t\n ],\n \"description\":\"represents category of data for analytics calculation.\",\n \"required\":true\n },\n \"name\":{ \n \"type\":\"string\",\n \"description\":\"User defined name, which to appear in aggregation report.\",\n \"required\":true\n },\n \"id\":{ \ \n \"type\":\"string\",\n \"required\":true,\t\t \n \"description\":\"represents value to be used for calculation corresponding to category mentioned by type.\"\n },\n \"where\":{ \n \"type\":\"object\",\n \"description\":\"Label represent where clause for value match\",\n \"properties\":{ \n \"value\":{ \n \ \"type\":\"string\",\n \"description\":\"represents value use for where clause filtering.In case of STREAM_ID,DEVICE_TEMPLATE_ID and DEVICE_ID \ {id and where clause value should be same.}\",\n \"required\":false\n \ }\n },\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 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. <> <> "/analyticsDefinitions": description: Collection endpoint for analyticsDefinitions. get: is: - sortable - getSearchResponse - secured description: List of available analyticsDefinitions. headers: Accept: description: Media type for a analytics definitions. example: application/vnd.com.covisint.platform.analyticsDefinition.v1+json type: string required: true queryParameters: timeWindow: description: Filter analyticsDefinitions by timeWindow. type: string required: false active: description: Filter analyticsDefinitions by active status. type: string required: false name: description: Filter analyticsDefinitions by definition name. type: string required: false description: description: Filter analyticsDefinitions by definition description. type: string required: false target.analyticsType.type: description: Filter analyticsDefinition by target analytics type value. type: string required: false target.analyticsType.name: description: Filter analyticsDefinitions by target analytics name. type: string required: false target.analyticsType.id: description: Filter analyticsDefinitions by target analytics id. type: string required: false target.analyticsOperation: description: Filter analyticsDefinitions by target analytics operation. type: string required: false output.streamId: description: Filter analyticsDefinitions by output source stream UUID. type: string required: false output.senderCodeId: description: Filter analyticsDefinitions by output senderCodeId. type: string required: false output.receiverCodeId: description: Filter analyticsDefinitions by output receiverCodeId. type: string required: false output.documentInfoId: description: Filter analyticsDefinitions by output documentInfoId. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+creation" - "-creation" responses: 200: description: Matching AnalyticsDefinition were retrieved successfully. body: application/vnd.com.covisint.platform.analyticsDefinition.v1+json: schema: analyticsDefinitions 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:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + securityquestions.multiple.owner.id.invalid - Muliple owner ids {ownerId(s)} are not allowed + securityquestions.multiple.owner.type.invalid - Muliple owner types {ownerId(s)} are not allowed + securityquestions.owner.id.invalid - Owner id {ownerId} invalid if owner type is not mentioned + securityquestions.owner.type.invalid - Owner type {ownerType} invalid if owner id is not mentioned + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema post: description: Creates a new analyticsDefinition. headers: Accept: description: Media type for a analyticsDefinition. example: application/vnd.com.covisint.platform.analyticsDefinition.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.analyticsDefinition.v1+json type: string required: true is: - postResponse - secured body: application/vnd.com.covisint.platform.analyticsDefinition.v1+json: schema: analyticsDefinition responses: 201: description: A new analyticsDefinition was created successfully. body: application/vnd.com.covisint.platform.analyticsDefinition.v1+json: schema: analyticsDefinition 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 "/{analyticsDefId}": description: Endpoint for an individual analyticsDefinition. uriParameters: analyticsDefId: description: Unique id of an analyticsDefinition. type: string get: description: Retrieve the analyticsDefinition by its analyticsDefId. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.analyticsDefinition.v1+json type: string required: true is: - getResponse - secured responses: 200: description: AnalyticsDefinition was successfully retrieved by its id. body: application/vnd.com.covisint.platform.analyticsDefinition.v1+json: schema: analyticsDefinition 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 put: description: Updates an existing analyticsDefinition. Throws an error if {analyticsDefId} does not already exist. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.analyticsDefinition.v1+json type: string required: true Content-Type: description: The Content type example: application/vnd.com.covisint.platform.analyticsDefinition.v1+json type: string required: true is: - putResponseV2 - secured body: application/vnd.com.covisint.platform.analyticsDefinition.v1+json: schema: analyticsDefinition responses: 200: description: Successfully updated the requested analyticsDefinition. body: application/vnd.com.covisint.platform.analyticsDefinition.v1+json: schema: analyticsDefinition 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 delete: description: Delete an existing analyticsDefinition. Throws an error if {analyticsDefId} does not already exist. headers: is: - secured responses: 204: description: Successfully deleted the analyticsDefinition. 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 404: description: | The requested analyticsDefiniton was not found. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | There was an unhandled server-side error. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/activate": post: description: Activates the existing analyticsDefinition and send to AnalyticsDefinition Kafka topic. headers: is: - secured queryParameters: analyticsDefId: description: id to activate. responses: 204: description: AnalyticsDefinition sucessfully activated. 404: description: The AnalyticsDefinition did not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 400: description: "There was a problem with the client's request\n ___ \n \ Substatus codes and error messages are mentioned below:\n+ framework:request:io:read - There was an error while reading the request body.\n+ framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body.\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/deactivate": post: description: Deactivates the existing analyticsDefinition and send to AnalyticsDefinition Kafka topic. headers: is: - secured queryParameters: analyticsDefId: description: AnalyticsDefinition id to deactivate. responses: 204: description: AnalyticsDefinition sucessfully deactivated. 404: description: The AnalyticsDefinition did not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 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 "/count": description: Endpoint to return the count of analytics definition that match the given query criteria. get: is: - taggable - getSearchResponse - secured description: Retrieve count of analytics definitions based on the specified query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: timeWindow: description: Filter analyticsDefinitions by timeWindow. type: string required: false active: description: Filter analyticsDefinitions by active status. type: string required: false name: description: Filter analyticsDefinitions by definition name. type: string required: false description: description: Filter analyticsDefinitions by definition description. type: string required: false target.analyticsType.type: description: Filter analyticsDefinition by target analytics type value. type: string required: false target.analyticsType.name: description: Filter analyticsDefinitions by target analytics name. type: string required: false target.analyticsType.id: description: Filter analyticsDefinitions by target analytics id. type: string required: false target.analyticsOperation: description: Filter analyticsDefinitions by target analytics operation. type: string required: false output.streamId: description: Filter analyticsDefinitions by output source stream UUID. type: string required: false output.senderCodeId: description: Filter analyticsDefinitions by output senderCodeId. type: string required: false output.receiverCodeId: description: Filter analyticsDefinitions by output receiverCodeId. type: string required: false output.documentInfoId: description: Filter analyticsDefinitions by output documentInfoId. type: string required: false responses: 200: description: The number of matching analytics definitions were returned. body: text/plain: 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