#%RAML 0.8 title: Group API baseUri: "https://api.covisintlabs.com/group/v3" 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." }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } , "required":[ "id" ] } - namedResourceReference: | { "id" : "http://api.covisint.com/schema/namedScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the basic resource reference and adds internationalized name and description.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceReference#" }, "properties" : { "name" : { "description": "Internationalized resource name.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized resource description.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" } } } - 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." }, "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." }, "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.", "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.", "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.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - resourceV2: | { "id" : "http://api.covisint.com/schema/resourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resourceV2", "type" : "object", "description" : "A basic resource (version V2).", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource." }, "version": { "type" : "string", "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." }, "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.", "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.", "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.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - 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 read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.", "readonly": true } } , "required":[ "realm" ] } - realmScopedResourceV2: | { "id" : "http://api.covisint.com/schema/realmScopedResourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceV2#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "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.", "readonly": true } } , "required":[ "realm" ] } - errorResponseSchema: | { "id" : "http://api.covisint.com/schema/errorResponseSchema", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of an HTTP 4xx/5xx error response.", "properties" : { "status" : { "type" : "number", "minimum" : 400, "maximum" : 599, "description" : "The HTTP status code." }, "apiMessage" : { "type" : "string", "description" : "A helpful, human-readable description of the error, useful for basic diagnostics." }, "apiStatusCode" : { "type" : "string", "description" : "The API-specific status code." } } , "required":[ "status" ] } - serviceCode: | { "id" : "http://api.covisint.com/schema/serviceCodes", "$schema" : "http://json-schema.org/draft-04/schema", "type": "object", "description": "The site/service/location codes granted along with a service.", "properties": { "code": { "type": "string", "maxLength": 200, "description": "The code value." }, "codeKind": { "type": "string", "maxLength": 36, "description": "The associated business unit." } } , "required":[ "code", "codeKind" ] } - 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: | { "id" : "http://api.covisint.com/idm/schema/phone", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for phone number details.", "properties" : { "number" : { "type" : "string","maxLength" : 100, "description" : "The phone number." }, "type" : { "enum" : [ "main", "mobile", "fax" ], "description" : "The phone number type." } }, "required" : [ "type" ] } - 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: | { "id" : "http://api.covisint.com/schema/baseDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.", "extends": { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "name": { "description": "The application name (internationalized).", "$ref": "http://api.covisint.com/schema/internationalString#" }, "description": { "description": "The application description (internationalized).", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "properties":{ "type":"array", "description":"Properties used by the implementation.", "minItems":0, "items":[ { "anyOf": [ { "type": "string", "description": "The name of the property." }, { "type": "string", "description": "The value of the property." } ] } ] } , "required":[ "items" ] } , "required":[ "name" ] } - 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 } } , "required":[ "type" ] } - 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":[ "type" ] } - dataType: | { "id" : "http://api.covisint.com/schema/dataType", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Data type enum.", "enum":[ "string", "integer", "bool", "decimal" ] } - attribute: | { "id" : "http://api.covisint.com/schema/attribute", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "An attribute.", "properties" : { "oneOf" : [ { "attributeTypeId" : { "type" : "string", "description" : "The attribute type id." } }, { "attributeType" : { "description" : "The full attribute type definition.", "$ref" : "http://api.covisint.com/schema/attributeType#" } } ], "value" : { "type" : "any", "description" : "The attribute value." } } , "required":[ "attributeTypeId" ] } - attributes: | { "id" : "http://api.covisint.com/schema/attributes", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Collection of attributes.", "items" : { "$ref" : "http://api.covisint.com/schema/attribute#" } } - expression: | { "id" : "http://api.covisint.com/schema/expression#", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "The DSL for defining conditional expressions.", "oneOf" : [ { "type" : "object", "properties" : { "any" : { "type" : "array", "description" : "An aggregate expression representing an 'any' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "properties" : { "all" : { "type" : "array", "description" : "An aggregate expression representing an 'all' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "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.", "properties" : { "expr" : { "type" : "string" } } , "required":[ "expr" ] } ] } - memberType: | { "id": "http://api.covisint.com/idm/schema/memberType", "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "description" : "The member type allowed for a resource.", "properties": { "type": { "type": "string", "description": "The member type" }, "kind": { "type": "array", "description": "The list of member kinds", "minItems": 1, "items": { "type" : "string", "description" : "The member kind" } } } , "required" : [ "type"] } - memberTypes: | { "id" : "http://api.covisint.com/schema/memberTypes", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Collection of member types.", "minItems": 1, "items": { "$ref": "http://api.covisint.com/schema/memberType#" } } - mappedRules: | { "id": "http://api.covisint.com/idm/schema/mappedRules", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The rule policy ids mapped to the resource, keyed by the name of the event which triggers the execution of those rules. This is a multimap so many rules may be executed for a single event; the order of execution should not matter.", "minItems": 0, "required": false, "items": { "type": "object", "properties": { "sourceEventKey": { "type": "string", "description": "The name of the event which triggers the execution of the rules." }, "mappedRulePolicyIds": { "type": "array", "description": "The rule policy ids mapped to the resource.", "minItems": 1, "items": { "type": "string", "description": "The rule policy id", "required": true } } } , "required" : [ "sourceEventKey"] } } - groupAttribute: | { "id" : "http://api.covisint.com/schema/groupAttribute", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A group attribute.", "properties" : { "oneOf": [ { "attributeTypeId": { "type": "string", "description": "The attribute type id.", "required": true } }, { "attributeType": { "description": "The full attribute type definition.", "$ref": "http://api.covisint.com/schema/attributeType#" } } ], "value": { "type": "any", "description": "The attribute value." }, "metadata": { "type": "object", "description": "The metadata about the attribute.", "readOnly": true, "properties": { "inherited": { "type" : "boolean", "description": "Indicates whether this attribute is inherited from the parent resource. Defaults to false.", "required": false, "default": false, "readOnly": true } } } } , "required" : [ "attributeTypeId"] } - groupAttributes: | { "id" : "http://api.covisint.com/schema/groupAttributes", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Collection of group attributes.", "items": { "$ref": "http://api.covisint.com/schema/groupAttribute#" } } - groupTemplates: | { "id": "http://api.covisint.com/schema/groupTemplates", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of group templates", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/groupTemplate#" } } - groupTemplate: | { "id" : "http://api.covisint.com/schema/groupTemplate", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a group template.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "name":{ "description":"Name of the group template.", "$ref":"http://api.covisint.com/schema/internationalString#" }, "description":{ "description":"Description of the group template.", "$ref":"http://api.covisint.com/schema/internationalString#" }, "active":{ "type" : "boolean", "description": "Indicates whether this group template is active. Defaults to true.", "default": true, "readOnly": true }, "allowedMemberTypes": { "description": "The member types allowed for this group template. An empty set indicates that any member type is permitted.", "$ref": "http://api.covisint.com/idm/schema/memberTypes#" }, "ruleMappings": { "description": "The rule policy ids mapped to this group template, keyed by the name of the event which triggers the execution of those rules.", "$ref": "http://api.covisint.com/idm/schema/mappedRules#" }, "tags": { "description": "The tags associated with this group template.", "$ref": "http://api.covisint.com/idm/schema/tag#", "readOnly": true }, "attributeTypes": { "type":"array", "description":"The list of attribute types associated with the group template.", "minItems":0, "items":[ { "anyOf": [ { "type": "string", "description": "The id of the attribute type." }, { "$ref": "http://api.covisint.com/schema/attributeType#", "description": "The attribute type definition." } ] } ] }, "syntheticEvents": { "type": "array", "description": "The synthetic events associated with this group template.", "items": { "type": "string", "description": "The id of the event template." } } } , "required" : [ "name","attributeTypes"] } - group: | { "id" : "http://api.covisint.com/schema/group", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a group, a container of resources.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "name":{ "description":"Name of the group.", "$ref":"http://api.covisint.com/schema/internationalString#" }, "description":{ "description":"Description of the group.", "$ref":"http://api.covisint.com/schema/internationalString#" }, "owner": { "description": "The group owner.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "entitlements": { "description": "The group's entitlements if any, returned in the response, depending upon the supplied media type. Read-only.", "$ref": "http://api.covisint.com/schema/group.entitlements#" }, "isImmutable": { "type" : "boolean", "description": "The flag which denotes whether group is immutable. Defaults to false.", "default": false }, "attributes": { "description": "The attributes associated with this group. The attributes could be inherited from the group template, if the group was created from a group template, or could be custom attributes associated with the group.", "$ref": "http://api.covisint.com/schema/groupAttributes#", "minItems": 1 }, "active":{ "type" : "boolean", "description": "Indicates whether this group is active. Defaults to true.", "default": true }, "tags": { "description": "The tags associated with this group.", "$ref": "http://api.covisint.com/idm/schema/tags#", "readOnly": true }, "parentGroupTemplateId": { "type" : "string", "description": "The id of the group template used or being referred to create the group. This field is applicable only for groups created from a group template.", "readOnly": true }, "lifecycleState": { "type": "string", "description": "The lifecycle state of the group. This field is applicable only for groups created from a group template.", "readOnly": true }, "supportedMemberTypes": { "description": "The member types allowed to be added to this group. An empty set indicates that all member types are permitted. These are inhertied from the group template. This field is applicable only for groups created from a group template.", "$ref": "http://api.covisint.com/idm/schema/memberTypes#", "readOnly": true }, "standardRuleMappings": { "description": "The standard rule policy ids mapped to this group, keyed by the name of the event which triggers the execution of those rules. These are inherited from the group template. This field is applicable only for groups created from a group template.", "$ref": "http://api.covisint.com/idm/schema/mappedRules#", "readOnly": true }, "extendedRuleMappings": { "type": "array", "description": "The extended rule policy ids mapped directly to this group, keyed by the name of the event which triggers the execution of those rules. These are not available with the group template. This field is applicable only for groups created from a group template.", "$ref": "http://api.covisint.com/idm/schema/mappedRules#" }, "standardSyntheticEvents": { "type": "array", "description": "The synthetic events associated with this group. These are the inherited from the group template.", "readOnly": true, "items": { "type": "string", "description": "The id of the event template." } } } , "required" : [ "name","owner"] } - group.entitlements: | { "id" : "http://api.covisint.com/schema/group.entitlements", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Entitlements associated with the group.", "type" : "array", "items" : { "$ref": "http://api.covisint.com/schema/group.entitlement#" } } - 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" } } , "required" : ["name"] } - group.membership: | { "id" : "http://api.covisint.com/schema/group.membership", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceV2#" }, "properties" : { "member": { "description": "The resource that has a membership to the group.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "group": { "description": "Reference to the Group the members belongs to.", "anyOf": [ { "description": "A reference to the group that the member belongs to.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, { "description": "The group that the member belongs to.", "$ref": "http://api.covisint.com/schema/group#" } ] }, "membershipAttributes": { "description": "The list of attributes associated with this group membership.", "$ref": "http://api.covisint.com/schema/groupAttributes#" } } , "required" : [ "member"] } - group.memberRelationships: | { "id": "http://api.covisint.com/schema/group.memberRelationships", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of group member relationships", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/group.memberRelationship#" } } - group.memberRelationship: | { "id": "http://api.covisint.com/schema/group.memberRelationship", "$schema": "http://json-schema.org/draft-04/schema", "extends": { "$ref": "http://api.covisint.com/schema/resourceV2#" }, "properties": { "sourceEntity": { "description": "A reference to the source group membership of the relationship.", "anyOf":[ { "description": "A reference to the source group membership of the relationship.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, { "description": "The source group membership of the relationship.", "$ref": "http://api.covisint.com/schema/group.membership#" } ] }, "targetEntity": { "description": "A reference to the target group membership of the relationship.", "anyOf":[ { "description": "A reference to the target group membership of the relationship.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, { "description": "A reference to the target group membership of the relationship.", "$ref": "http://api.covisint.com/schema/group.membership#" } ] }, "group": { "description": "A reference to the group that the member relationship belongs to.", "anyOf":[ { "description": "A reference to the group that the member relationship belongs to.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, { "description": "A reference to the group that the member relationship belongs to.", "$ref": "http://api.covisint.com/schema/group.membership#" } ] }, "relationName": { "description": "The name of the relationship.", "type": "string" }, "effectiveInstant": { "type": "number", "minimum": 0, "description": "The time, in milliseconds since the epoch, from which this relationship will be effective. The effective instant should be less than or equal to the expiration instant. If no value is provided, then relationship is effective immediately after its creation." }, "expirationInstant": { "type": "number", "minimum": 0, "description": "The time, in milliseconds since the epoch, after which this relationship will expire. The expiration instant should greater than or equal to the effective instant and greater than the instant at which the relationship is created. If no value is provided, then relationship will never expire." }, "relationshipAttributes": { "description": "The list of attributes associated with this member relationship.", "$ref": "http://api.covisint.com/schema/groupAttributes#" } }, "required": ["relationName", "targetEntity", "sourceEntity", "group"] } - memberRelationshipSearchRequest: | { "id" : "http://api.covisint.com/schema/memberRelationshipSearchRequest", "$schema" : "http://json-schema.org/draft-04/schema", "properties" : { "searchType": { "enum": [ "TRACE_PATH", "INCOMING", "OUTGOING" ], "description": "The search type of the relationships search request." }, "fromMemberSpec": { "type": "string", "description": "The from member spec of the relationships search request. This is mandatory and applicable only for search type TRACE_PATH." }, "toMemberSpec": { "type": "string", "description": "The to member spec of the relationships search request. This is mandatory and applicable only for search type TRACE_PATH." }, "memberSpec": { "type": "string", "description": "The member spec of the relationships search request. This is mandatory and applicable only for search types INCOMING / OUTGOING." } }, "required" : [ "searchType"] } - memberRelationshipSearchResponse: | { "id" : "http://api.covisint.com/schema/memberRelationshipSearchResponse", "$schema" : "http://json-schema.org/draft-04/schema", "properties" : { "request": { "description": "The search request for the relationships search.", "$ref": "http://api.covisint.com/idm/schema/memberRelationshipSearchRequest#" }, "results": { "description": "The search results for the relationships search.", "$ref" : "http://api.covisint.com/schema/group.memberRelationships#" } }, "required" : [ "request","results"] } - memberTypeResponse: | { "id" : "http://api.covisint.com/schema/memberTypeResponse", "$schema" : "http://json-schema.org/draft-04/schema", "properties" : { "memberType": { "type": "string", "description": "The member type." }, "constraints": { "type": "array", "minItems": 0, "description": "The constraints for the member type.", "items": { "type": "object", "properties": { "groupId": { "type": "string", "description": "The group id." }, "memberKind": { "type": "array", "minItems": 1, "description": "The member kinds associated with the group for the member type." } }, "required" : [ "groupId","memberKind"] } } }, "required" : [ "memberType","results"] } traits: - secured: displayName: secured - unsecured: displayName: unsecured - getResponse: displayName: getResponse - getSearchResponse: displayName: getSearchResponse - postResponse: displayName: postResponse - deleteResponse: displayName: deleteResponse - putResponse: displayName: putResponse - putResponseV2: displayName: putResponseV2 - putCreateResponse: displayName: putCreateResponse - taskResponse: displayName: taskResponse - pagableRequest: displayName: pagableRequest - taggable: displayName: taggable - sortable: displayName: sortable - searchable: displayName: searchable /groupTemplates: description: "Collection endpoint for group templates.[Since:3.0]" is: [secured] get: description: "Search group templates based on the given filter parameters. [Flow-name:group-search-group-templates][Since:1.0]" headers: Accept: description: Media type. Specify parameter includeAttributeTypes with a value of true to return the attribute type definition nested within the group template resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.template.v1+json;includeAttributeTypes=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve group templates with the specified id. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false name: description: Retrieve group templates with the specified name. Wildcard search is supported using asterisk (*). Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false description: description: Retrieve group templates with the specified description. Wildcard search is supported using asterisk (*). Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false allowedMemberType: description: Retrieve group templates with the specified allowed member type. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false mappedBehavior.event: description: Retrieve group templates with the specified event name of the rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false mappedBehavior.rule: description: Retrieve group templates with the specified rule policy id of the rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false active: description: Retrieve the active/inactive group templates. type: boolean required: false repeat: false syntheticEvent: description: Retrieve group templates with the specified synthetic event. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+creation, "-creation"] example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). 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 repeat: false responses: "200": description: All group templates that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.group.template.v1+json: schema: groupTemplates "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: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 "406": 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": 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 "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 is: [pagableRequest, sortable, taggable, getSearchResponse, secured] post: description: "Create a new group template. [Since:3.0][Flow-name:group-create-group-template]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.template.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.group.template.v1+json: schema: groupTemplate responses: "201": description: A new group template was created and returned in the body. body: application/vnd.com.covisint.platform.group.template.v1+json: schema: groupTemplate "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 - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + 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:data:illegal - The following properties contained illegal values: {fieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": 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 "415": 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": 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 "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 is: [postResponse] /count: description: "Count endpoint for group templates.[Since:3.0]" is: [secured] get: description: "Count group templates based on the given query parameters.[Flow-name:group-count-group-templates]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve count of group templates with the specified id. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false name: description: Retrieve count of group templates with the specified name. Wildcard search is supported using asterisk (*). Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false description: description: Retrieve count of group templates with the specified description. Wildcard search is supported using asterisk (*). Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false allowedMemberType: description: Retrieve count of group templates with the specified allowed member type. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false mappedBehavior.event: description: Retrieve count of group templates with the specified event name of the rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false mappedBehavior.rule: description: Retrieve count of group templates with the specified rule policy id of the rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false active: description: Retrieve count of the active/inactive group templates. type: boolean required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" sortBy: description: Sort the results based on some criteria. type: string required: false repeat: false example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). 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 repeat: false responses: "200": description: Returns the number of group templates that satisfy the query parameters. body: text/plain: "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: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 "406": 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": 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 "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 is: [pagableRequest, sortable, taggable, getSearchResponse, secured] /{groupTemplateId}: description: Endpoint for an individual group template. uriParameters: groupTemplateId: description: Unique group template identifier. type: string required: true repeat: false is: [secured] get: description: "Returns a group template by its unique identifier. [Since:3.0][Flow-name:group-get-group-template]" headers: Accept: description: Media type. Specify parameter includeAttributeTypes with a value of true to return the attribute type definition nested within the group template resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.template.v1+json;includeAttributeTypes=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The group template was successfully retrieved. body: application/vnd.com.covisint.platform.group.template.v1+json: schema: groupTemplate "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.template.v1+json: schema: groupTemplate "404": 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": 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": 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 "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 is: [getResponse] /tags/{tag}: description: Tag endpoint for group templates. uriParameters: tag: description: The tag value. type: string required: true repeat: false is: [secured] put: description: "Tags the specified group template. [Since:3.0][Flow-name:group-tag-group-template]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The tag was successfully added. "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 - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - A resource with the following ID was not found: {id} + grouptemplate.locked - The group template {groupTemplateId} is currently locked. Hence modifications to the group template are not allowed. Try after sometime. 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 "406": 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 "409": 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": 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": 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 "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 is: [putResponse] delete: description: "Removes a tag from the group template. [Since:3.0][Flow-name:group-untag-group-template]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The tag was successfully removed from the group template. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request + framework:request:io + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - A resource with the following ID was not found: {id} + grouptemplate.locked - The group template {groupTemplateId} is currently locked. Hence modifications to the group template are not allowed. Try after sometime. 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 "500": 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 "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 is: [deleteResponse] /tasks/activate: description: Activation endpoint for group templates. is: [secured] post: description: "Activates the group template. Has no effect on an already-active group template. [Since:3.0][Flow-name:group-activate-group-template]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: groupTemplateId: description: The id of the group template to activate. type: string required: true repeat: false responses: "204": description: Group template successfully activated. "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + grouptemplate.locked - The group template {groupTemplateId} is currently locked. Hence modifications to the group template are not allowed. Try after sometime. 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 "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 /tasks/deactivate: description: Deactivation endpoint for group templates. is: [secured] post: description: "Deactivate the group template. Has no effect on an already-inactive group template. [Since:3.0][Flow-name:group-deactivate-group-template]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: groupTemplateId: description: The id of the group template to activate. type: string required: true repeat: false responses: "204": description: Device template successfully deactivated. "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + grouptemplate.locked - The group template {groupTemplateId} is currently locked. Hence modifications to the group template are not allowed. Try after sometime. 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 "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 /tasks/mapRules: description: Map Rules endpoint for group templates. is: [secured] post: description: "Maps rules to the group template. Also maps these rules as standard mappings to all the groups created from this group template [Since:3.0][Flow-name:group-map-group-template-rules]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: groupTemplateId: description: The id of the group template to which rules have to be mapped. type: string required: true repeat: false sourceEventKey: description: The name of the event which triggers the execution of the rules. type: string required: true repeat: false rulePolicyId: description: The rule policy id to be mapped to the group template. Multiple parameters are supported, at least one is mandatory. type: string required: true repeat: false responses: "204": description: Successfully mapped rules to the group template. "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + grouptemplate.multiple.{queryParameterName}s.not.allowed - Multiple {queryParameterName}s are not allowed + grouptemplate.duplicate.rule.mapping - The rule policy ids: {rulePolicyIds} are already mapped to the source event key: {sourceEventKey} + grouptemplate.locked - The group template {groupTemplateId} is currently locked. Hence modifications to the group template are not allowed. Try after sometime. 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 "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 /tasks/unmapRules: description: Unmap Rules endpoint for group templates. is: [secured] post: description: "Unmaps rules from the group template. Also unmaps these rules from the standard mappings of all the groups created from this group template [Since:3.0][Flow-name:group-unmap-group-template-rules]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: groupTemplateId: description: The id of the group template from which rules have to be unmapped. type: string required: true repeat: false sourceEventKey: description: The name of the event which triggers the execution of the rules. type: string required: true repeat: false rulePolicyId: description: The rule policy id to be unmapped from the group template. Multiple parameters are supported. If none are provided, then all rule policy ids mapped to the event are unmapped. type: string required: false repeat: false responses: "204": description: Successfully unmapped rules from the group template. "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + grouptemplate.multiple.{queryParameterName}s.not.allowed - Multiple {queryParameterName}s are not allowed + grouptemplate.invalid.rule.mapping - There is no rule mapping with the source event key: {sourceEventKey} + grouptemplate.invalid.rule.mapping - The rule policy ids: {rulePolicyIds} are not mapped to the source event key: {sourceEventKey} + grouptemplate.locked - The group template {groupTemplateId} is currently locked. Hence modifications to the group template are not allowed. Try after sometime. 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 "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 /groups: description: "Collection endpoint for groups.[Since:1.0]" is: [secured] get: description: "Search group templates based on the given filter parameters. [Flow-name:group-search-groups][Since:1.0]" headers: Accept: description: Media type. Specify parameter includeEntitlements with a value of true to return the entitlements nested within the group resource. Specify parameter includeAttributeTypes with a value of true to return the attribute type definition nested within the group resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.v1+json;includeEntitlements=true;includeAttributeTypes=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 repeat: false name: description: Retrieve groups with the specified name. Wildcard search is supported using asterisk (*). Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false description: description: Retrieve groups with the specified description. Wildcard search is supported using asterisk (*). Multiple parameters are supported and the search results will be a union. type: string required: false repeat: 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 repeat: 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 repeat: false active: description: Retrieve the active/inactive groups. type: boolean required: false repeat: false immutable: description: Retrieve the mutable/immutable groups. type: boolean required: false repeat: 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 repeat: 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 repeat: false parentGroupTemplateId: description: Retrieve only groups with the specified parent group template id. Multiple parameters are supported and the search results will be a union. If the value * is supplied, then only groups created from group templates will be considered in the search results. type: string required: false repeat: false supportedMemberType: description: Retrieve only groups where the specified member type is supported. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false standardMappedBehavior.event: description: Retrieve only groups with the specified event name of the standard rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false standardMappedBehavior.rule: description: Retrieve only groups with the specified rule policy id of the standard rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false extendedMappedBehavior.event: description: Retrieve only groups with the specified event name of the extended rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false extendedMappedBehavior.rule: description: Retrieve only groups with the specified rule policy id of the extended rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false standardSyntheticEvent: description: Retrieve groups with the specified standard synthetic event. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" 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 repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+creation, "-creation"] example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). 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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": 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": 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 "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 is: [pagableRequest, taggable, getSearchResponse, sortable] post: description: "Creates a new group. [Flow-name:group-create-group]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 properties contained illegal values: {fieldName(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 "406": 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 "415": 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": 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 "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 is: [postResponse] /count: description: "Count endpoint for groups.[Since:2.1]" is: [secured] get: description: "count groups [Flow-name:group-count-groups]" headers: Accept: description: Media type. type: string required: false repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 repeat: false name: description: Retrieve groups with the specified name. Wildcard search is supported using asterisk (*). Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false description: description: Retrieve groups with the specified description. Wildcard search is supported using asterisk (*). Multiple parameters are supported and the search results will be a union. type: string required: false repeat: 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 repeat: 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 repeat: false active: description: Retrieve the active/inactive groups. type: boolean required: false repeat: false immutable: description: Retrieve the mutable/immutable groups. type: boolean required: false repeat: 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 repeat: 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 repeat: false parentGroupTemplateId: description: Retrieve only groups with the specified parent group template id. Multiple parameters are supported and the search results will be a union. If the value * is supplied, then only groups created from group templates will be considered in the search results type: string required: false repeat: false supportedMemberType: description: Retrieve only groups where the specified member type is supported. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false standardMappedBehavior.event: description: Retrieve only groups with the specified event name of the standard rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false standardMappedBehavior.rule: description: Retrieve only groups with the specified rule policy id of the standard rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false extendedMappedBehavior.event: description: Retrieve only groups with the specified event name of the extended rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false extendedMappedBehavior.rule: description: Retrieve only groups with the specified rule policy id of the extended rule mapping. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false responses: "200": description: Returns the number of groups that satisfy the query parameters. body: text/plain: "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + 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 "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 /{groupId}: description: Endpoint for an individual group. uriParameters: groupId: description: Unique group identifier. type: string required: true repeat: false maxLength: 36 is: [secured] get: description: "Returns a group by its unique identifier. [Since:1.0][Flow-name:group-get-group]" headers: Accept: description: Specify parameter includeEntitlements with a value of true to return the entitlements nested within the group resource. Specify parameter includeAttributeTypes with a value of true to return the attribute type definition nested within the group resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.v1+json;includeEntitlements=true;includeAttributeTypes=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (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": 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": 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 "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 is: [getResponse] put: description: "Updates an existing group.[Since:1.0][Flow-name:group-update-group]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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:data:illegal - The following properties contained illegal values: {fieldName(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 "404": 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": 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 "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": 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": 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 "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 is: [putResponseV2] delete: description: "Deletes a group if it is not immutable. [Since:1.1][Flow-name:group-delete-group]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 "500": 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 "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 is: [deleteResponse] /tags/{tag}: description: Collection endpoint for group tags. uriParameters: tag: description: The tag for the group. type: string required: true repeat: false is: [secured] put: description: "Associates a tag to the group. [Since:2.0][Flow-name:group-update-tag-group]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The tag was successfully set to the 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. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (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": 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 "409": 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": 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": 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 "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 is: [putResponse] delete: description: "Removes a tag from the group. [Since:2.0][Flow-name:group-remove-tag-group]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The tag was successfully removed from the 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. + 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 "500": 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 "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 is: [deleteResponse] /entitlements: is: [secured] get: description: "Search for entitlements associated with the group. [Flow-name:group-search-group-entitlements][Since:1.0]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.entitlement.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve only the group entitlement for the specified id. Multiple parameters are supported. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" 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 "404": 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": 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": 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 "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 is: [getResponse, pagableRequest] post: description: "Adds a new entitlement to this group. [Since:1.0][Flow-name:group-create-group-entitlements]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.entitlement.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.group.entitlement.v1+json: schema: group.entitlement responses: "201": description: The Flow-name 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 properties contained illegal values: {fieldName(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 "406": 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 "415": 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": 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 "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 is: [postResponse] /{groupEntitlementId}: description: Individual endpoint for a group entitlement. uriParameters: groupEntitlementId: description: Unique identifier of the group entitlement. type: string required: true repeat: false maxLength: 36 is: [secured] get: description: "Returns the group entitlement by its unique id. [Since:1.0][Flow-name:group-get-group-Flow-name]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.entitlement.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 "404": 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": 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": 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 "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 is: [getResponse] delete: description: "Deletes a group entitlement. [Since:1.0][Flow-name:group-delete-group-entitlement]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 "500": 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 "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 is: [deleteResponse] /memberships: is: [secured] get: description: "Lists all memberships for the given group. [Since:1.0][Flow-name:group-search-group-memberships]" headers: Accept: description: Media type. Specify parameter includeGroup with a value of true to return the group resource nested within the membership resource. Specify parameter includeGroupAndEntitlements with a value of true to return the group resource along with entitlements nested within the membership resource. Specify parameter includeAttributeTypes with a value of true to return the attribute type definition nested for the membership attributes, within the membership resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.membership.v1+json;includeGroupAndEntitlements=true;includeGroup=true;inlcudeAttributeTypes=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 "404": 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": 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": 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 "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 is: [getResponse] post: description: "Creates a new group membership. [Since:1.0][Flow-name:group-create-group-membership]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.membership.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 properties contained illegal values: {fieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - A resource with the following ID was not found: {id} + groupmembership.unsupported.member.type - The member type {memberType} is not supported by the group. The supported member types are {supportedMemberTypes} + groupmembership.has.relationships - The group membership {groupMembershipId} cannot be deleted since it has relationships associated with it. 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 "406": 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 "415": 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": 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 "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 is: [postResponse] /{groupMembershipId}: description: Endpoint for a specific membership in the group. uriParameters: groupMembershipId: description: Unique identifier of the membership. type: string required: true repeat: false maxLength: 50 is: [secured] get: description: "Returns a group membership resource by its unique id. [Since:1.0][Flow-name:group-get-group-membership]" headers: Accept: description: Media type. Specify parameter includeGroup with a value of true to return the group resource nested within the membership resource. Specify parameter includeGroupAndEntitlements with a value of true to return the group resource along with entitlements nested within the membership resource. Specify parameter includeAttributeTypes with a value of true to return the attribute type definition nested for the membership attributes, within the membership resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.membership.v1+json;includeGroupAndEntitlements=true;includeGroup=true;inlcudeAttributeTypes=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 "404": 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": 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": 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 "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 is: [getResponse] delete: description: "Deletes a group membership from a group. [Since:1.0][Flow-name:group-delete-group-membership]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk 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 "500": 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 "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 is: [deleteResponse] /relationships: is: [secured] get: description: "Search for member realtionships within the group. If no query parameters are provided, it lists all the member relationships for the group. [Since:3.0][Flow-name:group-search-group-member-relationships]" headers: Accept: description: Media type. Specify parameter includeGroupMembership with a value of true to return the memberships nested within the relationship resource, for the source and target entities. Specify parameter includeGroup with a value of true to return the group nested within the relationshp resource. If this parameter is specified in combination with the includeGroupMembership parameter, then the groups are nested within the membership resources. Specify parameter includeGroupAndEntitlements with a value of true to return the group nested within the relationship resource, and entitlements nested within the group. If this parameter is specified in combination with the includeGroupMembership parameter, then the groups are nested within the membership resources, and entitlements are nested within these groups. Specify parameter includeAttributeTypes with a value of true to return the attribute type definition nested for the relationship attributes, within the relationship resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.member.relationship.v1+json;includeGroupAndEntitlements=true;includeGroup=true;includeGroupMembership=true,includeAttributeTypes=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: relationName: description: Retrieve relationships for the given group with the specified relation name. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false relationshipAttributes.attributeType.id: description: Retrieve relationships referencing a attribute type of the given relationship attribute type id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false relationshipAttributes.value: description: Retrieve only relationships referencing the given relationship attribute value. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false responses: "200": description: The member relationships were successfully retrieved. body: application/vnd.com.covisint.platform.group.member.relationship.v1+json: schema: group.memberRelationships "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + 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 "404": 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": 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": 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 "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 is: [getResponse] post: description: "Creates a new member relationship. [Since:3.0][Flow-name:group-create-group-member-relationship]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.member.relationship.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.group.member.relationship.v1+json: schema: group.memberRelationship responses: "201": description: A new member relationship was created for the group and is returned in the body. body: application/vnd.com.covisint.platform.group.member.relationship.v1+json: schema: group.memberRelationship "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 - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + 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:data:illegal - The following properties contained illegal values: {fieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:missing - A resource with the following ID was not found: {id} + group.member.relationship.invalid.source.entity.id - The group {groupId} does not have the group membership {sourceGroupMembershipId} + group.member.relationship.invalid.target.entity.id - The group membership {targetGroupMembershipId} does not exist + group.member.relationship.exists - A member relationship already exists between the source entity {sourceGroupMembershipId} and target entity {targetGroupMembershipId}, with the relation name '{relationName}' 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:concurrent:modification - An error occured while adding the relationship {relationName} between the memberships {sourceEntityId} and {targetEntityId}, since the membership(s) have been updated. Please retry again. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": 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 "415": 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": 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 "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 is: [postResponse] /{relationshipId}: description: Endpoint for a specific member relationship in the group. uriParameters: relationshipId: description: Unique identifier of the member relationship. type: string required: true repeat: false is: [secured] get: description: "Returns a group member relationship resource by its unique id. [Since:3.0][Flow-name:group-get-group-member-relationship]" headers: Accept: description: Media type. Specify parameter includeGroupMembership with a value of true to return the memberships nested within the relationship resource, for the source and target entities. Specify parameter includeGroup with a value of true to return the group nested within the relationshp resource. If this parameter is specified in combination with the includeGroupMembership parameter, then the groups are nested within the membership resources. Specify parameter includeGroupAndEntitlements with a value of true to return the group nested within the relationship resource, and entitlements nested within the group. If this parameter is specified in combination with the includeGroupMembership parameter, then the groups are nested within the membership resources, and entitlements are nested within these groups. Specify parameter includeAttributeTypes with a value of true to return the attribute type definition nested for the relationship attributes, within the relationship resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.member.relationship.v1+json;includeGroupAndEntitlements=true;includeGroup=true;includeGroupMembership=true;inlcudeAttributeTypes=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The group member relationship was successfully retrieved. body: application/vnd.com.covisint.platform.group.member.relationship.v1+json: schema: group.memberRelationship "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (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": 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": 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 "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 is: [getResponse] delete: description: "Deletes a group member relationship from a group. [Since:3.0][Flow-name:group-delete-group-member-relationship]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The group member relationship 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 "500": 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 "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 is: [deleteResponse] /tasks/activate: description: Activates the given group. is: [secured] post: description: "Activates the given group. [Since:2.0][Flow-name:group-task-activate-group]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: groupId: description: The id of group to activate. type: string required: true repeat: false 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 "406": 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 "415": 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": 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 "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 is: [postResponse] /tasks/deactivate: description: Deactivates the given group. is: [secured] post: description: "Deactivates the given group. [Since:2.0][Flow-name:group-task-deactivate-group]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: groupId: description: The id of the group to deactivate. type: string required: true repeat: false 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 "406": 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 "415": 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": 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 "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 is: [postResponse] /tasks/suspend: description: Suspends the given group. is: [secured] post: description: "Suspends the given group. [Since:3.0][Flow-name:group-task-suspend-group]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: groupId: description: The id of group to suspend. type: string required: true repeat: false responses: "204": description: The group was successfully suspended. "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 "406": 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 "415": 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": 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 "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 is: [postResponse] /tasks/unsuspend: description: Unsuspend the given group. is: [secured] post: description: "Unsuspend the given group. [Since:3.0][Flow-name:group-task-unsuspend-group]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: groupId: description: The id of the group to unsuspend. type: string required: true repeat: false responses: "204": description: The group was successfully unsuspended. "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 "406": 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 "415": 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": 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 "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 is: [postResponse] /tasks/createGroupFromTemplate: description: Create a new group based on the given groupTemplateId. is: [secured] post: description: "Create a new group based on the given groupTemplateId. [Since:3.0][Flow-name:group-create-group-from-template]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: groupTemplateId: description: The id of the group template on which to model the group. type: string required: true repeat: false responses: "201": description: Successfully created a new group, which is returned in the response 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 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} + group.creation.error.inactive.grouptemplate - The group template is in inactive state + grouptemplate.locked - The group template with id {groupTemplateId} is currently locked. Hence no new groups can be created currently. Try after sometime. 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 "406": 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 "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 /memberships: description: "Endpoint for operations on all group memberships. [Since:1.0]" is: [secured] get: description: "Search for group memberships. [Flow-name:group-search-memberships]" headers: Accept: description: Media type. Specify parameter includeGroup with a value of true to return the group resource nested within the membership resource. Specify parameter includeGroupAndEntitlements with a value of true to return the group resource along with entitlements nested within the membership resource. Specify parameter includeAttributeTypes with a value of true to return the attribute type definition nested for the membership attributes, within the membership resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.membership.v1+json;includeGroupAndEntitlements=true;includeGroup=true;inlcudeAttributeTypes=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: member.id: description: Retrieve only memberships having the supplied member id. Multiple parameters are not supported. type: string required: true repeat: false member.type: description: Retrieve only memberships having the supplied member type. Multiple parameters are not supported. type: string required: false repeat: 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 repeat: 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 repeat: false membershipAttributes.attributeType.id: description: Retrieve only memberships referencing a attribute type of the given membership attribute type id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false membershipAttributes.value: description: Retrieve only memberships referencing the given membership attribute value. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" 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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": 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": 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 "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 is: [getSearchResponse, pagableRequest] /memberTypes: description: "Endpoint to return a full listing of allowed member types across all groups that exist in that realm. [Since:3.0]" is: [secured] get: description: "Endpoint to return a full listing of allowed member types across all groups that exist in that realm. [Flow-name:group-list-member-types]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.group.membertype.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The full listing of allowed member types across all groups that exist in that realm was successfully retrieved. body: application/vnd.com.covisint.platform.group.membertype.v1+json: schema: memberTypeResponse "406": 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": 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 "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 is: [getSearchResponse]