#%RAML 0.8 title: Attributes API baseUri: https://api.covisintlabs.com/attributes/v1 protocols: [HTTPS] schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource.", "required": true }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } } - namedResourceReference: "{\n \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the basic resource reference and adds internationalized name and description.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"properties\" : {\n \"name\" : { \n \"description\": \"Internationalized resource name.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : { \n \"description\": \"Internationalized resource description.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\n }\n}\n" - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource.", "required": true }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.", "required": false }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "required": true, "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "required": true, "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "required": true, "readonly": true } } } } } - resourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/resourceV2\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resourceV2\",\n \ \"type\" : \"object\",\n \"description\" : \"A basic resource (version V2).\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \"required\": true\n },\n \"version\": {\n \"type\" : \"string\",\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \"creator\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.\",\n \"required\": true,\n \ \"readonly\": true\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.\",\n \"required\": true,\n \"readonly\": true\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.\",\n \ \"required\": true,\n \"readonly\": true\n }\n }\n \ }\n } \n}\n" - realmScopedResource: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the base resource and adds a realm attribute.\",\n \ \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resource#\"\n \ },\n \"properties\" : {\n \"realm\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n \ }\n }\n}\n" - realmScopedResourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResourceV2\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : {\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"description\" : \"The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.\",\n \"required\": true,\n \"readonly\": true \n }\n }\n} \n" - errorResponseSchema: "{\n \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n \"properties\" : {\n \"status\" : { \n \"type\" : \"number\",\n \"minimum\" : 400,\n \ \"maximum\" : 599,\n \"description\" : \"The HTTP status code.\",\n \ \"required\": true\n },\n \"apiMessage\" : { \n \"type\" : \"string\",\n \ \"description\" : \"A helpful, human-readable description of the error, useful for basic diagnostics.\" \n },\n \"apiStatusCode\" : {\n \"type\" : \"string\",\n \"description\" : \"The API-specific status code.\"\n }\n \ }\n}\n" - serviceCode: "{\n \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\": \"object\",\n \"description\": \"The site/service/location codes granted along with a service.\",\n \"properties\": {\n \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200, \"description\": \"The code value.\" },\n \"codeKind\": { \"type\": \"string\", \"required\": true, \"maxLength\": 36, \"description\": \"The associated business unit.\" }\n }\n} \n" - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type" : "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: "{\n \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"A container for phone number details.\",\n \"properties\" : {\n \"number\" : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\" },\n \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\" : \"The phone number type.\" }\n },\n \"required\" : [ \"type\" ]\n} \n" - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: "{\n \"id\" : \"http://api.covisint.com/schema/baseDefinitionResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\": {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n },\n \"properties\": {\n \"name\": {\n \"description\": \"The application name (internationalized).\",\n \ \"required\": true,\n \"$ref\": \"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"description\": {\n \"required\": false,\n \"description\": \"The application description (internationalized).\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }, \n \"properties\":{\n \"type\":\"array\",\n \"description\":\"Properties used by the implementation.\",\n \"required\":false,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The name of the property.\",\n \"required\": true\n },\n \ {\n \"type\": \"string\",\n \"description\": \"The value of the property.\",\n \"required\": true\n }\n \ ]\n }\n ]\n }\n }\n}\n" - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ], "required": true } } } - dataType: "{\n \"id\" : \"http://api.covisint.com/schema/dataType\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Data type enum.\",\n \"enum\":[ \n \"string\",\n \"integer\",\n \"bool\",\n \ \"decimal\"\n ]\n}\n" - attribute: "{\n \"id\" : \"http://api.covisint.com/schema/attribute\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"An attribute.\",\n \"properties\" : {\n \"oneOf\" : [\n {\n \"attributeTypeId\" : {\n \"type\" : \"string\",\n \"description\" : \"The attribute type id.\",\n \"required\" : true\n }\n },\n { \n \"attributeType\" : {\n \"description\" : \"The full attribute type definition.\",\n \"$ref\" : \"http://api.covisint.com/schema/attributeType#\" \n }\n }\n ],\n \ \"value\" : {\n \"type\" : \"any\",\n \"description\" : \"The attribute value.\",\n \"required\" : false\n }\n }\n}\n" - attributes: "{\n \"id\" : \"http://api.covisint.com/schema/attributes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"array\",\n \"description\" : \"Collection of attributes.\",\n \"items\" : { \n \"$ref\" : \"http://api.covisint.com/schema/attribute#\"\n \ }\n}\n" - expression: "{\n \"id\" : \"http://api.covisint.com/schema/expression#\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"The DSL for defining conditional expressions.\",\n \"oneOf\" : [\n {\n \"type\" : \"object\",\n \"properties\" : {\n \"any\" : {\n \"type\" : \"array\",\n \"description\" : \"An aggregate expression representing an 'any' condition.\",\n \"items\" : {\n \"$ref\" : \"http://api.covisint.com/schema/expression#\"\n }\n }\n \ }\n },\n {\n \"type\" : \"object\",\n \"properties\" : {\n \"all\" : {\n \"type\" : \"array\",\n \"description\" : \"An aggregate expression representing an 'all' condition.\",\n \"items\" : {\n \"$ref\" : \"http://api.covisint.com/schema/expression#\"\n \ }\n }\n }\n },\n {\n \"type\" : \"object\",\n \"description\" : \"A simple leaf-node expression. The format of this expression is: '(f:, v:())'. The supported expressions are: equal, notEqual, startsWith, endsWith, matches, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual. The field name can be a simple field name i.e. 'id' or hierarchical field name using dot-notation like 'resource.id' / 'resource.tag[0]' . The value corresponding to the field name provided should always be a simple data type and cannot be an array or an object.\",\n \"properties\" : {\n \"expr\" : {\n \"type\" : \"string\",\n \"required\" : \"true\"\n }\n }\n }\n ]\n}\n \n" - attribute: | { "id" : "http://api.covisint.com/schema/attribute#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "name" : { "description" : "The name of the attribute.", "type" : "string", "maxLength" : 100 }, "type" : { "description" : "The type of the attribute.", "enum" : [ "String", "Integer" ], "maxLength" : 100 }, "entity" : { "description" : "The kind of entity of the attribute.", "enum" : [ "PERSON", "ORGANIZATION" ], "maxLength" : 255 }, "description" : { "description" : "The description of the attribute.", "type" : "string", "maxLength" : 1000 }, "isDisplayable" : { "description" : "The flag which says the attribute is displayable.", "type" : "boolean", "maxLength" : 1 }, "isActive" : { "description" : "The flag which says weather attribute is active.", "type" : "boolean", "maxLength" : 1 }, "description" : { "description" : "The description of the attribute context.", "type" : "string", "maxLength" : 100 }, "isAllowedInUserRule" : { "description" : "The flag which says attribute is allowed in user rule.", "type" : "boolean", "maxLength" : 1 }, "isEditable" : { "description" : "The flag which says the attribute is editable.", "type" : "boolean", "maxLength" : 1 }, "isFixed" : { "description" : "The flag which says the attribute is fixed.", "type" : "boolean", "maxLength" : 1 }, "isUnique" : { "description" : "The flag which says the attribute is unique.", "type" : "boolean", "maxLength" : 1 }, "isEditableByAdmin" : { "description" : "The flag which says the attribute is editable by admin.", "type" : "boolean", "maxLength" : 1 }, "isEditableOnRegistration" : { "description" : "The flag which says the attribute is editable on registration.", "type" : "boolean", "maxLength" : 1 }, "isRequired" : { "description" : "The flag which says the attribute is required.", "type" : "boolean", "maxLength" : 1 }, "isRequiredOnInvitation" : { "description" : "The flag which says the attribute is required on invitation.", "type" : "boolean", "maxLength" : 1 } }, "required" : ["name","type","entity"] } - attributes : | { "type" : "array", "description" : "The collection of attributes.", "items" : { "$ref" : "http://api.covisint.com/schema/attribute#"} } - attributeReference: | { "id" : "http://api.covisint.com/schema/attributeReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing attribute reference", "type" : "array", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the attribute." }, "name" : { "type" : "string", "description" : "The name of the attribute." }, "defaultValue" : { "type" : "object", "description" : "The default value of the attribute." } }, "required":["id"] } - attributeTemplate: | { "id" : "http://api.covisint.com/schema/attributeTemplate#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an attribute template.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "name" : { "description" : "The name of the attribute template.", "type" : "string", "maxLength" : 100 }, "description" : { "description" : "The description of the attribute template.", "type" : "string", "maxLength" : 1000 }, "type" : { "description" : "The type of the attribute template.", "enum" : [ "PERSON", "ORGANIZATION"], "maxLength" : 25 }, "attributes" : { "description" : "The attributes which belongs to the attribute template.", "$ref" : "http://api.covisint.com/schema/attributeReference#" } }, "required":["name","type","attributes"] } - attributeTemplates : | { "type" : "array", "description" : "The collection of attributeTemplates.", "items" : { "$ref" : "http://api.covisint.com/schema/attributeTemplate#"} } 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 do not require any authentication. headers: SolutionInstanceId: description: The solution instance id. example: abcd123e-0109-441c-8a20-123a456b789c 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. <> <> /attributes: is: [secured] description: Collection endpoint for attributes.[Since:1.0] get: is: [getSearchResponse,pagableRequest,secured] description: Search attributes based on the given filter parameters.[flow-name:attributes-search-attributes] headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.attribute.v1+json type: string required: true queryParameters: name: description: Retrieve only attributes with the specified name of the attribute. The search is case-insensitive. Multiple parameters are supported and the search results will be a union. type: string required: false type: description: Retrieve only attributes with the specified type of the attribute. The search is case-insensitive. Multiple parameters are supported and the search results will be a union. type: string required: false entity: description: Retrieve only attributes with the specified entity of the attribute. The search is case-insensitive. Multiple parameters are supported 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" ] responses: 200: description: All attributes that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.attribute.v1+json: schema: attributes 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema post: is: [postResponse] description: Creates an attribute, attribute is unique for name and entity for solution.[flow-name:attributes-create-attribute] headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.attribute.v1+json type: string required: true Content-Type: description: Media type. example: application/vnd.com.covisint.platform.attribute.v1+json type: string required: true body: application/vnd.com.covisint.platform.attribute.v1+json: schema: attribute responses: 201: description: The attribute is successfully created. body: application/vnd.com.covisint.platform.attribute.v1+json: schema: attribute 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + attribute.exits.with.name.entity.realm - Attribute already exists with name, entity for realm. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /{id}: description: Individual endpoint for an attribute. uriParameters: id: description: Unique identifier of the attribute. type: string maxLength: 64 required: true is: [secured] get: is: [getResponse] description: Returns the attribute by id.[flow-name:attributes-get-attribute] headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.attribute.v1+json type: string required: true responses: 200: description: The attribute was successfully retrieved. body: application/vnd.com.covisint.platform.attribute.v1+json: schema: attribute 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + 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 put: is: [putResponse] description: Updates an attribute.[flow-name:attributes-update-attribute] headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.attribute.v1+json type: string required: true Content-Type: description: Media type. example: application/vnd.com.covisint.platform.attribute.v1+json type: string required: true body: application/vnd.com.covisint.platform.attribute.v1+json: schema: attribute responses: 200: description: The attribute resource was successfully updated. body: application/vnd.com.covisint.platform.attribute.v1+json: schema: attribute 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + attribute.exits.with.name.type - Attribute already exists with name {name}, type {type} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: [deleteResponse] description: Deletes an attribute, if attribute is associated with any attribute template then delete is not allowed.[flow-name:attributes-delete-attribute] headers: responses: 204: description: The attribute was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + attribute.association.exists - Attribute can't be deleted, due to an association exists body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /attributeTemplates: is: [secured] description: Collection endpoint for attribute templates.[Since:1.0] get: is: [unsecured,getSearchResponse,pagableRequest] description: Search attribute templates based on the given filter parameters.[flow-name:attributes-search-attribute-templates] headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.attribute.template.v1+json; type: string required: true queryParameters: name: description: Retrieve only attribute templates with the specified name of the attribute template. The search is case-insensitive. Multiple parameters are supported and the search results will be a union. type: string required: false attributes.id: description: Retrieve only attribute templates with the specified attribute unique identifier of the attribute. The search is case-insensitive. Multiple parameters are supported 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" ] responses: 200: description: All attribute templates that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.attribute.template.v1+json: schema: attributeTemplates 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema post: is: [postResponse] description: Creates an attribute template.[flow-name:attributes-create-attribute-template] headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.attribute.template.v1+json; type: string required: true Content-Type: description: Media type. example: application/vnd.com.covisint.platform.attribute.template.v1+json; type: string required: true body: application/vnd.com.covisint.platform.attribute.template.v1+json: schema: attributeTemplate responses: 201: description: The attribute template is created. body: application/vnd.com.covisint.platform.attribute.template.v1+json: schema: attributeTemplate 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + attribute.template.name.already.exists - Attribute template name already exists. + attributes.are.not.exists - Attributes are not exist with the following ids: {id(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /{id}: description: Individual endpoint for an attribute template. uriParameters: id: description: Unique identifier of the attribute template. type: string maxLength: 64 required: true is: [secured] get: is: [secured,getResponse] description: Returns the attribute template by id.[flow-name:attributes-get-attribute-template] headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.attribute.template.v1+json type: string required: true responses: 200: description: The attribute template was successfully retrieved. body: application/vnd.com.covisint.platform.attribute.template.v1+json: schema: attributeTemplate 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + 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 put: is: [putResponse] description: Updates an attribute template.[flow-name:attributes-update-attribute-template] headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.attribute.template.v1+json; type: string required: true Content-Type: description: Media type. example: application/vnd.com.covisint.platform.attribute.template.v1+json; type: string required: true body: application/vnd.com.covisint.platform.attribute.template.v1+json: schema: attributeTemplate responses: 200: description: The attribute template resource was successfully updated. body: application/vnd.com.covisint.platform.attribute.template.v1+json: schema: attributeTemplate 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + attribute.template.name.already.exists - Attribute template name already exists. + attributes.do.not.exists - Attributes do not exist with the following ids: {id(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: [deleteResponse] description: Deletes an attribute template.[flow-name:attributes-delete-attribute-template] headers: responses: 204: description: The attribute template was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /attributeTemplateAssociations: /{temlateId}: /persons/{personId}: delete: is: [deleteResponse] description: Deletes an attribute template association with person.[Since:1.0][flow-name:attributes-delete-attribute-template-association-with-person] headers: responses: 204: description: The attribute template association was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + attribute.association.doesnot.exists - Attribute template association doesn't exists body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /organizations/{organizationId}: delete: is: [deleteResponse] description: Deletes an attribute template association with organization.[Since:1.0][flow-name:attributes-delete-attribute-template-association-with-organization] headers: responses: 204: description: The attribute template association was successfully deleted. 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + attribute.association.doesnot.exists - Attribute template association doesn't exists body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema