#%RAML 0.8 title: Group API baseUri: https://apistg.np.covapp.io/group/v2 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" - 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 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 } } } - 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 is mandatory if x-realm header is NOT available\",\n \ \"required\": false\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." } } } } - group: "{\n \"id\" : \"http://api.covisint.com/schema/group\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"Schema representing a group, a container of resources.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n \ },\n \"properties\" : { \n \"name\" : {\n \"type\" : \"array\",\n \ \"description\": \"Internationalized group name. Language code must be a valid 2-character ISO 639 language code.\",\n \"required\": true,\n \"minItems\": 1,\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"lang\": { \"type\": \"string\", \"maxLength\": 10 },\n \"value\": { \"type\": \"string\", \"maxLength\": 2000 }\n }\n }\n },\n \"description\" : {\n \"type\" : \"array\",\n \"description\": \"Internationalized group description. Language code must be a valid 2-character ISO 639 language code.\",\n \ \"required\": true,\n \"minItems\": 1,\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"lang\": { \"type\": \"string\", \"maxLength\": 10 },\n \"value\": { \"type\": \"string\", \"maxLength\": 2000 }\n }\n }\n },\n \"owner\": {\n \"description\": \"The group owner.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\":true\n },\n \"entitlements\": {\n \"description\": \"The group's entitlements if any, returned in the response, depending upon the supplied media type. Read-only.\",\n \"$ref\": \"http://api.covisint.com/schema/group.entitlements#\",\n \ \"required\": false\n },\n \"isImmutable\": {\n \"type\" : \"boolean\",\n \ \"description\": \"The flag which denotes whether group is immutable. Defaults to false.\",\n \"required\": false,\n \"default\": false\n },\n \"attributes\": {\n \"type\": \"array\",\n \"minItems\": 1,\n \"required\": false,\n \ \"description\": \"The attributes associated with this group.\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": { \"type\": \"string\", \"description\": \"The attribute name.\", \"required\": true },\n \"value\": { \"type\": \"string\", \"description\": \"The attribute value.\", \"required\": true }\n }\n }\n },\n \"active\":{\n \ \"type\" : \"boolean\",\n \"description\": \"Indicates whether this group is active. Defaults to true.\",\n \"required\": false,\n \"default\": true\n },\n \"tags\": {\n \"description\": \"The tags associated with this group.\",\n \"required\": false,\n \"$ref\": \"http://api.covisint.com/idm/schema/tags#\",\n \ \"readOnly\": true\n }\n }\n}\n" - group.entitlements: "{\n \"id\" : \"http://api.covisint.com/schema/group.entitlements\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Entitlements associated with the group.\",\n \"type\" : \"array\",\n \"items\" : { \n \"$ref\": \"http://api.covisint.com/schema/group.entitlement#\"\n }\n}\n" - group.entitlement: | { "id" : "http://api.covisint.com/schema/group.entitlement", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "An entitlement that may be associated to a group.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceV2#" }, "properties": { "name": { "type": "string", "maxLength": "128", "required": true } } } - group.membership: "{\n \"id\" : \"http://api.covisint.com/schema/group.membership\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"extends\" : {\n \ \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : { \n \"member\": { \n \"description\": \"The resource that has a membership to the group.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\":true\n },\n \"anyOf\": [\n {\n \"group\": {\n \"description\": \"A reference to the group that the member belongs to.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\":true\n }\n },\n {\n \"group\": {\n \"description\": \"The group that the member belongs to.\",\n \"$ref\": \"http://api.covisint.com/schema/group#\",\n \"required\":true\n }\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 - 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 - 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. <> <> "/groups": is: - secured description: Collection endpoint for groups. get: is: - searchable: since: '' entitlement: "[Entitlement:group-search-groups]" - getSearchResponse - pagableRequest - taggable headers: Accept: description: Media type. Specify parameter includeEntitlements with a value of true to return the entitlements nested within the group resource. example: application/vnd.com.covisint.platform.group.v1+json;includeEntitlements type: string required: true queryParameters: id: description: Retrieve groups with the specified id. Multiple parameters are supported and the search results will be a union. type: string required: false name: description: Retrieve groups with the specified name. Multiple parameters are supported and the search results will be a union. type: string required: false description: description: Retrieve groups with the specified description. Multiple parameters are supported and the search results will be a union. type: string required: false attributes.name: description: Retrieve groups with the specified attribute name. Multiple parameters are supported and the search results will be a union. type: string required: false attributes.value: description: Retrieve groups with the specified attribute value. Multiple parameters are supported and the search results will be a union. type: string required: false active: description: Retrieve the active/inactive groups. type: boolean required: false immutable: description: Retrieve the mutable/immutable groups. type: boolean required: false owner.id: description: Retrieve only groups with the specified owner. Multiple parameters are supported and the search results will be a union. type: boolean required: false owner.type: description: Retrieve only groups with the specified owner type. Multiple parameters are supported and the search results will be a union. type: boolean required: false sortBy: description: Sort the search results. type: string required: false enum: - "+creation" - "-creation" responses: 200: description: All groups that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.group.v1+json: schema: group 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema post: is: - postResponse description: Creates a new group. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.group.v1+json type: string required: true body: application/vnd.com.covisint.platform.group.v1+json: schema: group responses: 201: description: A new group was created and is returned in the body. body: application/vnd.com.covisint.platform.group.v1+json: schema: group 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{groupId}": description: Endpoint for an individual group. uriParameters: groupId: description: Unique group identifier. type: string maxLength: 36 required: true is: - secured get: is: - getResponse description: Returns a group by its unique identifier. headers: Accept: description: Media type. Setting includeEntitlements media type attribute to true inlines the group's entitlements in the representation. example: application/vnd.com.covisint.platform.group.v1+json;includeEntitlements type: string required: true responses: 200: description: The group was successfully retrieved. body: application/vnd.com.covisint.platform.group.v1+json: schema: group 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.platform.group.v1+json;includeEntitlements: schema: group put: is: - putResponseV2 description: Updates an existing group. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.group.v1+json type: string required: true body: application/vnd.com.covisint.platform.group.v1+json: schema: group responses: 200: description: The group was successfully updated. body: application/vnd.com.covisint.platform.group.v1+json: schema: group 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Deletes a group if it is not immutable. headers: responses: 204: description: The group 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: | There was a problem with the client's request ___ Substatus codes 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 "/tags/{tag}": is: - secured description: Collection endpoint for group tags. uriParameters: tag: description: The tag for the group. type: string required: true put: is: - putResponse description: Associates a tag to the group. responses: 204: description: The tag was successfully set to the group. 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-requestor header value. Valid values are [person, application] \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: is: - deleteResponse description: Removes a tag from the group. responses: 204: description: The tag was successfully removed from the group. 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-requestor header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 404: description: | There was a problem with the client's request ___ Substatus codes 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 "/entitlements": is: - secured get: is: - searchable: since: "[Since:1.0]" entitlement: "[Entitlement:group-search-group-entitlements]" - getResponse - pagableRequest headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.group.entitlement.v1+json type: string required: true queryParameters: id: description: Retrieve only the group entitlement for the specified id. Multiple parameters are supported. type: string required: false responses: 200: description: The entitlements were successfully retrieved. This will be an empty array if no entitlements exist. body: application/vnd.com.covisint.platform.group.entitlement.v1+json: schema: group.entitlements 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 post: is: - postResponse description: Adds a new entitlement to this group. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.group.entitlement.v1+json type: string required: true body: application/vnd.com.covisint.platform.group.entitlement.v1+json: schema: group.entitlement responses: 201: description: The entitlement was successfully created. body: application/vnd.com.covisint.platform.group.entitlement.v1+json: schema: group.entitlement 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{groupEntitlementId}": description: Individual endpoint for a group entitlement. uriParameters: groupEntitlementId: description: Unique identifier of the group entitlement. type: string maxLength: 36 required: true is: - secured get: is: - getResponse description: Returns the group entitlement by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.group.entitlement.v1+json type: string required: true responses: 200: description: The group entitlement was successfully retrieved. body: application/vnd.com.covisint.platform.group.entitlement.v1+json: schema: group.entitlement 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 delete: is: - deleteResponse description: Deletes a group entitlement. headers: responses: 204: description: The entitlement 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: | There was a problem with the client's request ___ Substatus codes 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 "/memberships": is: - secured get: is: - getResponse description: Lists all memberships for the given group. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.group.membership.v1+json;includeGroupAndEntitlements;includeGroup type: string required: true responses: 200: description: The group memberships were successfully retrieved. body: application/vnd.com.covisint.platform.group.membership.v1+json: schema: group.membership 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 post: is: - postResponse description: Creates a new group membership. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.group.membership.v1+json type: string required: true body: application/vnd.com.covisint.platform.group.membership.v1+json: schema: group.membership responses: 201: description: A new group membership was created for the group and is returned in the body. body: application/vnd.com.covisint.platform.group.membership.v1+json: schema: group.membership 400: description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 409: description: | There was a problem with the client's request + substatus codes and error messages are mentioned below: + 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 "/{groupMembershipId}": description: Endpoint for a specific membership in the group. uriParameters: groupMembershipId: description: Unique identifier of the membership. type: string maxLength: 50 required: true is: - secured get: is: - getResponse description: Returns a group membership resource by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.group.membership.v1+json;includeGroupAndEntitlements;includeGroup type: string required: true responses: 200: description: The group membership was successfully retrieved. body: application/vnd.com.covisint.platform.group.membership.v1+json: schema: group.membership 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 delete: is: - deleteResponse description: Deletes a group membership from a group. headers: responses: 204: description: The membership 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: | There was a problem with the client's request ___ Substatus codes 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": is: - secured description: Activates the given group. post: is: - postResponse description: Activates the given group. headers: queryParameters: groupId: description: The id of group to activate. type: string required: true responses: 204: description: The groups were successfully activated. 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] + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:resource:missing - The following resources were not found: {resources} + group.multiple.group.ids.not.allowed - Multiple groupIds are not allowed body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 404: description: | There was a problem with the client's request ___ Substatus codes 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/deactivate": is: - secured description: Deactivates the given group. post: is: - postResponse description: Deactivates the given group. headers: queryParameters: groupId: description: The id of the group to deactivate. type: string required: true responses: 204: description: The groups were successfully deactivated. 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] + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:resource:missing - The following resources were not found: {resources} + group.multiple.group.ids.not.allowed - Multiple groupIds are not allowed body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 404: description: | There was a problem with the client's request ___ Substatus codes 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 "/memberships": description: Endpoint for operations on all group memberships. is: - secured get: is: - searchable: since: '' entitlement: "[Entitlement:group-search-memberships]" - getSearchResponse - pagableRequest headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.group.membership.v1+json;includeGroupAndEntitlements;includeGroup type: string required: true queryParameters: member.id: description: Retrieve only memberships having the supplied member id. Multiple parameters are not supported. type: string required: true member.type: description: Retrieve only memberships having the supplied member type. Multiple parameters are not supported. type: string required: false group.owner.id: description: Retrieve only memberships associated with group having the supplied owner id. Multiple parameters are not supported. type: string required: false group.owner.type: description: Retrieve only memberships associated with group having the supplied owner type. Multiple parameters are not supported. type: string required: false responses: 200: description: The memberships were successfully retrieved. This may be an empty array if no memberships matched the search criteria. body: application/vnd.com.covisint.platform.group.memberships.v1+json;includeGroupAndEntitlements;includeGroup: schema: group.membership 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