#%RAML 0.8 title: Organization API baseUri: "https://api.us1.covisint.com/organization/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" ] } ] } - organization: | { "id" : "http://api.covisint.com/schema/organization/v1", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema respreseing an organization resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 100 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, and will be ignored for POST requests." }, "status" : { "enum" : [ "active", "suspended", "inactive", "unactivated" ], "description" : "The organization's status. This property is read-only. Status can be changed through tasks." }, "parentOrganization": { "description": "The parent organization. Used to create an organization hierarchy. Required only when creating a division, read only when updating.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "rootOrganization": { "description": "The organization at the root of this hierarchy. This is the top-most organization that does not have a parent. This property is read-only.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "name" : { "type" : "string", "description" : "The organization's name.", "maxLength" : 244 }, "addresses" : { "type" : "array", "description" : "A container for the organization's addresses.", "minItems" : 1, "items" : { "ref" : "http://api.covisint.com/schema/address#", "properties" : { "streets" : { "minItems" : 1 }, "city" : { "description" : "The organization's city." }, "state" : { "description" : "The organization's state." }, "country" : { "description" : "The organization's country." } } } }, "phones" : { "type" : "array", "description" : "A container for the organization's phone number(s).", "minItems" : 0, "items" : { "$ref" : "http://api.covisint.com/schema/phone#" } }, "email" : { "type" : "string", "maxLength" : 1000, "description" : "The organization's email address." }, "url" : { "type" : "string", "description" : "A URL representing this organization.", "maxLength" : 1000 }, "authDomain" : { "type" : "string", "description" : "This organization's authentication domain.", "maxLength" : 50 }, "organizationType" : { "type" : "string", "description" : "The organization type. Unless there is reason to specify otherwise, this value doesn't need to be provided and will be defaulted.", "maxLength" : 5, "default" : "AO" }, "organizationSubtype" : { "type" : "string", "description" : "The organization subtype. Unless there is reason to specify otherwise, this value doesn't need to be provided and will be defaulted.", "maxLength" : 10 }, "accountNumber" : { "type" : "string", "description" : "The organization account number.", "maxLength" : 50 }, "externalCode" : { "type" : "string", "description" : "Code assigned to identify the organization to external systems.", "maxLength" : 50 }, "duns" : { "type" : "string", "description" : "The organization DUNS number.", "maxLength" : 50 }, "classification" : { "type" : "string", "description" : "The organization classification.", "maxLength" : 100 }, "public" : { "type" : "boolean", "description" : "Whether this is a public organization. Defaults to true." }, "passwordPolicy" : { "description": "The password policy associated to this particular organization.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "authenticationPolicy" : { "description": "The authentication policy associated to this particular organization.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "attributes":{ "type": "array", "minItems": 1, "description": "The extended attributes for organization.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the extended attribute." }, "name": { "type": "string", "description": "The name of the extended attribute." }, "value": { "type": "string", "description": "The value of the extended attribute." } } } } } } - extendedAttributes: | { "id" : "http://api.covisint.com/schema/extendedAttributes#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an extended attributes.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "attributes":{ "type": "array", "minItems": 0, "description": "The extended attributes for organization.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the extended attribute." }, "name": { "type": "string", "description": "The name of the extended attribute." }, "value": { "type": "string", "description": "The value of the extended attribute." } } } } } } - namedStatusResourceReference: | { "id" : "http://api.covisint.com/schema/namedStatusScopedResource", "$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/namedScopedResource#" }, "properties" : { "status" : { "description": "The status of given organization.", "type" : "string" } } } - organizationRequest: | { "id" : "http://api.covisint.com/schema/organizationRegistration", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a registration request of an organization.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignore on POST requests." }, "registrant": { "description": "The organization that is being registered. The organization must be in pending status for the request to be valid.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "justification" : { "type" : "string", "description": "The justification for the registration.", "maxLength": 1000 }, "organizationName" : { "type" : "string", "description": "The name of the organization." } } } - organizationRequests: | { "id" : "http://api.covisint.com/schema/organizationRegistration", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Schema representing a registration request of an organization.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignore on POST requests." }, "registrant": { "description": "The organization that is being registered. The organization must be in pending status for the request to be valid.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "justification" : { "type" : "string", "description": "The justification for the registration.", "maxLength": 1000 } } } - organizationRequestHistory: | { "id" : "http://api.covisint.com/schema/organizationRequestHistory", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a organization's request history.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id":{ "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignore on POST requests." }, "userId": { "type" : "string", "description": "The person registration id" }, "requestId" : { "type" : "string", "description": "The organization request id." }, "requestorUserId": { "type" : "string", "description": "The person requestor user id" }, "package": { "$ref": "http://api.covisint.com/schema/packageReference#", "description": "The user's package details" }, "descisionDate": { "type" : "integer", "description": "The decision date" }, "approveStatus": { "type" : "string", "description": "The request approve status" }, "status": { "enum" : [ "active", "suspended", "inactive", "unactivated" ], "description": "The status of request history" }, "justification": { "type" : "string", "description": "The request reason/justification." } } } - organizationStatusHistory: | { "id" : "http://api.covisint.com/schema/organizationStatusHistory", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a organization's status history.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id":{ "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignore on POST requests." }, "organizationId": { "type" : "string", "description": "The organization global covisint org id" }, "status" : { "enum" : [ "active", "suspended", "inactive", "unactivated" ], "description": "The status of the organization" }, "lastUpdatedPersonUserId": { "type" : "string", "description": "The last updated person user id" } } } - privileges: | { "id" : "http://api.covisint.com/schema/privileges#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Schema representing an privilege resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "privilegeId" : { "description" : "The id of the privilege.", "type" : "string" }, "privilegeName" : { "description" : "The name of the privilge.", "type" : "internationalString" }, "priivlegeDesc" : { "description" : "The desc of the privilege.", "type" : "internationalString" }, "privilegeGroupId" : { "description" : "The id of the privilege group.", "type" : "string" }, "privilegeGroupName" : { "description" : "The name of the privilge group.", "type" : "internationalString" }, "privilegeGroupDesc" : { "description" : "The desc of the privilege group.", "type" : "internationalString" } } } - organizationRole: | { "id" : "http://api.covisint.com/schema/organizationRole", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an invitation for a person to register.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "Id": { "description": "Role Id of the given role.", "maxLength": 15 }, "organization":{ "description" : "The organization to which the role belongs.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "rolename": { "type" : "string", "description": " name of the role assigned to user.", "maxLength": 200 }, "sharable" : { "type" : "boolean", "description": "wheather the role is sharable.", "maxLength": 1 }, "roletype" : { "type" : "integer", "description": "role type.", "maxLength": 5 }, "realmcode" : { "type" : "string", "description": " The realm in which the role is assigned.", "maxLength": 100 }, "externalRoleCode" : { "type" : "string", "description": " The external role code of the user.", "maxLength": 100 }, "immutable" : { "type" : "boolean", "description": " Is the role assigned can chnaged.", "maxLength": 1 }, "privileges":{ "description" : "The list of privileges of the roles.", "$ref": "http://api.covisint.com/schema/privileges#" } } } - organizationRoles: | { "id" : "http://api.covisint.com/schema/organizationRoles", "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/organizationRole#"} } - organizationInvitation: | { "id" : "http://api.covisint.com/schema/organizationInvitation", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an invitation for a person to register.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignored on POST requests." }, "email" : { "type" : "string", "description": "The email address that is to receive the invitation.", "maxLength": 500 }, "invitor": { "description": "The person that is sending the invitation.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "invitee": { "description": "Organization that is to be used during the registration initiated by this invitation. This is an optional way to prepopulate organization attributes at invitation time.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "targetOrganization": { "description": "The organization that the organization will join as a result of the registration initiatied by this invitation.Will not be present for a COMPANY invite.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "invitationCode" : { "type" : "string", "description": "A system-generated invitation code. This can aid in verification for systems requiring a secured invitation process.", "maxLength": 50 }, "type": { "type" : "string", "description": "COMPANY for top level organization or DIVISION for a sub organization." } } } 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 /organizations: description: "Collection endpoint for organization resources [Since:1.0]" is: [secured] get: description: "Performs a search for organization resources.[flow-name:organization-search-organizations]" headers: Accept: description: Used to request the appropriate organization resource media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.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: name: description: Retrieve organizations with the specified name. Wild card search is supported. Multiple value search is not supported. type: string required: false repeat: false parentOrganization: description: Retrieve the organizations with the specified parent organization id. type: string required: false repeat: false rootOrganization: description: Retrieve the organizations with the specified root organization id. type: string required: false repeat: false status: description: Retrieve the organizations with the specified status example. Examples {active, pending, inactive, suspended}. type: string required: false repeat: false attributes.name: description: Retrieve organizations for the supplied attributes name (wilecard search). Multiple parameters are not allowed. type: string required: false repeat: false attributes.value: description: Retrieve organizations for the supplied attributes.value and attributes name. Multiple parameters are not allowed.Search should be combination of attribute.name and attributes.value. type: string required: false repeat: false externalCode: description: Retrieve organizations for the external org code 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: All organizations that satisfy the query parameters were successfully retrieved(if flag getextendedattributes sets to true then organizations should return the extended attributes if any in the response) (response collection may be empty). body: application/vnd.com.covisint.platform.organization.v1+json: schema: organization "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:param:invalid - The following parameter should not be part of the request: {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: [secured, getSearchResponse, pagableRequest] post: description: "Create a new organization. [Since:1.0][flow-name:organization-create-organization]" headers: Accept: description: The organization media type being sent in the entity body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.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.organization.v1+json: schema: organization responses: "201": description: The organization was successfully created. body: application/vnd.com.covisint.platform.organization.v1+json: schema: organization "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 - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + organization:request:invalid:phone:type - Unsupported Phone type: {phoneType(s)} + organization:request:invalid:password:policy:type - The password policy type supplied is not valid + organization:request:invalid:authentication:policy:type - The authentication policy type supplied is not valid + framework:resource:missing - The following resources were not found: {resources} 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] /requestHistory: description: Endpoint used to get the organization request history is: [secured] /statusHistory: description: Endpoint used to get the organization status history is: [secured] /register: description: "Create a new organization in pending state. [Since:1.0]" is: [secured] post: description: "Create a new organization in pending state. [Since:1.0][flow-name:organization-create-pending-organization]" headers: Accept: description: The organization media type being sent in the entity body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.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.organization.v1+json: schema: organization responses: "201": description: The organization was successfully created in pending state. body: application/vnd.com.covisint.platform.organization.v1+json: schema: organization "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 - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + organization:request:invalid:phone:type - Unsupported Phone type: {phoneType(s)} + organization:request:invalid:password:policy:type - The password policy type supplied is not valid + organization:request:invalid:authentication:policy:type - The authentication policy type supplied is not valid + framework:resource:missing - The following resources were not found: {resources} 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] /registration/validate: description: "Endpoint for validating email address. [Since:3.0]" is: [unsecured] post: description: "Validate the email address exists.[Since:3.0][Flow-name:organization-validate-email]" headers: Accept: description: The organization media type being sent in the entity body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.v1+json Content-Type: description: The organization media type being sent in the entity body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.v1+json SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: emailAddress: description: Validates the provided email address exists. type: string required: false repeat: false responses: "201": description: Email Address for organization is not in use "404": description: | Email Address is already exists ___ + organization.account.duplicate.email-The email address :{emailAddress} is exists. 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 "400": description: | There was a problem with paramaters __ + organization:account:param:missing - parameter (emailAddress) should present. + organization.account.multiple.email.not.allowed - Multiple email addresses are not allowed. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /{id}: description: Individual resource endpoint for organization resources. uriParameters: id: description: The unique organization identifier. type: string required: true repeat: false maxLength: 36 is: [secured] get: description: "get organization by id, if flag getextendedattributes sets to true then organization should get the extended attributes. [Since:1.0][flow-name:organization-get-organization]" headers: Accept: description: The organization media type being sent in the entity body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.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 organization was successfully retrieved(if flag getextendedattributes sets to true then organization should return the extended attributes if any in the response). body: application/vnd.com.covisint.platform.organization.v1+json: schema: organization "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: [secured, getResponse] put: description: "Update an organization. [Since:1.0][flow-name:organization-update-organization]" headers: Accept: description: The organization media type being sent in the entity body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.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.organization.v1+json: schema: organization responses: "200": description: The organization was successfully updated. body: application/vnd.com.covisint.platform.organization.v1+json: schema: organization "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 - 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:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + organization:request:invalid:phone:type - Unsupported Phone type: {phoneType(s)} + framework:resource:missing - The following resources were not found: {resources} + organization:request:invalid:id - The organization with id {id} belongs to another realm 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] /move/organization/{targetOrganizationId}: description: Endpoint to move organization from one to another organization uriParameters: targetOrganizationId: displayName: targetOrganizationId type: string required: true repeat: false is: [secured] put: description: "Moves an organization.[Since:3.18][flow-name:move-organization][policy:MOVE_ORGANIZATION]" 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: "200": description: The person resource was successfully moved. body: application/vnd.com.covisint.platform.organization.v1+json: schema: organization "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + error.invalid.move.organization.status - Both target and moving organization should be active + error.invalid.target.organization - Source organization already exist under target organization + error.invalid.move.organization - Both target and source organizations cannot be same + error.invalid.root.organization - Both target and moving organization should be under same root organization + error.invalid.target.organization - Target organization must not a child of moving organization body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Resource not found. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "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 ___ Substatus codes and error messages are mentioned below: + framework:request:Forbidden - Subject does not have valid priviliges + framework:request:Forbidden - Organization is not present in subject's organization hierarchy body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [putResponse] /templates: description: The collection of organization API for extended attributes. is: [secured] put: description: "This endpoint updates an organization with set of extended attributes. First it will verify the provided extended attributes are exists. If doesn't exist then it will throw an exception. It will always updates the provided attributes with the specified values, if attributes already exists but not provided by the client then it will ignore to update those attributes. [Since:3.0][flow-name:organization-update-extended-attributes]" headers: Accept: description: Media type for organization's attribute template. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.attribute.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.organization.attribute.template.v1+json: schema: extendedAttributes responses: "200": description: The organization is successfully updated with extended attributes. body: application/vnd.com.covisint.platform.organization.attribute.template.v1+json: schema: extendedAttributes "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 + update.attribute.template.response + organization.id.does.not.exist - The organization id does not exist. + attribute.template.does.not.exist - The attribute template does not exist. + attribute.template.type - The attribute template type should be a organization type. + attributes.were.not.matched - The provided attributes were not matching with corresponding attribute template. + 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)} + person:extended:attribute:templates - The provided attributes were not matching with corresponding attribute template. + 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: "This endpoint deletes extended attributes for the organization. [Since:3.0][flow-name:organization-delete-extended-attributes]" headers: Accept: description: Media type for organization's attribute template. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.attribute.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 queryParameters: id: description: The id of the attribute. type: string required: true repeat: false body: application/vnd.com.covisint.platform.organization.attribute.template.v1+json: schema: extendedAttributes responses: "204": description: The attributes are associated with organization were successfully deleted. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + organization.does.not.exist - The organization id does not exist. + attributes.does.not.exist.for.organization - The organization doesn't have extended attributes. + attributes.does.not.associated - The attribute{s} is{are} not associated with organization + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + person:extended:attribute:templates - The provided attributes were not matching with corresponding attribute template. + 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 "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] get: description: "This endpoint gets an associated extended attribute templates for the organization. [Since:3.0][flow-name:organization-get-extended-attributes]" headers: Accept: description: Media type for organization's attribute template. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.attribute.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.organization.attribute.template.v1+json: schema: extendedAttributes responses: "200": description: The attribute templates are associated with organization were successfully retrieved. "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 + organization.doesn't.have.extended.attributes - Organization doesn't have associated with any extended attributes. + Exception.occurred.during.get- Exception occured during get organization's extended attributes. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + person:extended:attribute:templates - The provided attributes were not matching with corresponding attribute template. + 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] /hierarchy: description: hierarchy endpoint for organization resources. is: [secured] get: description: "Get organization hierarchy for the given root organization id. [Since:1.0][flow-name:organization-get-organization-hierarchy]" headers: Accept: description: The named hierarchy media type being sent back in the response entity body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.reference.hierarchy.v1+json;includedivision=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: depth: description: The depth till which the organizations has to to retrieved in the hierarchy. type: string required: false repeat: false responses: "200": description: The organization hierarchy was successfully retrieved. Returns a named resource reference to the root organization, which can be traversed to get the child organization references. body: application/vnd.com.covisint.platform.reference.hierarchy.v1+json: schema: namedStatusResourceReference "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] /parentHierarchy: description: hierarchy endpoint for child to parent organization resources. is: [secured] get: description: "Get organization hierarchy from child to its parent and so on, for the given root organization id. [Since:1.0][flow-name:organization-parent-hierarchy]" headers: Accept: description: The named hierarchy media type being sent back in the response entity body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.reference.hierarchy.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: depth: description: The depth till which the organizations has to to retrieved in the hierarchy. type: string required: false repeat: false divisionName: description: Retrieve only particular organization details from the hierarchy.If depth and divisionName both are present then it considers both and fetches the division within the depth mentioned. type: string required: false repeat: false responses: "200": description: The organization hierarchy was successfully retrieved. Returns a named resource reference to the root organization, which can be traversed to get the parent organization references. body: application/vnd.com.covisint.platform.reference.hierarchy.v1+json: schema: namedStatusResourceReference "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] /roles: description: retrieve all roles with privileges available for an organization.If flag onlyroles is set to true then should get only roles. is: [secured] /count: description: retrieve the count for all roles available for an organization. is: [secured] /tasks: /suspend: description: "suspends an organization.[Since:3.6]" is: [secured] post: description: "suspends the active organization. [flow-name:organization-task-suspend]" 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: organizationId: description: The global covisit organization Id of the organization. type: string required: true repeat: false reason: description: reason for suspending the organization. type: string required: false repeat: false responses: "204": description: The organization was successfully suspended. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:resource:state:transition:unsupported - Unsupported organization status transition from {status1} to {status2} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + organization.request.multiple.requestIds.not.allowed - Multiple requestIds are not allowed. + framework:request:invalid:header:value - Invalid x-requestor header value. 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: [taskResponse] /unsuspend: description: "unsuspend an organization.[Since:3.6]" is: [secured] post: description: "change back the organization status to active from suspend. [flow-name:organization-task-unsuspend]" 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: organizationId: description: The global covisit organization Id of the organization. type: string required: true repeat: false reason: description: reason for unsuspending the organization. type: string required: false repeat: false responses: "204": description: The organization was successfully suspended. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:resource:state:transition:unsupported - Unsupported organization status transition from {status1} to {status2} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + organization.request.multiple.requestIds.not.allowed - Multiple requestIds are not allowed. + framework:request:invalid:header:value - Invalid x-requestor header value. 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: [taskResponse] /remove: description: "removes an organization.[Since:3.6]" is: [secured] post: description: "removes the organization along with all the persons and servicepackage grants in its child hierarchy. [flow-name:organization-task-remove]" 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: organizationId: description: The global covisit organization Id of the organization. type: string required: true repeat: false reason: description: reason for removing the organization. type: string required: false repeat: false responses: "204": description: The organization was successfully removed. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:resource:state:transition:unsupported - Unsupported organization status transition from {status1} to {status2} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + organization.request.multiple.requestIds.not.allowed - Multiple requestIds are not allowed. + framework:request:invalid:header:value - Invalid x-requestor header value. 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: [taskResponse] /requests: description: Collection endpoint for organization registration request resources. is: [secured] post: description: "Creates a new organization request. [Since:3.1][flow-name:organization-create-request]" headers: Accept: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.request.v1+json;includedivision=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 body: application/vnd.com.covisint.platform.organization.request.v1+json: schema: organizationRequest responses: "201": description: A new organization registration was created and is returned in the response body. body: application/vnd.com.covisint.platform.organization.request.v1+json: schema: organizationRequest "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} 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] get: description: "Searches organization request resources according to the filter criteria provided.[Since:1.0][flow-name:organization-search-request]" headers: Accept: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.request.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: organization.id: description: Retrieve organization request for a supplied organization identifier. Multiple values may be provided, in which case all found ids will be returned. type: string required: false repeat: false registrant.id: description: Retrieve organization request for a supplied registrant identifier. Multiple values may be provided, in which case all found ids will be returned. The registrant here is the user who is trying to register on behalf of the organization. type: string required: false repeat: false organizationName: description: Retrieve organization request for a supplied organization name. Wild card search is supported. Multi value search not supported. type: string required: false repeat: false responses: "200": description: The organization requests were successfully retrieved. body: application/vnd.com.covisint.platform.person.v1+json: schema: organizationRequests "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "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] /{requestId}: description: Endpoint for an individual organization request. uriParameters: requestId: description: Unique identifier of the organization request type: string required: true repeat: false maxLength: 36 is: [secured] get: description: "Returns a organization request by id. [Since:1.0][Flow-name:organization-get-request]" headers: Accept: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.request.v1+json SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c 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 organization request was successfully retrieved. body: application/vnd.com.covisint.platform.organization.request.v1+json: schema: organizationRequest "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 "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 - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "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, unsecured] delete: description: "Deletes a organization request. [Since:1.0][flow-name:organization-delete-request]" 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 organization request was successfully deleted. "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 - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "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: /deny: description: "Deny an organization request.[Since:2.0]" is: [secured] post: description: "Deny an organization request, while denying the organization request, it has to deny the security admin request, service package request and exchange service package request. [flow-name:organization-task-deny-request]" 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: requestId: description: The unique identifier of the organization request. type: string required: true repeat: false responses: "204": description: The request was successfully denied. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:resource:state:transition:unsupported - Unsupported person status transition from {status1} to {status2} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + organization.request.multiple.requestIds.not.allowed - Multiple requestIds are not allowed. + 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 "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: [taskResponse] /approve: description: "Approve an organization request.[Since:2.0]" is: [secured] post: description: "Approve an organization request, while approving the organization request, it will approve the security admin request, service package request, exchange service package request and service package requests. [flow-name:organization-task-approve-request]" 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: requestId: description: The unique identifier of the organization request. type: string required: true repeat: false body: application/vnd.com.covisint.platform.organization.request.v1+json: schema: organizationRequest responses: "204": description: The organization registration request was successfully approved. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:resource:state:transition:unsupported - Unsupported person status transition from {status1} to {status2} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + organization.request.multiple.requestIds.not.allowed - Multiple requestIds are not allowed. + 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 "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: [taskResponse] /organizationInvitations: /company: description: Organization Invite for Top Company. is: [secured] post: description: "Creates a new Organization Invitation for top-company.[Since:3.1][flow-name:organization-create-topcompanyinvitation]" headers: Accept: description: Media type for person invitation. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.invitation.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.organization.invitation.v1+json: schema: organizationInvitation responses: "201": description: A new organization invitation for the top company was created and is returned in the response body. body: application/vnd.com.covisint.platform.organization.invitation.v1+json: schema: organizationInvitation "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 - 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)} + person.invitation.invalid.emailIdFormat - Invalid email id format {emailId} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} 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: [taskResponse] /division: description: Organization Invite for the Division. is: [secured] post: description: "Creates a new Organization Invitation for the division.[Since:3.1][flow-name:organization-create-divisioninvitation]" headers: Accept: description: Media type for person invitation. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.invitation.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.organization.invitation.v1+json: schema: organizationInvitation responses: "201": description: A new organization invitation for the top company was created and is returned in the response body. body: application/vnd.com.covisint.platform.organization.invitation.v1+json: schema: organizationInvitation "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 - 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)} + person.invitation.invalid.emailIdFormat - Invalid email id format {emailId} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} "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: [taskResponse] /{id}: description: Endpoint for Organization invitation. uriParameters: # invitationId: # description: Unique identifier of the organization invitation. # type: string # required: true # repeat: false id: displayName: id type: string required: true repeat: false is: [secured] get: description: "Returns the organization invitation details by id. [Since:3.11][flow-name:organization-get-organizationinvitation]" headers: Accept: description: Media type for organization invitation. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.invitation.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 organization invitation was successfully retrieved body: application/vnd.com.covisint.platform.organization.invitation.v1+json: schema: organizationInvitation "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} 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: [secured, getResponse] delete: description: "Deletes a organization invitation. [Since:3.11][flow-name:organization-delete-organizationinvitation]" headers: SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c 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 organization invitation was successfully deleted. "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:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "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: [unsecured, deleteResponse]