#%RAML 0.8 title: Command Template API baseUri: https://api.us1.covisint.com/commandTemplate/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", "maxLength" : 36, "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: "{\n \"id\" : \"http://api.covisint.com/schema/resource\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resource\",\n \"type\" : \"object\",\n \"description\" : \"A basic resource.\",\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\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \ \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \ \"creator\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \ \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \"required\": false\n },\n \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \ \"required\": false \n }\n }\n }\n }\n}\n" - realmScopedResource: | { "id" : "http://api.covisint.com/schema/realmScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the base resource and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resource#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available", "required": false } } } - 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", "maxLength": 2000, "description": "The tag associated with a resource." } } } } - commandTemplates: "{ \n \"id\":\"http://api.covisint.com/schema/commandTemplates\",\n \ \"$schema\":\"http://json-schema.org/draft-04/schema\",\n \"description\":\"Collection of command templates\",\n \"type\":\"array\",\n \"items\":{ \n \"$ref\":\"http://api.covisint.com/schema/commandTemplate#\"\n \ }\n}\n \n" - commandTemplate: "{ \n \"id\":\"http://api.covisint.com/schema/commandTemplate\",\n \ \"$schema\":\"http://json-schema.org/draft-04/schema#\",\n \"type\":\"object\",\n \ \"description\":\"Schema representing a command template.\",\n \"extends\":{ \ \n \"$ref\":\"http://api.covisint.com/schema/realmScopedResource#\"\n },\n \ \"properties\":{ \n \"name\":{ \n \"type\":\"string\",\n \"minLength\":1,\n \ \"maxLength\":100,\n \"description\":\"Name of the command template\",\n \ \"required\":true\n },\n \"description\":{ \n \"description\":\"Description of the command template.\",\n \"required\":false,\n \"$ref\":\"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"args\":{ \n \"type\":\"array\",\n \"description\":\"The input parameters for this command template. These are akin to the arguments in a method signature.\",\n \"required\":false,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"type\":\"object\",\n \"properties\":{ \ \n \"name\":{ \n \"type\":\"string\",\n \ \"minLength\":1,\n \"maxLength\":100,\n \ \"description\":\"The name of the command\",\n \"required\":true\n \ },\n \"description\":{ \n \"required\":false,\n \ \"$ref\":\"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"type\":{ \n \"type\":\"string\",\n \ \"description\":\"The data type for the parameter field.\",\n \ \"enum\":[ \n \"string\",\n \"integer\",\n \ \"bool\",\n \"decimal\",\n \"array\"\n \ ],\n \"required\":true\n },\n \ \"index\":{ \n \"type\":\"integer\",\n \"description\":\"The index into the command arguments into which this parameter falls. Starts at 0.\",\n \ \"minimum\":0,\n \"required\":true\n }\n \ }\n }\n ]\n },\n \"isActive\":{ \n \"type\":\"boolean\",\n \ \"description\":\"Whether or not this command template is active\",\n \ \"default\":false,\n \"readOnly\":true\n },\n \"tags\":{ \ \n \"description\":\"The list of tags for command template.\",\n \"$ref\":\"http://api.covisint.com/schema/tags#\",\n \ \"readOnly\":true\n }\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: description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 403: description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getResponse: responses: 404: &3 description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 406: &1 description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: &2 description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getSearchResponse: responses: 406: *1 500: *2 - postResponse: responses: 406: *1 415: &4 description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: *2 - deleteResponse: responses: 500: *2 - putResponse: responses: 404: *3 406: *1 409: &5 description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 415: *4 500: *2 - putCreateResponse: responses: 406: *1 409: *5 415: *4 500: *2 - pagableRequest: queryParameters: page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false minimum: 1 default: 50 maximum: 200 - 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. For Fuzzy search, prefix the filter parameter value with ~. For example - name=~AABC XXYZ (This will do a fuzzy search on the resource name, and will return matching resources with name 'ABC XYZ' or 'AABC XXYZ' or 'AABC XYZ' etc.) <> <> "/commandTemplates": description: Collection endpoint for command templates. is: - secured get: is: - pagableRequest - sortable - taggable - getSearchResponse description: Search command templates based on the filter parameters. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.commandTemplate.v1+json type: string required: true queryParameters: id: description: Retrieve command templates with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false name: description: Retrieve command templates with the specified name. Multiple parameters are allowed and the search results will be a union. type: string required: false description: description: Retrieve command templates with the specified description. Multiple parameters are allowed and the search results will be a union. type: string required: false active: description: Retrieve the command templates based on active status. type: boolean required: false args.name: description: Retrieve command templates with the specified parameter name in their definition. Multiple parameters are allowed and the search results will be a union. type: string required: false args.description: description: Retrieve command templates with the specified parameter description in their definition. Multiple parameters are allowed and the search results will be a union. type: string required: false sortBy: type: string required: false enum: - "+creation" - "-creation" - "+name" - "-name" responses: 200: description: All command templates that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.commandTemplate.v1+json: schema: commandTemplates 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 command template. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.commandTemplate.v1+json type: string required: true Content-Type: description: The content type. example: application/vnd.com.covisint.platform.commandTemplate.v1+json type: string required: true is: - postResponse body: application/vnd.com.covisint.platform.commandTemplate.v1+json: schema: commandTemplate responses: 201: description: Command template successfully created. body: application/vnd.com.covisint.platform.commandTemplate.v1+json: schema: commandTemplate 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 "/{commandTemplateId}": description: Endpoints for individual command templates. is: - secured uriParameters: commandTemplateId: description: unique id of the command template. type: string get: description: Retrieves the specified command template. is: - getResponse headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.commandTemplate.v1+json type: string required: true responses: 200: description: Successfully retrieved the requested command template. body: application/vnd.com.covisint.platform.commandTemplate.v1+json: schema: commandTemplate 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 "/tags/{tag}": description: Tag endpoint for command templates. is: - secured uriParameters: tag: description: The tag value. minLength: 1 maxLength: 2000 required: true type: string put: description: Tags the specified command template. responses: 204: description: The tag was successfully added. 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 404: description: The command template did not exist. 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 delete: description: Removes a tag from the command template. 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: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 specified tag was not associated to the command template, or the command template did not exist. 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 command templates. is: - secured post: description: Activates the command template. Invoking this on an active command template has no effect. queryParameters: commandTemplateId: description: id of the command template to activate. responses: 204: description: Command 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 command templates. is: - secured post: description: Deactivates the command template. Deactivating an inactive command template has no effect. queryParameters: commandTemplateId: description: id of the command template to deactivate. responses: 204: description: Command 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