#%RAML 0.8 title: Rule Definition API baseUri: https://api.us1.covisint.com/ruledefinition/v1 protocols: - HTTPS schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource.", "required": true }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } } - namedResourceReference: "{\n \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the basic resource reference and adds internationalized name and description.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"properties\" : {\n \"name\" : { \n \"description\": \"Internationalized resource name.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : { \n \"description\": \"Internationalized resource description.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\n }\n}\n" - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource.", "required": true }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.", "required": false }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "required": true, "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "required": true, "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "required": true, "readonly": true } } } } } - resourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/resourceV2\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resourceV2\",\n \ \"type\" : \"object\",\n \"description\" : \"A basic resource (version V2).\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.\",\n \"required\": true,\n \ \"readonly\": true\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.\",\n \"required\": true,\n \"readonly\": true\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.\",\n \ \"required\": true,\n \"readonly\": true\n }\n }\n \ }\n } \n}\n" - realmScopedResource: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the base resource and adds a realm attribute.\",\n \ \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resource#\"\n \ },\n \"properties\" : {\n \"realm\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n \ }\n }\n}\n" - realmScopedResourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResourceV2\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : {\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n }\n }\n} \n" - errorResponseSchema: "{\n \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n \"properties\" : {\n \"status\" : { \n \"type\" : \"number\",\n \"minimum\" : 400,\n \ \"maximum\" : 599,\n \"description\" : \"The HTTP status code.\",\n \ \"required\": true\n },\n \"apiMessage\" : { \n \"type\" : \"string\",\n \ \"description\" : \"A helpful, human-readable description of the error, useful for basic diagnostics.\" \n },\n \"apiStatusCode\" : {\n \"type\" : \"string\",\n \"description\" : \"The API-specific status code.\"\n }\n \ }\n}\n" - serviceCode: "{\n \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\": \"object\",\n \"description\": \"The site/service/location codes granted along with a service.\",\n \"properties\": {\n \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200, \"description\": \"The code value.\" },\n \"codeKind\": { \"type\": \"string\", \"required\": true, \"maxLength\": 36, \"description\": \"The associated business unit.\" }\n }\n} \n" - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "type" : "string", "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type": "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: "{\n \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"A container for phone number details.\",\n \"properties\" : {\n \"number\" : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\" },\n \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\" : \"The phone number type.\" }\n },\n \"required\" : [ \"type\" ]\n} \n" - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: "{\n \"id\" : \"http://api.covisint.com/schema/baseDefinitionResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\": {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n },\n \"properties\": {\n \"name\": {\n \"description\": \"The application name (internationalized).\",\n \ \"required\": true,\n \"$ref\": \"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"description\": {\n \"required\": false,\n \"description\": \"The application description (internationalized).\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }, \n \"properties\":{\n \"type\":\"array\",\n \"description\":\"Properties used by the implementation.\",\n \"required\":false,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The name of the property.\",\n \"required\": true\n },\n \ {\n \"type\": \"string\",\n \"description\": \"The value of the property.\",\n \"required\": true\n }\n \ ]\n }\n ]\n }\n }\n}\n" - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ], "required": true } } } - triggerDefinitionTemplates: | { "id": "http://api.covisint.com/schema/triggerDefinitionTemplates", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of trigger definition Templates.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/triggerDefinitionTemplate#" } } - triggerDefinitionTemplate: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/triggerDefinitionTemplate", "type": "object", "description": "Schema representing a trigger definition template.", "extends": { "$ref": "http://api.covisint.com/schema/baseTriggerDefinitionResource#" }, "properties": { "attributeTypes":{ "type": "array", "minItems": 0, "required": true, "description": "The attribute types for trigger definition template.", "items": { "name": { "type": "string", "description": "The name of the attribute type like eventTemplateId, deviceTemplateId, deviceId, etc.", "required": true }, "dataType": { "description": "Datatype of the attribute type.", "enum": [ "STRING", "INTEGER", "DECIMAL", "BOOL" ], "required": true }, "required": { "type":"boolean", "description":"Whether or not the attributes is required while creating trigger definition.", "default":false, "required": false }, "multi": { "type":"boolean", "description":"Whether or not the attribute can have multiple values while creating trigger definition.", "default":false, "required": false }, "prerequisites": { "required": false, "type":"array", "description":"The list of attribute types which are required before adding this attribute type.", "minItems":0, "items":[ { "type": "string", "description": "The attribute type which are required before adding this attribute type.", "required": false } ] }, "values": { "required": false, "type":"array", "description":"The list of defined values will only be populated while creating trigger definition.", "minItems":0, "items":[ { "type": "string", "description": "Value of the attribute that can be provided while creating trigger definiton.", "required": false } ] } } }, "successorTriggerDefinitionTemplateId": { "description": "The id of the trigger definition template that succeeds this one. This is typically used when a new template version is available and the template needs to be revised to accomodate for any new/deprecated attributes and features. In this scenario, a new template is created and is marked as a successor to the old one.", "type": "string", "required": false, "readOnly": true }, "isActive":{ "type":"boolean", "description":"Whether or not the trigger definition template is active.", "default":false, "readOnly": true } } } - triggerDefinitions: | { "id": "http://api.covisint.com/schema/triggerDefinitions", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of trigger definitions.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/triggerDefinition#" } } - triggerDefinition: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/triggerDefinition", "type": "object", "description": "Schema representing a trigger definition.", "extends": { "$ref": "http://api.covisint.com/schema/baseTriggerDefinitionResource#" }, "properties": { "attributes":{ "required": true, "type":"array", "description":"The list of trigger attributes.", "minItems":1, "items":[ { "anyOf": [ { "type": "string", "description": "The name of the trigger attributes like eventTemplateId, deviceTemplateId, deviceId, etc. as specified in trigger attribute types.", "required": true }, { "required": true, "type":"array", "description":"The list of values in trigger attributes.", "minItems":1, "items":[ { "type": "string", "description": "The values for trigger attributes types like eventTemplateId, deviceTemplateId, deviceId, etc.", "required": true } ] } ] } ] }, "ruleDefinitionIds": { "required": false, "type":"array", "description":"The list of rule definition Id's.", "minItems":0, "items":[ { "type": "string", "description": "The IDs of rule definition in trigger definition.", "required": false } ] }, "parentTriggerDefinitionTemplateId": { "type": "string", "required": true, "description": "The parent trigger definition template Id." }, "isActive":{ "type":"boolean", "description":"Whether or not this trigger definition is active.", "default":false, "readOnly": true } } } - ruleDefinitions: | { "id": "http://api.covisint.com/schema/ruleDefinitions", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of rule definitions.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/ruleDefinition#" } } - ruleDefinition: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/ruleDefinition", "type": "object", "description": "Schema representing a rule definition.", "extends": { "$ref": "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "actionDefinitionIds": { "required": true, "type":"array", "description":"The list of action definition Id's.", "minItems":1, "items":[ { "type": "string", "description": "The IDs of action defintions in rule definition.", "required": true } ] }, "ruleSource": { "type": "string", "required": true, "description": "The rule source for the rule definition which will be executed by rule excutor and should be in the ruleLanguage specified. Rule source should be encoded in BASE-64." }, "priority": { "type": "integer", "min": 1, "max": 100, "required": true, "description": "The priority of the rule definition. Use default value 1" }, "type": { "description": "Type of rule.", "enum": [ "DEVICE" ], "required": true }, "ruleLanguage": { "description": "Language used by executor to run.", "enum": [ "JS" ], "required": true }, "tags":{ "description":"The list of tags associated to the rule definition.", "$ref":"http://api.covisint.com/schema/tags#", "readOnly": true }, "isActive":{ "type":"boolean", "description":"Whether or not the rule definition is active.", "default":false, "readOnly": true } } } - actionDefinitionTemplates: "{ \n \"id\":\"http://api.covisint.com/schema/actionDefinitionTemplates\",\n \ \"$schema\":\"http://json-schema.org/draft-04/schema\",\n \"description\":\"Collection of action definition templates\",\n \"type\":\"array\",\n \"items\":{\n \"$ref\":\"http://api.covisint.com/schema/actionDefinitionTemplate#\"\n \ }\n}\n \n" - actionDefinitionTemplate: "{ \n \"$schema\":\"http://json-schema.org/draft-04/schema#\",\n \ \"id\":\"http://api.covisint.com/schema/actionDefinitionTemplate\",\n \"type\":\"object\",\n \ \"description\":\"Schema representing a Action Definition Template.\",\n \"extends\":{\n \ \"$ref\":\"http://api.covisint.com/schema/baseActionDefinitionResource#\"\n \ },\n \"properties\":{\n \"attributeTypes\":{\n \"type\": \"array\",\n \ \"minItems\": 0,\n \"required\": true,\n \"description\": \"The attribute templates for action definition template.\",\n \"items\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the attribute type like sms.target.id, email.addresses, commandId, applicationId.\",\n \"required\": true\n },\n \"dataType\": {\n \"description\": \"Datatype of the attribute type.\",\n \"enum\": [\n \"STRING\",\n \"INTEGER\",\n \"DECIMAL\",\n \ \"BOOL\"\n ],\n \"required\": true\n },\n \ \"required\": {\n \"type\":\"boolean\",\n \"description\":\"Whether or not the attributes is required while creating action definition.\",\n \"default\":false,\n \ \"required\": false\n },\n \"multi\": {\n \"type\":\"boolean\",\n \ \"description\":\"Whether or not the attribute can have multiple values while crearing action definition.\",\n \"default\":false,\n \ \"required\": false\n },\n \"prerequisites\": {\n \"required\": false,\n \"type\":\"array\",\n \"description\":\"The list of attribute types which are required before adding this attribute type.\",\n \ \"minItems\":0,\n \"items\":[\n {\n \"type\": \"string\",\n \"description\": \"The attribute type which are required before adding this attribute type.\",\n \"required\": false\n }\n ]\n }\n }\n },\n \"successorActionDefinitionTemplateId\": {\n \"description\": \"The id of the action definition template that succeeds this one. This is typically used when a new template version is available and the template needs to be revised to accomodate for any new/deprecated attributes and features. In this scenario, a new template is created and is marked as a successor to the old one.\",\n \"type\": \"string\",\n \"required\": false,\n \"readOnly\": true\n },\n \"isActive\":{\n \"type\":\"boolean\",\n \ \"description\":\"Whether or not this actionDefinitionTemplate is active.\",\n \ \"default\":false,\n \"readOnly\": true\n }\n }\n}\n" - actionDefinitions: | { "id" : "http://api.covisint.com/schema/actionDefinitions", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Collection of actionDefinitions", "type" : "array", "items" : { "$ref": "http://api.covisint.com/schema/actionDefinition#" } } - actionDefinition: | { "id" : "http://api.covisint.com/schema/actionDefinition", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a actionDefinition", "extends" : { "$ref" : "http://api.covisint.com/schema/baseActionDefinitionResource#" }, "properties" : { "parentActionDefinitionTemplateId": { "description": "Id of the parent action definition template.", "$ref": "String", "required": true }, "attributes":{ "type":"array", "description":"The list of attributes as specified in action definition attribute types.", "required":true, "minItems":1, "items":[ { "anyOf": [ { "type": "string", "description": "The key of attributes.", "required": true }, { "required": false, "type":"array", "description": "The list of values of attribute which are available in attribute types in action definition template.", "minItems":0, "items":[ { "type": "string", "description": "The attribute value.", "required": false } ] } ] } ] }, "isActive":{ "type":"boolean", "description":"Whether or not this actionDefinitionTemplate is active.", "default":false, "readOnly": true } } } - ruleTasks: | { "id" : "http://api.covisint.com/schema/ruleTasks", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Collection of actionDefinitions", "type" : "array", "items" : { "$ref": "http://api.covisint.com/schema/ruleTask#" } } - ruleTask: | { "id" : "http://api.covisint.com/schema/ruleTask", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a ruleTask", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "type": { "description": "Type of rule task.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ], "required": true }, "attributes":{ "type":"array", "description":"The list of attributes as per type.", "required":true, "minItems":0, "items":[ { "anyOf": [ { "type": "string", "description": "The key of attribute.", "required": true }, { "type": "string", "description": "The value of attribute.", "required": true } ] } ] }, "messageId": { "description": "Id of the message to be sent", "$ref": "String", "required": false }, "message": { "description": "Message to be sent for processing by rule engine.", "$ref": "String", "required": false } } } 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. <> <> "/triggerDefinitionTemplates": description: Collection endpoint for TriggerDefinitionTemplate resources. post: description: Create a new TriggerDefinitionTemplate. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.triggerDefinitionTemplate.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.messaging.triggerDefinitionTemplate.v1+json type: string required: true is: - postResponse - secured body: application/vnd.com.covisint.platform.messaging.triggerDefinitionTemplate.v1+json: schema: triggerDefinitionTemplate responses: 201: description: TriggerDefinitionTemplate created successfully. body: application/vnd.com.covisint.platform.messaging.triggerDefinitionTemplate.v1+json: schema: triggerDefinitionTemplate 400: description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema get: is: - pagableRequest - sortable - getSearchResponse - secured description: Search triggerDefinitionTemplates based on the given query parameters. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.triggerDefinitionTemplate.v1+json type: string required: true queryParameters: id: description: Filter trigger definition templates by their unique id. Multiple parameter values can be provided, in which case any matching event sources will be returned. type: string required: false name: description: Retrieve trigger definition template with the specified Name. Range search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false creation: description: Retrieve attribute types with the specified creation. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. the pattern would be creation=>value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=