#%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: "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \ \"id\": \"http://api.covisint.com/schema/triggerDefinitionTemplate\",\n \"type\": \"object\",\n \"description\": \"Schema representing a trigger definition template.\",\n \ \"extends\": {\n \"$ref\": \"http://api.covisint.com/schema/baseTriggerDefinitionResource#\"\n \ },\n \"properties\": { \n \"attributeTypes\":{\n \"type\": \"array\",\n \"minItems\": 0,\n \"required\": true,\n \"description\": \"The attribute types for trigger definition template.\",\n \"items\": {\n \ \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the attribute type like eventTemplateId, deviceTemplateId, deviceId, etc.\",\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 trigger 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 creating trigger 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 \"values\": {\n \"required\": false,\n \ \"type\":\"array\",\n \"description\":\"The list of defined values will only be populated while creating trigger definition.\",\n \"minItems\":0,\n \ \"items\":[\n {\n \"type\": \"string\",\n \ \"description\": \"Value of the attribute that can be provided while creating trigger definiton.\",\n \"required\": false\n }\n \ ]\n }\n }\n },\n \"successorTriggerDefinitionTemplateId\": {\n \"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.\",\n \"type\": \"string\",\n \"required\": false,\n \"readOnly\": true\n },\n \"isActive\":{\n \"type\":\"boolean\",\n \ \"description\":\"Whether or not the trigger definition template is active.\",\n \"default\":false,\n \"readOnly\": true\n }\n \ }\n}\n" - 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: "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \ \"id\": \"http://api.covisint.com/schema/triggerDefinition\",\n \"type\": \"object\",\n \ \"description\": \"Schema representing a trigger definition.\",\n \"extends\": {\n \"$ref\": \"http://api.covisint.com/schema/baseTriggerDefinitionResource#\"\n \ },\n \"properties\": {\n \"attributes\":{\n \"required\": true,\n \"type\":\"array\", \n \"description\":\"The list of trigger attributes.\",\n \"minItems\":1,\n \"items\":[\n \ {\n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The name of the trigger attributes like eventTemplateId, deviceTemplateId, deviceId, etc. as specified in trigger attribute types.\",\n \"required\": true\n },\n {\n \ \"required\": true,\n \"type\":\"array\",\n \ \"description\":\"The list of values in trigger attributes.\",\n \"minItems\":1,\n \ \"items\":[\n {\n \ \"type\": \"string\",\n \"description\": \"The values for trigger attributes types like eventTemplateId, deviceTemplateId, deviceId, etc.\",\n \"required\": true\n }\n ]\n \ }\n ]\n \ }\n ]\n },\n \"ruleDefinitionIds\": {\n \"required\": false,\n \"type\":\"array\", \n \ \"description\":\"The list of rule definition Id's.\",\n \"minItems\":0,\n \ \"items\":[ \n {\n \"type\": \"string\",\n \"description\": \"The IDs of rule definition in trigger definition.\",\n \"required\": false\n }\n \ ]\n },\n \"parentTriggerDefinitionTemplateId\": {\n \"type\": \"string\",\n \"required\": true,\n \ \"description\": \"The parent trigger definition template Id.\"\n \ },\n \"isActive\":{\n \"type\":\"boolean\",\n \"description\":\"Whether or not this trigger definition is active.\",\n \"default\":false,\n \ \"readOnly\": true\n }\n }\n}\n" - 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: "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \ \"id\": \"http://api.covisint.com/schema/ruleDefinition\",\n \"type\": \"object\",\n \ \"description\": \"Schema representing a rule definition.\",\n \"extends\": {\n \"$ref\": \"http://api.covisint.com/schema/baseDefinitionResource#\"\n \ },\n \"properties\": {\n \"actionDefinitionIds\": {\n \"required\": true,\n \"type\":\"array\",\n \"description\":\"The list of action definition Id's.\",\n \"minItems\":1,\n \"items\":[ \ \n {\n \"type\": \"string\",\n \"description\": \"The IDs of action defintions in rule definition.\",\n \"required\": true\n }\n ]\n },\n \"ruleSource\": {\n \"type\": \"string\",\n \"required\": true,\n \"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.\"\n },\n \"priority\": {\n \"type\": \"integer\",\n \ \"min\": 1,\n \"max\": 100,\n \"required\": true,\n \"description\": \"The priority of the rule definition. Use default value 1\"\n },\n \"type\": {\n \"description\": \"Type of rule.\",\n \"enum\": [\n \"DEVICE\"\n \ ],\n \"required\": true\n },\n \"ruleLanguage\": {\n \ \"description\": \"Language used by executor to run.\",\n \"enum\": [ \n \"JS\"\n ],\n \"required\": true\n \ },\n \"tags\":{\n \"description\":\"The list of tags associated to the rule definition.\",\n \"$ref\":\"http://api.covisint.com/schema/tags#\",\n \ \"readOnly\": true\n },\n \"isActive\":{\n \"type\":\"boolean\",\n \ \"description\":\"Whether or not the rule definition is active.\",\n \"default\":false,\n \ \"readOnly\": true\n }\n }\n}\n" - 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 \"values\": {\n \"required\": false,\n \"type\":\"array\",\n \"description\":\"The list of defined values will only populate while creating action defintion.\",\n \ \"minItems\":0,\n \"items\":[\n {\n \"type\": \"string\",\n \"description\": \"Value of the attribute that can be provided while creating action definiton.\",\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: "{\n \"id\" : \"http://api.covisint.com/schema/actionDefinitions\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of actionDefinitions\",\n \"type\" : \"array\",\n \"items\" : \ { \n \"$ref\": \"http://api.covisint.com/schema/actionDefinition#\"\n }\n}\n" - actionDefinition: "{\n \"id\" : \"http://api.covisint.com/schema/actionDefinition\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing a actionDefinition\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/baseActionDefinitionResource#\"\n \ },\n \"properties\" : { \n \"parentActionDefinitionTemplateId\": {\n \"description\": \"Id of the parent action definition template.\",\n \ \"$ref\": \"String\",\n \"required\": true\n }, \n \"attributes\":{\n \ \"type\":\"array\",\n \"description\":\"The list of attributes as specified in action definition attribute types.\",\n \"required\":true,\n \ \"minItems\":1,\n \"items\":[ \n { \n \"anyOf\": [\n {\n \"type\": \"string\",\n \"description\": \"The key of attributes.\",\n \"required\": true\n },\n \ {\n \"required\": false,\n \"type\":\"array\",\n \ \"description\": \"The list of values of attribute which are available in attribute types in action definition template.\",\n \"minItems\":0,\n \ \"items\":[\n {\n \"type\": \"string\",\n \"description\": \"The attribute value.\",\n \ \"required\": false\n }\n ]\n \ }\n ]\n }\n ]\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" - ruleTasks: "{\n \"id\" : \"http://api.covisint.com/schema/ruleTasks\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Collection of actionDefinitions\",\n \"type\" : \"array\",\n \"items\" : { \n \"$ref\": \"http://api.covisint.com/schema/ruleTask#\"\n }\n}\n" - ruleTask: "{\n \"id\" : \"http://api.covisint.com/schema/ruleTask\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"Schema representing a ruleTask\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n \ },\n \"properties\" : {\n \"type\": {\n \"description\": \"Type of rule task.\",\n \"enum\": [\n \"DEVICE_SEND_EVENT\",\n \"DEVICE_LIFECYCLE_STATE_CHANGE\",\n \ \"DEVICE_OPERATIONAL_STATE_CHANGE\"\n ],\n \"required\": true\n },\n \"attributes\":{\n \"type\":\"array\",\n \"description\":\"The list of attributes as per type.\",\n \"required\":true,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \"type\": \"string\",\n \"description\": \"The key of attribute.\",\n \"required\": true\n },\n \ {\n \"type\": \"string\",\n \"description\": \"The value of attribute.\",\n \"required\": true\n }\n \ ]\n }\n ]\n },\n \"messageId\": {\n \"description\": \"Id of the message to be sent\",\n \"$ref\": \"String\",\n \"required\": false\n },\n \"message\": {\n \"description\": \"Message to be sent for processing by rule engine.\",\n \"$ref\": \"String\",\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. <> <> "/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.\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 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. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+creation" - "-creation" - "+id" - "-id" - "+name" - "-name" responses: 200: description: Matching triggerDefinitionTemplates were retrieved successfully. body: application/vnd.com.covisint.platform.messaging.triggerDefinitionTemplate.v1+json: schema: triggerDefinitionTemplates 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-requestor header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/count": description: Endpoint to return the count of trigger definition templates that match the given query criteria. get: is: - getSearchResponse - secured description: Count trigger definition templates based on the given query parameters. headers: Accept: description: Media type. example: text/plain 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 trigger definition templates will be returned. type: string name: description: Filter trigger definition templates by the name. Multiple parameter values can be provided, in which case any matching trigger definition templates will be returned. type: string description: description: Filter trigger definition templates by the description. Multiple parameter values can be provided, in which case any matching trigger definition templates will be returned. type: string responses: 200: description: The number of matching trigger definition templates was returned. body: plain/text: 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 "/{triggerDefinitionTemplateId}": description: Endpoint for an individual triggerDefinitionTemplate. uriParameters: triggerDefinitionTemplateId: description: Unique id of the triggerDefinitionTemplate. type: string get: description: Retrieve the triggerDefinitionTemplate by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.triggerDefinitionTemplate.v1+json type: string required: true is: - getResponse - secured responses: 200: description: TriggerDefinitionTemplate was successfully retrieved by its id. body: application/vnd.com.covisint.platform.messaging.triggerDefinitionTemplate.v1+json: schema: triggerDefinitionTemplate 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 "/tasks/activate": post: description: Activates the triggerDefinitionTemplate. headers: is: - secured queryParameters: triggerDefinitionTemplateId: description: id to activate. responses: 204: description: TriggerDefinitionTemplate sucessfully activated. 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 triggerDefinitionTemplate. headers: is: - secured queryParameters: triggerDefinitionTemplateId: description: TriggerDefinitionTemplate id to deactivate. responses: 204: description: TriggerDefinitionTemplate sucessfully deactivated. 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 "/triggerDefinitions": description: Collection endpoint for TriggerDefinition resources. post: description: Create a new TriggerDefinition. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json type: string required: true is: - postResponse - secured body: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json: schema: triggerDefinition responses: 201: description: TriggerDefinition created successfully. body: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json: schema: triggerDefinition 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 get: is: - pagableRequest - sortable - getSearchResponse - secured description: Search triggerDefinitions based on the given query parameters. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json type: string required: true queryParameters: id: description: Filter triggerDefinitions 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 attribute types with the specified triggerDefinitionName. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false type: description: Retrieve attribute types with the specified triggerDefinition Type. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+creation" - "-creation" - "+id" - "-id" - "+name" - "-name" - "+type" - "-type" responses: 200: description: Matching triggerDefinitions were retrieved successfully. body: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json: schema: triggerDefinitions 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-requestor header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/count": description: Endpoint to return the count of trigger definitions that match the given query criteria. get: is: - getSearchResponse - secured description: Count trigger definitions based on the given query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: id: description: Filter trigger definitions by their unique id. Multiple parameter values can be provided, in which case any matching trigger definitions will be returned. type: string name: description: Filter trigger definitions by the name. Multiple parameter values can be provided, in which case any matching trigger definitions will be returned. type: string description: description: Filter trigger definitions by the description. Multiple parameter values can be provided, in which case any matching trigger definitions will be returned. type: string responses: 200: description: The number of matching trigger definitions was returned. body: plain/text: 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 "/{triggerDefinitionId}": description: Endpoint for an individual triggerDefinition. uriParameters: triggerDefinitionId: description: Unique id of the triggerDefinition. type: string get: description: Retrieve the triggerDefinition by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json type: string required: true is: - getResponse - secured responses: 200: description: TriggerDefinition was successfully retrieved by its id. body: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json: schema: triggerDefinition 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: is: - putResponse description: Updates an existing triggerDefinition. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json type: string required: true body: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json: schema: triggerDefinition responses: 200: description: The triggerDefinition was successfully updated. body: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json: schema: triggerDefinition 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] + actionDefinition.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: description: Delete an existing triggerDefinition. Throws an error if {triggerDefinitionId} does not already exist. headers: is: - secured responses: 204: description: Successfully deleted the triggerDefinition. 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 TriggerDefinition 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 triggerDefinition. headers: is: - secured queryParameters: triggerDefinitionId: description: id to activate. responses: 204: description: TriggerDefinition sucessfully activated. 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 triggerDefinition. headers: is: - secured queryParameters: triggerDefinitionId: description: TriggerDefinition id to deactivate. responses: 204: description: TriggerDefinition sucessfully deactivated. 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 "/ruleDefinitionId/{ruleDefinitionId}": description: Rule definition add/remove endpoint in trigger definition. uriParameters: ruleDefinitionId: description: Unique id of the ruleDefinition. type: string put: description: Add the specified rule definition id to trigger definition. is: - secured responses: 204: description: The rule definition id was successfully added. 404: description: The rule definition does not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 400: description: "There was a problem with the client's request.\n___ \nSubstatus 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" 500: description: An unhandled error occurred on the server. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: description: Removes a rule definition id from the triggerDefinition. is: - secured responses: 204: description: The rule definition id was successfully removed. 400: description: "There was a problem with the client's request.\n___ \nSubstatus 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" 404: description: The specified rule definition id was not associated to the trigger definition, or the ruleDefinition did not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: An unhandled error occurred on the server. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/migrateTriggerDefinitionToNewTemplate": displayName: Migrates the TriggerDefinition resource to the requested triggerDefinition template. post: description: Migrate Trigger Definition to newer Trigger Definition Template. headers: Accept: description: Media Type example: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json type: string required: true Content-Type: description: Media type example: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json type: string required: true is: - secured queryParameters: triggerDefinitionTemplateId: description: The id of the new parent trigger definition template. triggerDefinitionId: description: The trigger definition ids to upgrade. responses: 201: description: Successfully migrated triggerDefinition to triggerDefinition template. body: application/vnd.com.covisint.platform.messaging.triggerDefinition.v1+json: schema: triggerDefinition 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 500: description: | An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/ruleDefinitions": description: Collection endpoint for RuleDefinition resources. post: description: Create a new RuleDefinition. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json type: string required: true Content-Type: description: Media type of the response body. example: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json type: string required: true is: - postResponse - secured body: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json: schema: ruleDefinition responses: 201: description: RuleDefinition created successfully. body: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json: schema: ruleDefinition 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 get: is: - pagableRequest - sortable - getSearchResponse - secured description: Search ruleDefinitions based on the given query parameters. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json type: string required: true queryParameters: id: description: Filter ruleDefinitions 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 attribute types with the specified ruleDefinitionName. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false type: description: Retrieve attribute types with the specified ruleDefinition Type. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+creation" - "-creation" - "+id" - "-id" - "+name" - "-name" - "+type" - "-type" responses: 200: description: Matching ruleDefinitions were retrieved successfully. body: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json: schema: ruleDefinitions 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-requestor header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/count": description: Endpoint to return the count of rule definitions that match the given query criteria. get: is: - taggable - getSearchResponse - secured description: Count rule definitions based on the given query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: id: description: Filter rule definitions by their unique id. Multiple parameter values can be provided, in which case any matching rule definitions will be returned. type: string name: description: Filter rule definitions by the name. Multiple parameter values can be provided, in which case any matching rule definitions will be returned. type: string description: description: Filter rule definitions by the description. Multiple parameter values can be provided, in which case any matching rule definitions will be returned. type: string responses: 200: description: The number of matching rule definitions was returned. body: plain/text: 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 "/{ruleDefinitionId}": description: Endpoint for an individual ruleDefinition. uriParameters: ruleDefinitionId: description: Unique id of the ruleDefinition. type: string get: description: Retrieve the ruleDefinition by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json type: string required: true is: - getResponse - secured responses: 200: description: RuleDefinition was successfully retrieved by its id. body: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json: schema: ruleDefinition 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: is: - putResponse description: Updates an existing ruleDefinition. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json type: string required: true body: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json: schema: ruleDefinition responses: 200: description: The ruleDefinition was successfully updated. body: application/vnd.com.covisint.platform.messaging.ruleDefinition.v1+json: schema: ruleDefinition 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] + actionDefinition.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: description: Delete an existing ruleDefinition. Throws an error if {ruleDefinitionId} does not already exist. headers: is: - secured responses: 204: description: Successfully deleted the ruleDefinition. 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 RuleDefinition 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 "/tags/{tag}": description: RuleDefinition tags endpoint. uriParameters: tag: description: The tag value. minLength: 1 maxLength: 2000 required: true type: string put: description: Tags the specified ruleDefinition. is: - secured responses: 204: description: The tag was successfully added. 404: description: The ruleDefinition 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___ \nSubstatus 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" 500: description: An unhandled error occurred on the server. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: description: Removes a tag from the ruleDefinition. is: - secured responses: 204: description: The tag was successfully removed. 400: description: "There was a problem with the client's request.\n___ \nSubstatus 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" 404: description: The specified tag was not associated to the ruleDefinition, or the ruleDefinition did not exist. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: An unhandled error occurred on the server. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/activate": post: description: Activates the ruleDefinition. headers: is: - secured queryParameters: ruleDefinitionId: description: id to activate. responses: 204: description: RuleDefinition sucessfully activated. 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 ruleDefinition. headers: is: - secured queryParameters: ruleDefinitionId: description: RuleDefinition id to deactivate. responses: 204: description: RuleDefinition sucessfully deactivated. 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 "/actionDefinitionTemplates": description: Collection endpoint for action definition templates. actionDefinitionTemplates. is: - secured get: is: - searchable: since: '' entitlement: "[Entitlement:actionDefinitionTemplate-search-actionDefinitionTemplate]" - pagableRequest - sortable - getSearchResponse description: Search Action Definition Templates based on the specified query parameters. headers: Accept: description: The media type for v1 actionDefinitionTemplates. Specify parameter with a value to return the full action definitions template information nested within the Action Definition Template resource. example: application/vnd.com.covisint.platform.messaging.actionDefinitionTemplate.v1+json; type: string required: true queryParameters: id: description: Retrieve action definition templates with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false name: description: Retrieve action definition templates with the specified name. Multiple parameters are allowed and the search results will be a union. type: string required: false description: description: Retrieve action definition templates with the specified description. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: type: string required: false enum: - "+creation" - "-creation" - "+id" - "-id" - "+name" - "-name" - "+type" - "-type" responses: 200: description: All action definition templates that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.messaging.actionDefinitionTemplate.v1+json: schema: actionDefinitionTemplates 400: description: "There was a problem with the client's request.\n ___ \nSubstatus 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: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 post: description: Create a new Action Definition Template. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.actionDefinitionTemplate.v1+json type: string required: true Content-Type: description: The content type. example: application/vnd.com.covisint.platform.messaging.actionDefinitionTemplate.v1+json type: string required: true queryParameters: succeedsTemplateId: description: The id of the Action Definition Template that this one will succeed. type: string required: false is: - postResponse body: application/vnd.com.covisint.platform.messaging.actionDefinitionTemplate.v1+json: schema: actionDefinitionTemplate responses: 201: description: Action Definition Template successfully created. body: application/vnd.com.covisint.platform.messaging.actionDefinitionTemplate.v1+json: schema: actionDefinitionTemplate 400: description: "There was a problem with the client's request.\n ___ \nSubstatus 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 action definition templates that match the given query criteria. get: is: - getSearchResponse - secured description: Count action definition templates based on the given query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: id: description: Filter action Definition Templates by their unique id. Multiple parameter values can be provided, in which case any matching action Definition Templates will be returned. type: string name: description: Filter action Definition Templates by the name. Multiple parameter values can be provided, in which case any matching action Definition Templates will be returned. type: string description: description: Filter action Definition Templates by the description. Multiple parameter values can be provided, in which case any matching action Definition Templates will be returned. type: string responses: 200: description: The number of matching action Definition Templates was returned. body: plain/text: 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 "/{actionDefinitionTemplateId}": description: Endpoints for individual Action Definition Template. is: - secured uriParameters: actionDefinitionTemplateId: description: unique id of the Action Definition Template. type: string minLength: 1 get: description: Retrieves the requested Action Definition Template. headers: Accept: description: The media type for v1 actionDefinitionTemplates. Specify action definition template id to return the full action definitions template. example: application/vnd.com.covisint.platform.messaging.actionDefinitionTemplate.v1+json; type: string required: true is: - getResponse responses: 200: description: Successfully retrieved the requested Action Definition Template. body: application/vnd.com.covisint.platform.messaging.actionDefinitionTemplate.v1+json: schema: actionDefinitionTemplate 400: description: "There was a problem with the client's request.\n ___ \nSubstatus 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: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/activate": description: Activation endpoint for action definition templates. is: - secured post: description: Activates the Action Definition Template. Has no effect on an already-active Action Definition Template. queryParameters: actionDefinitionTemplateId: description: id of the Action Definition Template to activate. responses: 204: description: Action Definition Template successfully activated. 400: description: "There was a problem with the client's request.\n ___ \nSubstatus 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: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": description: Deactivation endpoint for action definition templates. is: - secured post: description: Deactivate the Action Definition Template. Has no effect on an already-inactive Action Definition Template. queryParameters: actionDefinitionTemplateId: description: id of the Action Definition Template to deactivate. responses: 204: description: Action Definition Template successfully deactivated. 400: description: "There was a problem with the client's request.\n ___ \nSubstatus 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: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 "/actionDefinitions": is: - secured description: Collection endpoint for actionDefinitions. get: is: - getSearchResponse - pagableRequest description: Search actionDefinitions based on the given filter parameters. headers: Accept: description: Media type. Setting includeProperties media type attribute to true inlines the actionDefinition's additional properties in the representation. Setting include action definition media type attribute to true inlines the actionDefinition's actionDefinition type in the representation. example: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json; type: string required: true queryParameters: id: description: Retrieve action definition with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false name: description: Retrieve action definition templates with the specified name. Multiple parameters are allowed and the search results will be a union. type: string required: false description: description: Retrieve action definition templates with the specified description. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: description: Sort the search results according to the supported sortable properties. type: string required: false enum: - "+creation" - "-creation" - "+id" - "-id" - "+name" - "-name" - "+type" - "-type" responses: 200: description: All actionDefinitions that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json: schema: actionDefinitions 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: Adds a new actionDefinition. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json type: string required: true body: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json: schema: actionDefinition responses: 201: description: The actionDefinition was successfully created. body: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json: schema: actionDefinition 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:resource:missing - The following resources were not found: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + actionDefinition.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} + actionDefinition.deviceUuid.duplicate - The actionDefinition with deviceUuid {deviceUuid} already exists body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/count": description: Endpoint to return the count of action definitions that match the given query criteria. get: is: - getSearchResponse - secured description: Count action definitions based on the given query parameters. headers: Accept: description: Media type. example: text/plain type: string required: true queryParameters: id: description: Filter action definitions by their unique id. Multiple parameter values can be provided, in which case any matching action definitions will be returned. type: string name: description: Filter action definitions by the name. Multiple parameter values can be provided, in which case any matching action definitions will be returned. type: string description: description: Filter action definitions by the description. Multiple parameter values can be provided, in which case any matching action definitions will be returned. type: string responses: 200: description: The number of matching action definitions was returned. body: plain/text: 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 "/{actionDefinitionId}": description: Endpoint for a actionDefinition. uriParameters: actionDefinitionId: description: Unique identifier for the actionDefinition. type: string required: true is: - secured get: is: - getResponse description: Returns a actionDefinition by its unique identifier. headers: Accept: description: Media type. Setting includeProperties media type attribute to true inlines the actionDefinition's additional properties in the representation. Setting includeDeviceType media type attribute to true inlines the actionDefinition's actionDefinition type in the representation. example: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json; type: string required: true responses: 200: description: The actionDefinition was successfully retrieved. body: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json: schema: actionDefinition 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 actionDefinition. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json type: string required: true body: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json: schema: actionDefinition responses: 200: description: The actionDefinition was successfully updated. body: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json: schema: actionDefinition 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] + actionDefinition.invalid.iso.language.code - The following language codes are invalid: {languageCode(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Deletes a actionDefinition. headers: responses: 204: description: The actionDefinition 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 "/tasks/activate": description: Activation endpoint for action definition. is: - secured post: description: Activates the Action Definition. Has no effect on an already-active Action Definition. queryParameters: actionDefinitionId: description: id of the Action Definition to activate. responses: 204: description: Action Definition successfully activated. 400: description: "There was a problem with the client's request.\n ___ \nSubstatus 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: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": description: Dctivation endpoint for action definition. is: - secured post: description: Deactivate the Action Definition. Has no effect on an already-inactive Action Definition. queryParameters: actionDefinitionId: description: id of the Action Definition to deactivate. responses: 204: description: Action Definition successfully deactivated. 400: description: "There was a problem with the client's request.\n ___ \nSubstatus 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: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/migrateActionDefinitionToNewTemplate": displayName: Migrates the ActionDefinition resource to the requested ActionDefinition template. [Entitlement:actionDefinition-migrateActionDefinitionToNewTemplate-actionDefinition] post: description: Migrates the ActionDefinition to requested ActionDefinitionTemplate. headers: Accept: description: Media Type example: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json type: string required: true Content-Type: description: Media type example: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json type: string required: true is: - secured queryParameters: actionDefinitionTemplateId: description: The id of the new parent action definition template. actionDefinitionId: description: The action definition ids to upgrade. responses: 200: description: Successfully migrated actionDefinition to new actionDefinition template. body: application/vnd.com.covisint.platform.messaging.actionDefinition.v1+json: schema: actionDefinition 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 "/ruleTasks/tasks/evaluate": description: Rule task endpoint for evaluation of rules. is: - secured post: description: Rule task endpoint to run the rules found active as per the type and attributes. Rules will be sent to the rule engine topology to execute fetched rules. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.messaging.ruleTask.v1+json type: string required: true body: application/vnd.com.covisint.platform.messaging.ruleTask.v1+json: schema: ruleTask is: - postResponse responses: 200: description: Event Request has been pushed successfully to Rule Component for further processing. 400: description: "There was a problem with the client's request.\n ___ \nSubstatus 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: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