#%RAML 0.8 title: Notification Template API baseUri: https://api.us1.covisint.com/notification/v1 protocols: - HTTPS schemas: - notificationTemplateRequest: "{\n \"id\" : \"http://api.covisint.com/schema/notificationTemplateRequest\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing a notification template.\",\n \"properties\" : {\n \"name\" : {\n \"description\": \"The name of the notification template.\",\n \ \"required\": true,\n \"type\":\"string\",\n \"maxLength\" : 100\n \ },\n \"targetedAudienceType\" : {\n \"description\": \"The type of targeted audience.\",\n \"required\": true,\n \"enum\":[\"ADMIN\",\"USER\"]\n \ },\n \"shortText\" : {\n \"description\": \"Internationalized short text for template. Language code must be a valid ISO language code.\",\n \"required\": true,\n \"type\": \"array\",\n \"minItems\": 1,\n \"properties\": {\n \"items\": {\n \"type\": \"object\",\n \"lang\": { \"type\": \"string\", \"maxLength\": 10, \"description\": \"The language or locale in which the text is written.\" },\n \"text\": { \"type\": \"string\", \"maxLength\": 255, \"description\": \"The internationalized text value.\" }\n \ }\n }\n },\n \"oneOf\": [\n {\n \"properties\":{\n \ \"type\": { \n \"description\": \"Describes the type of notification template.\",\n \"type\": \"string\",\n \"enum\": [\"EMAIL\"]\n \ },\n \"fullText\" : {\n \"description\": \"Internationalized full text for template. Language code must be a valid ISO language code. Full text is a required field when type is EMAIL\",\n \"type\": \"array\",\n \ \"minItems\": 1,\n \"properties\": {\n \"items\": {\n \"type\": \"object\",\n \"lang\": { \"type\": \"string\", \"maxLength\": 10, \"description\": \"The language or locale in which the text is written.\" },\n \"text\": { \"type\": \"string\", \"maxLength\": 4000, \"description\": \"The internationalized text value.\" }\n }\n \ }\n }\n },\n \"required\": [\"type\",\"fullText\"]\n \ },\n {\n \"properties\":{\n \"type\": { \n \"description\": \"Describes the type of notification template.\",\n \"type\": \"string\",\n \ \"enum\": [\"SMS\"]\n }\n },\n \"required\": [\"type\"]\n }\n ]\n }\n}\n" - notificationTemplateResponse: "{\n \"id\" : \"http://api.covisint.com/schema/notificationTemplateResponse\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing a notification template.\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \ \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \ \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \ \"required\": true\n },\n \"creation\" : {\n \"type\" : \"number\",\n \ \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \"required\": true \n },\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This is mandatory if x-realm header is NOT available\",\n \ \"required\": false\n },\n \"name\" : {\n \"description\": \"The name of the notification template.\",\n \"required\": true,\n \"type\":\"string\",\n \ \"maxLength\" : 100\n },\n \"targetedAudienceType\" : {\n \"description\": \"The type of targeted audience.\",\n \"required\": true,\n \"enum\":[\"ADMIN\",\"USER\"]\n \ },\n \"shortText\" : {\n \"description\": \"Internationalized short text for template. Language code must be a valid ISO language code.\",\n \"required\": true,\n \"type\": \"array\",\n \"minItems\": 1,\n \"properties\": {\n \"items\": {\n \"type\": \"object\",\n \"lang\": { \"type\": \"string\", \"maxLength\": 10, \"description\": \"The language or locale in which the text is written.\" },\n \"text\": { \"type\": \"string\", \"maxLength\": 255, \"description\": \"The internationalized text value.\" }\n \ }\n }\n },\n \"oneOf\": [\n {\n \"properties\":{\n \ \"type\": { \n \"description\": \"Describes the type of notification template.\",\n \"type\": \"string\",\n \"enum\": [\"EMAIL\"]\n \ },\n \"fullText\" : {\n \"description\": \"Internationalized full text for template. Language code must be a valid ISO language code. Full text is a required field when type is EMAIL\",\n \"type\": \"array\",\n \ \"minItems\": 1,\n \"properties\": {\n \"items\": {\n \"type\": \"object\",\n \"lang\": { \"type\": \"string\", \"maxLength\": 10, \"description\": \"The language or locale in which the text is written.\" },\n \"text\": { \"type\": \"string\", \"maxLength\": 4000, \"description\": \"The internationalized text value.\" }\n }\n \ }\n }\n },\n \"required\": [\"type\",\"fullText\"]\n \ },\n {\n \"properties\":{\n \"type\": { \n \"description\": \"Describes the type of notification template.\",\n \"type\": \"string\",\n \ \"enum\": [\"SMS\"]\n }\n },\n \"required\": [\"type\"]\n }\n ]\n }\n}\n" - notificationTemplateResponses: "{\n \"id\" : \"http://api.covisint.com/schema/notificationTemplateResponses\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of emais\",\n \"type\" : \"array\",\n \"items\" : { \n \"items\" : { \n \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \ \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \ \"creator\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \ \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \ \"required\": true\n },\n \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \ \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \"required\": true \n },\n \"realm\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \ \"description\" : \"The realm in which this resource is being created. This is mandatory if x-realm header is NOT available\",\n \"required\": false\n },\n \"name\" : {\n \"description\": \"The name of the notification template.\",\n \"required\": true,\n \"type\":\"string\",\n \ \"maxLength\" : 100\n },\n \"targetedAudienceType\" : {\n \"description\": \"The type of targeted audience.\",\n \"required\": true,\n \"enum\":[\"ADMIN\",\"USER\"]\n \ },\n \"shortText\" : {\n \"description\": \"Internationalized short text for template. Language code must be a valid ISO language code.\",\n \ \"required\": true,\n \"type\": \"array\",\n \"minItems\": 1,\n \"properties\": {\n \"items\": {\n \"type\": \"object\",\n \"lang\": { \"type\": \"string\", \"maxLength\": 10, \"description\": \"The language or locale in which the text is written.\" },\n \ \"text\": { \"type\": \"string\", \"maxLength\": 255, \"description\": \"The internationalized text value.\" }\n }\n }\n },\n \ \"oneOf\": [\n {\n \"properties\":{\n \"type\": { \n \"description\": \"Describes the type of notification template.\",\n \ \"type\": \"string\",\n \"enum\": [\"EMAIL\"]\n \ },\n \"fullText\" : {\n \"description\": \"Internationalized full text for template. Language code must be a valid ISO language code. Full text is a required field when type is EMAIL\",\n \"type\": \"array\",\n \"minItems\": 1,\n \"properties\": {\n \"items\": {\n \"type\": \"object\",\n \ \"lang\": { \"type\": \"string\", \"maxLength\": 10, \"description\": \"The language or locale in which the text is written.\" },\n \"text\": { \"type\": \"string\", \"maxLength\": 4000, \"description\": \"The internationalized text value.\" }\n }\n }\n }\n },\n \ \"required\": [\"type\",\"fullText\"]\n },\n {\n \"properties\":{\n \ \"type\": { \n \"description\": \"Describes the type of notification template.\",\n \"type\": \"string\",\n \"enum\": [\"SMS\"]\n }\n },\n \"required\": [\"type\"]\n \ }\n ]\n }\n }\n}\n" - event: "{\n \"id\" : \"http://api.covisint.com/schema/event\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"Schema representing an event.\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \ \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \ \"required\": true\n },\n \"creation\" : {\n \"type\" : \"number\",\n \ \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \"required\": true \n },\n \ \"name\" : {\n \"description\": \"The name of the notification template.\",\n \ \"required\": true,\n \"type\":\"string\",\n \"maxLength\" : 100\n \ }\n }\n}\n" - events: "{\n \"id\" : \"http://api.covisint.com/schema/events\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of events\",\n \"type\" : \"array\",\n \"items\" : { \n \"name\" : {\n \"description\": \"The name of the notification template.\",\n \"required\": true,\n \"type\":\"string\",\n \ \"maxLength\" : 100\n }\n }\n}\n" - eventAssociationRequest: "{\n \"id\" : \"http://api.covisint.com/schema/eventAssociationRequest\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing the details of the association of notification template for the event.\",\n\n \"properties\" : {\n \"eventId\" : {\n \"description\": \"The Unique Id for an event.\",\n \"required\": true,\n \"type\":\"string\",\n \ \"maxLength\" : 100\n },\n \"notificationTemplate\": {\n \"description\": \"Reference to the notification template.\",\n \"type\": \"object\",\n \"properties\":{\n \ \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 36,\n \"description\" : \"The unique identifier for the resource.\",\n \ \"required\": true\n },\n \"type\" : {\n \"type\" : \"string\",\n \"description\" : \"The type of the resource.\"\n },\n \ \"realm\" : {\n \"type\" : \"string\",\n \"description\" : \"The realm of the resource.\"\n }\n },\n \"required\": true\n \ },\n \"enabled\": { \n \"description\": \"Set this to true if the notification template is active\",\n \"type\": \"boolean\",\n \"default\":true,\n \ \"required\":false\n }\n }\n}\n" - eventAssociationResponse: "{\n \"id\" : \"http://api.covisint.com/schema/eventAssociationResponse\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing the details of the association of notification template for the event.\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \ \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \ \"required\": true\n },\n \"creation\" : {\n \"type\" : \"number\",\n \ \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \"required\": true \n },\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This is mandatory if x-realm header is NOT available\",\n \ \"required\": true\n },\n \"eventId\" : {\n \"description\": \"The Unique Id for an event.\",\n \"required\": true,\n \"type\":\"string\",\n \ \"maxLength\" : 100\n },\n \"notificationTemplate\": {\n \"description\": \"Reference to the notification template.\",\n \"type\": \"object\",\n \"properties\":{\n \ \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 36,\n \"description\" : \"The unique identifier for the resource.\",\n \ \"required\": true\n },\n \"type\" : {\n \"type\" : \"string\",\n \"description\" : \"The type of the resource.\"\n },\n \ \"realm\" : {\n \"type\" : \"string\",\n \"description\" : \"The realm of the resource.\"\n }\n },\n \"required\": true\n \ },\n \"enabled\": { \n \"description\": \"Set this to true if the notification template is active\",\n \"type\": \"boolean\",\n \"default\":true,\n \ \"required\":false\n }\n }\n}\n" - eventAssociationResponses: "{\n \"id\" : \"http://api.covisint.com/schema/eventAssociationResponses\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of event notification templates\",\n \"type\" : \"array\",\n \"items\" : { \n \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \ \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \ \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \ \"required\": true\n },\n \"creation\" : {\n \"type\" : \"number\",\n \ \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \"required\": true \n },\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This is mandatory if x-realm header is NOT available\",\n \ \"required\": true\n },\n \"eventId\" : {\n \"description\": \"The Unique Id for an event.\",\n \"required\": true,\n \"type\":\"string\",\n \ \"maxLength\" : 100\n },\n \"notificationTemplate\": {\n \"description\": \"Reference to the notification template.\",\n \"type\": \"object\",\n \"properties\":{\n \ \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 36,\n \"description\" : \"The unique identifier for the resource.\",\n \ \"required\": true\n },\n \"type\" : {\n \"type\" : \"string\",\n \"description\" : \"The type of the resource.\"\n },\n \ \"realm\" : {\n \"type\" : \"string\",\n \"description\" : \"The realm of the resource.\"\n }\n },\n \"required\": true\n \ },\n \"enabled\": { \n \"description\": \"Set this to true if the notification template is active\",\n \"type\": \"boolean\",\n \"default\":true,\n \ \"required\":false\n }\n }\n}\n" traits: - secured: usage: Apply this to any method that needs to be secured description: Requests requires authentication using a bearer token. headers: Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk required: true responses: 401: description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 403: description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getResponse: responses: 404: &3 description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 406: &1 description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: &2 description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getSearchResponse: responses: 406: *1 500: *2 - postResponse: responses: 406: *1 415: &4 description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: *2 - deleteResponse: responses: 500: *2 - putResponse: responses: 404: *3 406: *1 409: &5 description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 415: *4 500: *2 - putCreateResponse: responses: 406: *1 409: *5 415: *4 500: *2 - pagableRequest: queryParameters: page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false minimum: 1 default: 50 maximum: 200 "/notification/templates": is: - secured description: Collection endpoint for notification template. get: is: - getSearchResponse - pagableRequest description: Search notification templates . headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.notificationtemplate.v1+json; type: string required: true queryParameters: name: description: Retrieve notification templates with the specified names.The search is case-insensitve. Multiple parameters are supported and the search results will be a union. type: string required: false type: description: Retrieve notification templates with the specified types. The search is case-insensitve. Multiple parameters are supported and the search results will be a union. type: string required: false enum: - SMS - EMAIL responses: 200: description: All notification templates were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.notificationtemplate.v1+json: schema: notificationTemplateResponses 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)} + 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 post: is: - postResponse description: Creates a new notification template. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.notificationtemplate.v1+json type: string required: true body: application/vnd.com.covisint.platform.notificationtemplate.v1+json: schema: notificationTemplateRequest responses: 201: description: A new notification template was created. body: application/vnd.com.covisint.platform.notificationtemplate.v1+json: schema: notificationTemplateResponse 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)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(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 "/{id}": description: Endpoint for a notification template. uriParameters: id: description: The unique notification template identifier. type: string maxLength: 36 required: true is: - secured get: is: - getResponse description: Returns a notification template by its unique identifier. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.notificationtemplate.v1+json type: string required: true responses: 200: description: The notification template was successfully retrieved. body: application/vnd.com.covisint.platform.notificationtemplate.v1+json: schema: notificationTemplateResponse 400: description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\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 put: is: - putResponse description: Updates an existing notification template. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.notificationtemplate.v1+json type: string required: true body: application/vnd.com.covisint.platform.notificationtemplate.v1+json: schema: notificationTemplateResponse responses: 200: description: The notification template was successfully updated. body: application/vnd.com.covisint.platform.notificationtemplate.v1+json: schema: notificationTemplateResponse 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)} + 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 delete: is: - deleteResponse description: Deletes a notification template. headers: responses: 204: description: The notification template was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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 404: description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/notification/events": is: - secured description: Collection endpoint for events. get: is: - getSearchResponse - pagableRequest description: Search events . headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.event.v1+json; type: string required: true queryParameters: name: description: Retrieve events with the specified names. The search is case-insensitve. Multiple parameters are supported and the search results will be a union. type: string required: false responses: 200: description: All events are successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.event.v1+json: schema: events 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)} + 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 "/{id}": description: Endpoint for a event. uriParameters: is: - secured get: is: - getResponse description: Returns an event by its unique identifier. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.event.v1+json type: string required: true responses: 200: description: The event was successfully retrieved. body: application/vnd.com.covisint.platform.event.v1+json: schema: event 400: description: "There was a problem with the clienet's request\n___\nSubstatus codes are mentioned below:\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 "/notification/events/association": is: - secured description: Collection endpoint for event notification template association. get: is: - getSearchResponse - pagableRequest description: Search event notification template associations based on the given filter parameters. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.eventassociation.v1+json type: string required: true queryParameters: eventId: description: Retrieve only event notification template association with the event id. Multiple parameters are supported and the search results will be a union. type: string required: false responses: 200: description: All event notification template associations that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.eventassociation.v1+json: schema: eventAssociationResponses 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: {queryParameterName}\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 post: is: - postResponse description: Creates a new event notification template association. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.eventassociation.v1+json type: string required: true body: application/vnd.com.covisint.platform.eventassociation.v1+json: schema: eventAssociationRequest responses: 201: description: A new event notification template association was created. body: application/vnd.com.covisint.platform.eventassociation.v1+json: schema: eventAssociationResponse 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)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + event.association.event.missing - The event does not exists for the id {eventId} + event.association.notificationTemplate.missing - The notification template does not exists for the id {notificationTemplateId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{eventAssociationId}": description: Endpoint for an event notification template association. uriParameters: eventAssociationId: description: Unique identifier for the event notification template association. type: string required: true is: - secured get: is: - getResponse description: Returns an event notification template association by its unique identifier. headers: Accept: description: Media type. Setting includeProperties media type attribute to true inlines the event notification template's additional properties in the representation. example: application/vnd.com.covisint.platform.eventassociation.v1+json;includeProperties=true type: string required: true responses: 200: description: The event notification template association was successfully retrieved. body: application/vnd.com.covisint.platform.eventassociation.v1+json: schema: eventAssociationResponse 400: description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\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 put: is: - putResponse description: Updates an existing event notification template association. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.eventassociation.v1+json type: string required: true body: application/vnd.com.covisint.platform.eventAssociation.v1+json: schema: eventAssociationResponse responses: 200: description: The event notification template associations was successfully updated. body: application/vnd.com.covisint.platform.eventassociation.v1+json: schema: eventAssociationResponse 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)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + event.association.event.missing - The event does not exists for the id {eventId} + event.association.notificationTemplate.missing - The notification template does not exists for the id {notificationTemplateId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Deletes an event notification template association. headers: responses: 204: description: The event notification template association was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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 404: description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema