#%RAML 0.8 title: Service API baseUri: "https://api.covisintlabs.com/service/v3" protocols: [HTTPS] schemas: - resourceReferences: | { "id" : "http://api.covisint.com/schema/resourceReferences", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Collection of broadcast templates", "type" : "array", "items" : { "$ref": "http://api.covisint.com/schema/resourceReference#" } } - 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#"} } - 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.", "required": true }, { "type": "string", "description": "The value of the property.", "required": true } ] } ] } }, "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":["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"] } - service: | { "id" : "http://api.covisint.com/schema/service", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a service resource.", "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 ignore for POST requests. User supplied value will be ignored and will be set to the creation value." }, "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized service descriptions. The description will be defaulted to the service name, if it is not provided for a language for which the service name is given.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "parentService": { "description": "The parent service. Used to create a service hierarchy.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "category" : { "description": "Internationalized category names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "owningOrganization": { "description": "The organization that owns this service.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "urls": { "type": "array", "minItems": 1, "description": "A listing of all URLs defined for this service, by type.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The URL type.", "maxLength": 100 }, "value": { "type": "string", "description": "The URL value.", "maxLength": 4000 } } } }, "remoteAppId": { "type": "string", "description": "Links this service to a remote application known to the client.", "maxLength": 500 }, "mobileServiceId": { "type": "string", "description": "Mobile service id.", "maxLength": 200 }, "federationConnectionWizard": { "type": "string", "maxLength": 255, "description": "Location of the federation connection set-up wizard. e.g. salesforce, unauthenticated website, etc." }, "protected": { "type": "boolean", "description": "Indicates whether this service is synced back to cleartrust entitlements server, and therefore protected by the ct web agent." }, "messagingEnabled": { "type": "boolean", "description": "Indicates whether to perform messaging when this service is updated." }, "mangledUrl": { "type": "string", "description": " The mangled/federated url of the service." }, "iconUrl": { "type": "string", "description": " The icon url of the service." } } } - packageGrant: | { "id" : "http://api.covisint.com/schema/packageGrant", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "type" : "object", "description" : "Representation of a package grant.", "properties" : { "id": { "description": "reason for granting package." }, "version": { "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. User supplied value will be ignored and will be set to the creation value." }, "status" : { "type" : "string", "enum" : [ "active", "suspended", "unactivated" ], "description" : "The status of the grant. Only required when grant is retrieved. Not required when grant is created." }, "grantee": { "description": "The subject owning the grant", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackage": { "description": "The granted package.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "reason": { "type": "string", "description": "reason for granting package.", "maxLength" : 100 }, "disableAutoGrant": { "type": "string", "description": "This is a boolean flag represented by string which determines if the organization should cascade package to its users." }, "requestId": { "type": "string", "description": " The request id will be returned in the response in case of granting N phase enabled package." }, "servicePackageResource": { "description": "The password account associated with the person.", "type" : "object", "properties" : { "id" : { "type" : "string", "maxLength" : 100, "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 }, "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available" }, "owningOrganization": { "description": "The organization that owns this package.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "parent": { "description": "The parent package. Used to create a package hierarchy.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "codeRestrictions": { "type": "object", "description": "Indicates whether site/location code(s) must be specified when requesting/granting this package.", "properties": { "requestorType": { "type": "string", "enum": [ "person", "organization" ] }, "restriction": { "type": "string", "enum": [ "site", "location" ] } } }, "termsAndConditions": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "person", "organization" ], "description": "The target entity of the terms and conditions." }, "tacId": { "type": "string", "description": "The identifier of the T&C record.", "maxLength": 15 } } } }, "protected": { "type": "boolean", "description": "Indicates whether this package is synced back to cleartrust entitlements server, and therefore protected by the ct web agent.", "default" : false }, "requestable": { "type": "boolean", "description": "Indicates whether this package may be requested by persons or organizations.", "default" : false }, "grantable": { "type": "boolean", "description": "Indicates whether this package may be granted to persons or organizations.", "default" : true }, "displayable": { "type": "boolean", "description": "Indicates whether this package may be displayed or should be suppressed in UIs.", "default" : true }, "requestReasonRequired": { "type": "boolean", "description": "Indicates whether package requests must be accompanied by a reason supplied by the requestor.", "default" : false }, "name" : { "description": "Internationalized package names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized package descriptions.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "category" : { "description": "Internationalized category names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "requiredApprovals" : { "type" : "array", "description": "List of approval actors required to make decisions on package requests before it can be granted. Defaults to organizationAdmin if no values are provided.", "minItems": 0, "items": { "enum" : [ "organizationAdmin", "applicationAdmin", "provisioningAdmin" ] }, "default" : "organizationAdmin" } } } } } - packageGrantHistory: | { "id" : "http://api.covisint.com/schema/packageGrantHistory", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "type" : "array", "description" : "Representation of a package grant.", "properties" : { "id": { "description" : "ID." }, "version": { "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. User supplied value will be ignored and will be set to the creation value." }, "status" : { "type" : "string", "enum" : [ "active", "suspended", "unactivated" ], "description" : "The status of the grant. Only required when grant is retrieved. Not required when grant is created." }, "servicePackage": { "description": "The granted package.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "eventDate": { "type": "number", "description": "The event date." }, "eventType": { "type": "integer", "description": "The event type." } } } - applicationGrantHistory: | { "id" : "http://api.covisint.com/schema/applicationGrantHistory", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "type" : "object", "description" : "Representation of a application grant history.", "properties" : { "status" : { "type" : "string", "enum" : [ "active", "suspended", "unactivated" ], "description" : "The status of the grant. Only required when grant is retrieved. Not required when grant is created." }, "serviceId": { "type": "string", "description": "The service id ." }, "packageId": { "type": "string", "description": "The global covisint id of the package." }, "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "packageName" : { "description": "Internationalized package names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "eventDate": { "type": "string", "description": "The event date in the format (dd-MMM-yyyy) of UTC time zone" }, "eventType": { "type": "string", "description": "The event type." }, "actor": { "type": "string", "description": "The global covisint id of the person who took the decision." }, "grantReason": { "type": "string", "description": "The reason for which it is granted." }, "systemEventType": { "type": "string", "description": "The system event type." }, "notes": { "type": "string", "description": "The reason for which it is granted." }, "additionalInfo": { "type": "string", "description": "The reason for which it is granted.", "maxLength": 200 } } } - applicationRequest: | { "id" : "http://api.covisint.com/schema/applicationRequest", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "type" : "object", "description" : "Representation of a application request.", "properties" : { "requestor" : { "description": "The requestor of the application.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "requestType" : { "type" : "string", "enum" : [ "Request for Company Access", "Request for User Access", "Request for Company Removal", "Request for User Removal", "Request for Company Access to a Service", "Request for User Access to a Service", "Request for modification to a company's list of service codes", "Request for modification to a user's list of service codes", "Request for a change of SAO", "Request to migrate to company as a CSA for a service", "Request to move the user to a different org", "Request for Role", "Change User Attributes", "Request for New Managed Identity and Rehire", "Request for User's Request Status", "Request for User Association", "Request for Managed Identity Move", "Unknown Request Type" ], "description" : "The request type of the history." }, "serviceId": { "type": "string", "description": "The service id." }, "packageId": { "type": "string", "description": "The global covisint id of the package." }, "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "packageName" : { "description": "Internationalized package names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "requestedDate": { "type": "string", "description": "The requested date in the format (dd-MMM-yyyy) of UTC time zone" }, "currentPhase" : { "type" : "string", "enum" : [ "Pending Security admin approval", "Pending Application admin approval", "Org app request admin approval Phase" ], "description" : "The current approval phase of the request." }, "reason": { "type": "string", "description": "The reason for requesting application." } } } - applicationRequestHistory: | { "id" : "http://api.covisint.com/schema/applicationRequestHistory", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "type" : "object", "description" : "Representation of a application request history.", "properties" : { "requestor" : { "description": "The requestor of the application.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "requestType" : { "type" : "string", "enum" : [ "Request for Company Access", "Request for User Access", "Request for Company Removal", "Request for User Removal", "Request for Company Access to a Service", "Request for User Access to a Service", "Request for modification to a company's list of service codes", "Request for modification to a user's list of service codes", "Request for a change of SAO", "Request to migrate to company as a CSA for a service", "Request to move the user to a different org", "Request for Role", "Change User Attributes", "Request for New Managed Identity and Rehire", "Request for User's Request Status", "Request for User Association", "Request for Managed Identity Move", "Unknown Request Type" ], "description" : "The request type of the history." }, "serviceId": { "type": "string", "description": "The service id." }, "packageId": { "type": "string", "description": "The global covisint id of the package." }, "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "packageName" : { "description": "Internationalized package names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "requestedDate": { "type": "string", "description": "The requested date in the format (dd-MMM-yyyy) of UTC time zone" }, "evaluationDate": { "type": "string", "description": "The evaluation date in the format (dd-MMM-yyyy) of UTC time zone" }, "evaluator": { "type": "string", "description": "The global covisint id of the person who took the decision." }, "isApproved" : { "type" : "boolean", "description": "The flag to notify the application is approved." }, "requiredApprovals" : { "type" : "array", "description": "List of approval actors required to make decisions on package requests before it can be granted. Defaults to organizationAdmin if no values are provided.", "minItems": 0, "items": { "enum" : [ "organizationAdmin", "applicationAdmin", "provisioningAdmin" ] }, "default" : "organizationAdmin" } } } - packageRequest: | { "id" : "http://api.covisint.com/schema/packageRequest", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a package request resource.", "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 should not be supplied for POST requests. User supplied value will be ignored and will be set to the creation value." }, "requestor": { "description": "The subject for which this request is being made", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackage": { "description": "The package being requested.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "reason": { "type": "string", "description": "The justification for the request.", "maxLength": 1000 }, "prerequisite": { "description": "The parent request, if applicable.", "extends": { "$ref": "http://api.covisint.com/schema/resourceReference#" } }, "phase": { "type": "string", "enum": [ "Pending Security admin approval", "Pending Application admin approval" ] }, "packageClaims":{ "type": "array", "description": "The array of package claims.", "$ref" : "http://api.covisint.com/schema/packageClaim#" }, "servicePackageClaim": { "description": "The package claim being requested.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackageClaimValue": { "description": "The package claim value being requested.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "claimRequests": { "type": "array", "description": "The claim requests associated with a service package request", "requestId": "The request identifier for claim", "extends": { "$ref": "http://api.covisint.com/schema/resourceReference#" } }, "claimValueRequests": { "type": "array", "description": "The claim value requests associated with claim", "requestId": "The request identifier for claim value", "extends": { "$ref": "http://api.covisint.com/schema/resourceReference#" } }, "type": { "type" : "string", "enum" : ["servicePackage", "servicePackageClaim", "servicePackageClaimValue"] } } } - package: | { "id" : "http://api.covisint.com/schema/package", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a package 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, but should not be supplied for POST requests. User supplied value will be ignored and will be set to the creation value." }, "owningOrganization": { "description": "The organization that owns this package.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "parent": { "description": "The parent package. Used to create a package hierarchy.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "codeRestrictions": { "type": "object", "description": "Indicates whether site/location code(s) must be specified when requesting/granting this package.", "properties": { "requestorType": { "type": "string", "enum": [ "person", "organization" ] }, "restriction": { "type": "string", "enum": [ "site", "location" ] } } }, "termsAndConditions": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "person", "organization" ], "description": "The target entity of the terms and conditions." }, "tacId": { "type": "string", "description": "The identifier of the T&C record.", "maxLength": 15 } } } }, "protected": { "type": "boolean", "description": "Indicates whether this package is synced back to cleartrust entitlements server, and therefore protected by the ct web agent.", "default" : false }, "requestable": { "type": "boolean", "description": "Indicates whether this package may be requested by persons or organizations.", "default" : false }, "grantable": { "type": "boolean", "description": "Indicates whether this package may be granted to persons or organizations.", "default" : true }, "displayable": { "type": "boolean", "description": "Indicates whether this package may be displayed or should be suppressed in UIs.", "default" : true }, "requestReasonRequired": { "type": "boolean", "description": "Indicates whether package requests must be accompanied by a reason supplied by the requestor.", "default" : false }, "cascadeEnabled": { "type": "boolean", "description": "Indicates whether package must be cascaded among child organizations when parent is granted.", "default" : false }, "name" : { "description": "Internationalized package names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized package descriptions.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "targetUrl" : { "description": "The default url which should be added to default service.", "type" : "string" }, "category" : { "description": "Internationalized category names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "parentService": { "description": "The parent service. Used to create a service hierarchy.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "requiredApprovals" : { "type" : "array", "description": "List of approval actors required to make decisions on package requests before it can be granted. Defaults to organizationAdmin if no values are provided.", "minItems": 0, "items": { "enum" : [ "organizationAdmin", "applicationAdmin", "provisioningAdmin" ] }, "default" : "organizationAdmin" }, "personTacEnabled" : { "type" : "boolean", "description" : "Flag to notify the package's terms and condition pertinent to person is enabled, read only", "default" : "false" }, "organizationTacEnabled" : { "type" : "boolean", "description" : "Flag to notify the package's terms and condition pertinent to person is organization", "default" : "false" } } } - packageClaim: | { "id" : "http://api.covisint.com/schema/packageClaim", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of a package claim.", "properties" : { "id": { "type": "string", "description": "The id of the package claim." }, "claimId": { "type": "string", "description": "The user given id of the package claim." }, "cardinalityIndicator": { "type": "string", "description": "Cardinality Indicator of the given claim" }, "name":{ "description": "Internationalized package claim names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description":{ "description": "Internationalized package claim descriptions.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "claimValues":{ "type": "array", "description": "The array of claim values.", "minItems": 1, "$ref" : "http://api.covisint.com/schema/packageClaimValue#" } } } - packageClaimValue: | { "id" : "http://api.covisint.com/schema/packageClaimValue", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of a package claim value.", "properties":{ "id": { "type": "string", "description": "The id of the package claim value." }, "claimValueId": { "type": "string", "description": "The user given id of the package claim value." }, "name":{ "description": "Internationalized package claim value names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description":{ "description": "Internationalized package claim value descriptions.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" } } } - packageClaimRequest: | { "id" : "http://api.covisint.com/schema/packageClaimRequest", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of a package claim request.", "properties" : { "claimId": { "type": "string", "description": "The user given id of the package claim." }, "claimValues":{ "type": "array", "description": "The array of claim value unique identifiers.", "minItems": 1, "items": { "type": "object", "properties": { "claimValueId": { "type": "string", "description": "The user given id of the package claim value." } } } } } } - grantStatusChangeRequest: | { "id" : "http://api.covisint.com/schema/grantStatusChangeRequest", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "type" : "object", "description" : "Representation of a suspend/unsuspend package grant for user.", "properties" : { "grantee": { "description": " The user id of grantee", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackage": { "description": "The granted package.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "justification":{ "type": "string", "description": "The justification reason." } } } - packageGrantClaimRequest: | { "id" : "http://api.covisint.com/schema/packageGrantRequest", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "type" : "object", "description" : "Representation of a package grant claim request.", "properties" : { "grantee": { "description": "The subject owning the grant claim", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackage": { "description": "The granted package.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "packageClaims":{ "type": "array", "description": "The array of package claim requests.", "$ref" : "http://api.covisint.com/schema/packageClaimRequest#" }, "requestId": { "type": "string", "description": "The request id if it is configured for 2 phase." } } } - packageGrantClaimResponse: | { "id" : "http://api.covisint.com/schema/packageGrantRequest", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "type" : "object", "description" : "Representation of a package grant.", "properties" : { "grantee": { "description": "The subject owning the grant", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackage": { "description": "The granted package.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "packageClaims":{ "type": "array", "description": "The array of package claims.", "$ref" : "http://api.covisint.com/schema/packageClaim#" } } } - minimalApplication: | { "id" : "http://api.covisint.com/schema/minimalApplication", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a minimal application resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 15, "description" : "The unique identifier for this resource." }, "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "packageId": { "type": "string", "description": "The package id in which the app belongs to.", "maxLength": 100 } } } - applicationGrant: | { "id" : "http://api.covisint.com/schema/applicationGrant", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a application grant resource.", "properties" : { "status" : { "type" : "string", "enum" : [ "active", "suspended", "unactivated" ], "description" : "The status of the grant." }, "grantee" : { "type" : "string", "description" : "The id of the grantee." }, "instant" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The granted instant, in milliseconds since the epoch, when this resource was created." } } } - application: | { "id" : "http://api.covisint.com/schema/application", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a application resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id" : { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. " }, "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized service descriptions. The description will be defaulted to the service name, if it is not provided for a language for which the service name is given.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "parentService": { "description": "The parent service. Used to create a service hierarchy.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "category" : { "description": "Internationalized category names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "owningOrganization": { "description": "The organization that owns this service.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "urls": { "type": "array", "minItems": 1, "description": "A listing of all URLs defined for this service, by type.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The URL type.", "maxLength": 100 }, "value": { "type": "string", "description": "The URL value.", "maxLength": 4000 } } } }, "remoteAppId": { "type": "string", "description": "Links this service to a remote application known to the client.", "maxLength": 500 }, "mobileServiceId": { "type": "string", "description": "Mobile service id.", "maxLength": 200 }, "federationConnectionWizard": { "type": "string", "maxLength": 255, "description": "Location of the federation connection set-up wizard. e.g. salesforce, unauthenticated website, etc." }, "protected": { "type": "boolean", "description": "Indicates whether this service is synced back to cleartrust entitlements server, and therefore protected by the ct web agent." }, "messagingEnabled": { "type": "boolean", "description": "Indicates whether to perform messaging when this service is updated." }, "mangledUrl": { "type": "string", "description": " The mangled/federated url of the service." }, "iconUrl": { "type": "string", "description": " The icon url of the service." }, "servicePackage": { "description": "The package this service belongs to.", "$ref": "http://api.covisint.com/schema/package#" }, "bundledApps":{ "type": "array", "description": "The array of bundled applications. Bundled applications are apps that are present in the app's package.", "$ref" : "http://api.covisint.com/schema/minimalApplication#" }, "relatedApps":{ "type": "array", "description": "The array of related applications. Related applications are apps that are present in the parent or sub packages and if they are fast reg enabled.", "$ref" : "http://api.covisint.com/schema/minimalApplication#" }, "grant": { "description": "The details of the grant.", "$ref": "http://api.covisint.com/schema/applicationGrant#" } } } - categoryType: | { "id" : "http://api.covisint.com/schema/categoryType", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a category type resource.", "properties" : { "id" : { "type": "string", "description": "The id of the category type." }, "defaultName" : { "type": "string", "description": "The default name of the category type." }, "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" } } } - category: | { "id" : "http://api.covisint.com/schema/category", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a category resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "type": { "description": "The type to which the category belongs to.", "$ref": "http://api.covisint.com/schema/categoryType#" } } } - termsAndCondition: | { "id" : "http://api.covisint.com/schema/tac", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a terms and condition resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "isLatest" : { "type" : "boolean", "description": "The flag to notify the package's terms and condition is latest." }, "isReAcceptanceRequired" : { "type" : "boolean", "description": "The flag to notify the package's terms and condition is re-acceptance required." }, "tacText" : { "type" : "string", "description": "The Text of the package's terms and condition." }, "type" : { "type" : "string", "description": "The type of the package's terms and condition." }, "language" : { "type" : "string", "description": "The language of the package's terms and condition." }, "preTermsAndCondition" : { "description": "The parent terms and condition.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackage" : { "description": "The package of the terms and condition which belong to.", "$ref": "http://api.covisint.com/schema/resourceReference#" } } } - multiPackagesPersonGrantRequest: | { "id" : "http://api.covisint.com/schema/multiPackagesPersonGrantRequest", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of a multiple packages grant request of person.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "grantee": { "description": "The subject owning the grant", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackages": { "type" : "object", "properties": { "id": { "type": "array", "minItems": 1, "description": "List of package ids to be granted." } } }, "reason": { "type": "string", "description": "reason for granting package.", "maxLength" : 100 } } } - resourceAdmin: | { "id" : "http://api.covisint.com/schema/resourceAdmin", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of a Resource Admin.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "admins": { "type":"array", "minItems": 0, "description": "The administrators identifiers to be added or removed" }, "packageId": { "type" : "string", "description":"The package identifier" } } } - multiPackagesGrantResponse: | { "id" : "http://api.covisint.com/schema/multiPackagesGrantResponse", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of a multiple packages grant/revoke response of person.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "status" : { "type" : "string", "enum" : [ "SUCCESS", "FAILED", "PARTIAL" ], "description" : "The status of the grant/revoke." }, "errors": { "type" : "array", "description": "List of packages which are failed to grant/revoke.", "minItems" : 1, "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the package which is failed to grant/revoke."}, "errorMessage": { "type": "string", "description": "Error details of grant/revoke."} } } } } } - person: | { "id" : "http://api.covisint.com/idm/schema/person/v1", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a person 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, but will be ignore on POST requests." }, "status" : { "enum" : [ "pending", "rejected", "active", "suspended", "inactive", "locked", "expired", "unactivated", "preterminated" ], "description" : "The person's account status, which is read-only. Statuses can be changed through tasks." }, "name" : { "type" : "object", "description" : "A container for the person's name elements", "properties" : { "prefix" : { "type" : "string", "description" : "The prefix to the person's name. For example: Mr., Mrs., Rev.", "maxLength" : 100 }, "given" : { "type" : "string", "description" : "The person's given (first) name.", "maxLength" : 150 }, "middle": { "type" : "string", "description" : "The person's middle name(s).", "maxLength" : 60 }, "surname": { "type" : "string", "description" : "The person's surname or family name.", "maxLength" : 150 }, "suffix" : { "type" : "string", "description" : "The person's name suffix. For example: Jr., Ph.D., M.D.", "maxLength" : 50 } }, "required" : [ "given", "surname"] }, "username" : { "type" : "string", "maxLength" : 100, "description" : "The username of the person." }, "authDomain" : { "type" : "string", "description" : "The person's authentication domain.", "maxLength" : 50 }, "lastlogindate" : { "type" : "number", "description" : "The person's last Login Date.", "maxLength" : 50 }, "addresses" : { "type" : "array", "description" : "A container for the person's addresses.", "minItems" : 0, "items" : { "ref" : "http://api.covisint.com/idm/schema//address#" } }, "language" : { "type" : "string", "maxLength" : 2, "description" : "The person's preferred language, in ISO639-1 format." }, "timezone" : { "type" : "string", "description" : "The person's preferred timezone. See http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html#getAvailableIDs()" }, "phones" : { "type" : "array", "description" : "A container for the person's phone number(s).", "minItems" : 0, "items" : { "$ref" : "http://api.covisint.com/idm/schema/phone#" } }, "title" : { "type" : "string", "maxLength" : 60, "description" : "The person's job title" }, "email" : { "type" : "string", "maxLength" : 1000, "description" : "The person's email address." }, "organization" : { "description" : "The organization to which the person belongs.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "currency" : { "type" : "string", "maxLength" : 3, "description" : "The person's preferred currency. Must be a valid ISO4217 currency code." }, "externalId" : { "type" : "string", "maxLength" : 100, "description" : "The person's external Id." }, "attributes":{ "type": "array", "minItems": 0, "description": "The attribute templates for persons.", "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." } } } } }, "required" : [ "language", "timezone","email","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 /services: description: collection endpoint for service resources. is: [secured] get: description: "Performs a search for service resources.[Since:1.0][Flow-name:service-search-services]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.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: Filter the search results by the given id. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false name: description: Retrieve only services with the specified name. The search is case-insensitive and is performed across all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false description: description: Retrieve only services with the specified description. The search is case-insensitive and is performed across all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false category: description: Retrieve only services assigned to a specific category. The search is case-insensitive and is performed across all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false parentService.id: description: Retrieve services that are children of the given parent service id. Multiple parameters are supported in which case retrieval of children services of all specified parent services will be performed. Note that this only includes immediate children, and not grandchildren or deeper. type: string required: false repeat: false owningOrganization.id: description: Retrieve services that are owned by the given organization id. Multiple parameters are supported to allow retrieving services of multiple organizations at one time. type: string required: false repeat: false remoteAppId: description: Filter the search results by the given remote application id. type: string required: false repeat: false mobileServiceId: description: Filter the search results by given mobile service id. type: string required: false repeat: false sortBy: description: Sort the search results. Currently creation is the only sortable property. type: string required: false repeat: false enum: [+creation, "-creation"] 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 services that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.v1+json: schema: service "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} + search.services.request.invalid.combination.queryParamaters - Multiple {queryParameter} 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 "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] post: description: "Creates a new service.[Since:1.0][Flow-name:service-create-service]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.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.service.v1+json: schema: service responses: "201": description: The service was successfully created body: application/vnd.com.covisint.platform.service.v1+json: schema: service "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework: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] /{id}: description: individual resource endpoint for service resources. uriParameters: id: description: Unique identifier of the service. type: string required: true repeat: false is: [secured] get: description: "Returns the service by its unique id.[Since:1.0][Flow-name:service-get-service]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.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 service was successfully retrieved. body: application/vnd.com.covisint.platform.service.v1+json: schema: service "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] /packages: description: collection endpoint for package resources is: [secured] get: description: "Performs a search for packages. [Since:1.0][Flow-name:service-search-packages]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.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: id: description: Filter the search results by the given id. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false name: description: Retrieve only packages with the specified name. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false claimId: description: Retrieve only packages with the specified claimId. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false claimValueId: description: Retrieve only packages with the specified claimValueId. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false description: description: Retrieve only packages with the specified description. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false category: description: Retrieve only packages assigned to the given category. The search is case-insensitve. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false parentService.id: description: Retrieve services that are children of the given parent service id. Multiple parameters are supported in which case retrieval of children services of all specified parent services will be performed. Note that this only includes immediate children, and not grandchildren or deeper. type: string required: false repeat: false owningOrganization.id: description: Return all packages owned by the given organization id. Multiple parameters are supported, which will return packages that are owned by any of the given organizations. type: string required: false repeat: false parentPackage.id: description: Return all children packages of the given parent package. Multiple parameters are supported, which will return child packages of all given parent packages. type: string required: false repeat: false grantable: description: Return all packages that are flagged as grantable. type: boolean required: false repeat: false requestable: description: Return all packages that are flagged as requestable. type: boolean required: false repeat: false sortBy: description: Sort the search results according to creation timestamp property. type: string required: false repeat: false enum: [+creation, "-creation"] 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 packages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.v1+json: schema: package "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + search.packages.request.invalid.combination.queryParamaters - Multiple {queryParameter} are not allowed. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] post: description: "Creates a new service package with a default service. [Since:1.0][Flow-name:service-create-package]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.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.package.v1+json: schema: package responses: "201": description: The package was successfully created body: application/vnd.com.covisint.platform.package.v1+json: schema: package "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:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + add.service.package.invalid.terms.conditions.type - Invalid type. Valid values are PERSON, ORGANIZATION + add.service.package.invalid.code.restriction.type - Invalid type. Valid values are PERSON, ORGANIZATION + add.service.package.invalid.code.restriction - Invalid restriction. Valid values are SITE, LOCATION body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /count: description: "Count endpoint for packages [Since:2.0]" get: description: "Returns the count of packagess.[Flow-name:service-count-package]" headers: Accept: description: Used to request the appropriate package resource media type. type: string required: true repeat: false example: text/plain queryParameters: id: description: Filter the search results by the given id. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false name: description: Retrieve only packages with the specified name. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false description: description: Retrieve only packages with the specified description. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false category: description: Retrieve only packages assigned to the given category. The search is case-insensitve. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false owningOrganization.id: description: Return all packages owned by the given organization id. Multiple parameters are supported, which will return packages that are owned by any of the given organizations. type: string required: false repeat: false parentPackage.id: description: Return all children packages of the given parent package. Multiple parameters are supported, which will return child packages of all given parent packages. type: string required: false repeat: false grantable: description: Return all packages that are flagged as grantable. type: boolean required: false repeat: false requestable: description: Return all packages that are flagged as requestable. type: boolean required: false repeat: false responses: "200": description: The total number of packages successfully retrieved (response collection may be empty). body: application/text: "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 /{packageId}: description: individual resource endpoint for packages. uriParameters: packageId: description: Unique identifier of the package type: string required: true repeat: false is: [secured] get: description: "Returns the package by its id. [Since:1.0][Flow-name:service-get-package]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.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 package was successfully retrieved body: application/vnd.com.covisint.platform.package.v1+json: schema: package "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] put: description: "Update a service package. [Since:3.14][Flow-name:service-update-package]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.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.package.v1+json: schema: package responses: "200": description: The package resource was successfully updated body: application/vnd.com.covisint.platform.package.v1+json: schema: package "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: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 "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: "Deletes an service package with id.[Since:3.17][Flow-name:service-delete-package]" 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 service package was successfully deleted. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "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] /persons/tacs: description: collection endpoint for package's terms and condition resources pertinent to person. is: [unsecured] get: description: "Performs a search for package's terms and condition resources pertinent to person.[Since:3.1][Flow-Name:service-search-terms-and-condition-person]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The package's terms and condition pertinent to person returns successfully. body: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json: schema: termsAndCondition "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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /languages/{languageId}: description: individual resource endpoint for package's terms and condition pertinent to person by language. uriParameters: languageId: description: The language of the package's terms and condition pertinent to person. type: string required: true repeat: false is: [unsecured] get: description: "Performs a search for package's terms and condition resources pertinent to person by language.[Since:3.1][Flow-Name:service-search-terms-and-condition-person-by-language]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The package's terms and condition pertinent to person by language returns successfully. body: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json: schema: termsAndCondition "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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /persons/{cuid}/tacs/{tacId}/{tacVersion}/accept: description: Endpoint to accept the terms and conditions for the given user. uriParameters: cuid: displayName: cuid type: string required: true repeat: false tacId: displayName: tacId type: string required: true repeat: false tacVersion: displayName: tacVersion type: string required: true repeat: false is: [secured] post: description: "Endpoint to accept the terms and conditions for the given user.[Since:3.15][Flow-name:service-accept-terms-and-conditions-person]" 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: Terms and conditions are accepted successfully. "400": description: There was a problem with the client's request. 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] /persons/{cuid}/tacs/{tacId}/{tacVersion}/decline: description: Endpoint to decline the terms and conditions for the given user. uriParameters: cuid: displayName: cuid type: string required: true repeat: false tacId: displayName: tacId type: string required: true repeat: false tacVersion: displayName: tacVersion type: string required: true repeat: false is: [secured] post: description: "Endpoint to decline the terms and conditions for the given user.[Since:3.15][Flow-name:service-decline-terms-and-conditions-person]" 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: Terms and conditions are declined successfully. "400": description: There was a problem with the client's request. 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] /organizations/tacs: description: collection endpoint for package's terms and condition resources pertinent to organization. is: [unsecured] get: description: "Performs a search for package's terms and condition resources pertinent to organization.[Since:3.1][Flow-Name:service-search-terms-and-condition-organization]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The package's terms and condition pertinent to organization returns successfully. body: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json: schema: termsAndCondition "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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /languages/{languageId}: description: individual resource endpoint for package's terms and condition pertinent to organization by language. uriParameters: languageId: description: The language of the package's terms and condition pertinent to organization. type: string required: true repeat: false is: [unsecured] get: description: "Performs a search for package's terms and condition resources pertinent to organization by language.[Since:3.1][Flow-Name:service-search-terms-and-condition-organization-by-language]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The package's terms and condition pertinent to organization by language returns successfully. body: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json: schema: termsAndCondition "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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /services: description: collection endpoints for the services that are members of this package. is: [secured] get: description: "get the services that are members of this package.[Since:1.0][Flow-name:service-search-package-services]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.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 member services were successfully retrieved. body: application/vnd.com.covisint.platform.service.v1+json: schema: service "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] /{serviceId}: description: "individual resource endpoint for service package association.[Since:3.1][Flow-name:services-get-by-serviceId]" uriParameters: serviceId: description: Unique identifier of the associated service. type: string required: true repeat: false is: [secured] get: description: "Returns the service associated with the package. [Since:3.0][Flow-name:service-search-package-service]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.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 service was successfully retrieved body: application/vnd.com.covisint.platform.service.v1+json: schema: service "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] + service.package.missing.association - The service is not associated to the package 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] /persons: description: endpoint to fetch admins for a package. is: [secured] get: description: "retrieve admins for an existing package.[Since:1.0][Flow-name:retrieve-package-admin]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/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 users were successfully retrieved. body: application/text: "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] /admins/{adminType}: description: endpoint to fetch admins for a package. uriParameters: adminType: displayName: adminType type: string required: true repeat: false is: [secured] get: description: "retrieve admins for an existing package.[Since:3.17.0][Flow-name:retrieve-service-package-admin]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/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 users were successfully retrieved. body: application/vnd.com.covisint.platform.person.v1+json: schema: person "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] /admin: description: collection endpoints to manage package admins. is: [secured] /add: post: description: "add admin to an existing package.[Since:1.0][Flow-name:add-package-admin]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.resource.admin.v1+json responses: "200": description: the users were successfully added. body: application/vnd.com.covisint.platform.package.resource.admin.v1+json: schema: resourceAdmin "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] + package.admin.invalid.action - Application administrator is disabled for this package + framework:resource.missing - A resource with the following ID was not found {packageId} 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 is: [postResponse] /remove: post: description: "delete admin from an existing package.[Since:1.0][Flow-name:delete-package-admin]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.resource.admin.v1+json responses: "200": description: the users were successfully added. body: application/vnd.com.covisint.platform.package.resource.admin.v1+json: schema: resourceAdmin "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource.missing - A resource with the following ID was not found {packageId} 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 is: [postResponse] /serviceAdmin: description: collection endpoints to manage service admins. is: [secured] /add: post: description: "add admin to an existing package.[Since:3.17][Flow-name:add-service-admin]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.resource.admin.v1+json responses: "200": description: the users were successfully added. body: application/vnd.com.covisint.platform.package.resource.admin.v1+json: schema: resourceAdmin "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] + package.admin.invalid.action - Application administrator is disabled for this package + framework:resource.missing - A resource with the following ID was not found {packageId} 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 is: [postResponse] /remove: post: description: "delete admin from an existing package.[Since:3.17][Flow-name:delete-service-admin]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.resource.admin.v1+json responses: "200": description: the users were successfully added. body: application/vnd.com.covisint.platform.package.resource.admin.v1+json: schema: resourceAdmin "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource.missing - A resource with the following ID was not found {packageId} 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 is: [postResponse] /tasks/assignServiceMembership: description: "Assign services to a package [Since:1.0] [Flow-name:service-assign-service-membership]" is: [secured] post: description: "Assigns the given services as members of the package.[Since:1.0][Flow-name:service-assign-package-service]" 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: packageId: description: The package to add the services to. type: string required: true repeat: false maxLength: 100 serviceId: description: The services to be added to the package. Multiple parameters are supported. type: string required: true repeat: false maxLength: 15 responses: "204": description: The services were successfully added to the package. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.membership.multiple.packageId.not.allowed - Multiple packageIds are not allowed. + service.membership.invalid - The following services are already members of another package: {serviceIds} + 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] /tasks/removeServiceMembership: description: "Remove services from a package [Since:1.0] [Flow-name:service-assign-service-membership]" is: [secured] post: description: "Removes the given services from the package.[Since:1.0][Flow-name:service-delete-package-service]" 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: packageId: description: The package to remove the services from. type: string required: true repeat: false serviceId: description: The services to be removed from the package. Multiple parameters are supported. type: string required: true repeat: false responses: "204": description: The service(s) was successfully removed from the package. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.membership.multiple.packageId.not.allowed - Multiple packageIds are not allowed. + 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] /{packageId}/broker/{providerId}/link: description: "Associate provider to package [Since:3.8] [Flow-name:service-assign-provider-package]" uriParameters: packageId: description: Valid package id. type: string required: true repeat: false providerId: description: Valid sp provider id. type: string required: true repeat: false is: [secured] post: description: "Assigns the given provider to the package.[Since:3.8][Flow-name:service-assign-provider-package]" 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 provider was successfully linked to the package. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.membership.multiple.packageId.not.allowed - Multiple packageIds are not allowed. + service.membership.invalid - The following services are already members of another package: {serviceIds} + 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] /{packageId}/broker/{providerId}/delink: description: "deassociate provider to package [Since:3.8] [Flow-name:service-revoke-provider-package]" uriParameters: packageId: description: Valid package id. type: string required: true repeat: false providerId: description: Valid sp provider id. type: string required: true repeat: false is: [secured] delete: description: "Assigns the given provider to the package.[Since:3.8][Flow-name:service-revoke-provider-package]" 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 provider was successfully delinked from the package. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.membership.multiple.packageId.not.allowed - Multiple packageIds are not allowed. + service.membership.invalid - The following services are already members of another package: {serviceIds} + 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] /persons/{personId}/packages: description: collection endpoint for user package grant resources uriParameters: personId: description: The id of the person for whom this grant is being made. type: string required: true repeat: false is: [secured] get: description: "Performs a search for a person's package grants. [Since:1.0][Flow-name:service-search-person-packages]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. 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: 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 package grants that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes: schema: packageGrant "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, pagableRequest] /count: description: "Count endpoint for person packages [Since:3.1]" get: description: "Returns the count of person's packages.[Flow-name:service-count-person-package]" headers: Accept: description: Used to request the appropriate package resource media type. type: string required: true repeat: false example: text/plain responses: "200": description: The total number of packages successfully retrieved (response collection may be empty). body: application/text: "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 /history: description: Endpoint used to retrieve the user's package grant history . is: [secured] /{packageId}: description: individual resource endpoint for package grants uriParameters: packageId: description: Unique identifier of the granted package. type: string required: true repeat: false is: [secured] get: description: "Returns the package grant [Since:1.0][Flow-name:service-get-person-package]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. 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 package grant was successfully retrieved body: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes: schema: packageGrant "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] + service.package.grant.person.invalid - The person service package grant does not exist body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] put: description: "Grant (push) a package to a person. [Since:1.0][Flow-name:service-update-person-package]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.v1+json suppressNotification: description: Media type for person. type: string required: false repeat: false example: "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.package.grant.v1+json: schema: packageGrant responses: "200": description: The package grant was successfully created body: application/vnd.com.covisint.platform.package.grant.v1+json: schema: packageGrant "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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] + service.package.not.grantable - This package is not grantable. + service.package.grant.invalid.grantee.status - Service package cannot be granted to grantee in UNACTIVATED status + update.service.package.grant.invalid.status - Invalid status. Valid values are ACTIVE, SUSPENDED, UNACTIVATED 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: "Revoke a package grant from a person. [Since:3.1][Flow-name:delete-package-grant]" 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 package grant was successfully revoked "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 "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] /organizations/{organizationId}/packages: description: collection endpoint for organization package grant resources uriParameters: organizationId: description: The id of the organization for whom this grant is being made. type: string required: true repeat: false is: [secured] get: description: "Performs a search for an organization's package grants. [Since:1.0][Flow-name:service-search-organization-packages]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. 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: 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 package grants that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes: schema: packageGrant "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, pagableRequest] /count: description: "Count endpoint for organization packages [Since:3.1]" get: description: "Returns the count of organization's packages.[Flow-name:service-count-organization-package]" headers: Accept: description: Used to request the appropriate package resource media type. type: string required: true repeat: false example: text/plain responses: "200": description: The total number of packages successfully retrieved (response collection may be empty). body: application/text: "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 /{packageId}: description: individual resource endpoint for package grants uriParameters: packageId: description: Unique identifier of the granted package. type: string required: true repeat: false is: [secured] get: description: "Returns the package grant [Since:1.0][Flow-name:service-get-organization-package]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. 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 package grant was successfully retrieved body: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes: schema: packageGrant "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + service.package.grant.organization.invalid - The organization service package grant does not exist + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] put: description: "Grant (push) a package to an organization. [Since:1.0][Flow-name:service-update-organization-package]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.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.package.grant.v1+json: schema: packageGrant responses: "200": description: The package grant was successfully created body: application/vnd.com.covisint.platform.package.grant.v1+json: schema: packageGrant "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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] + service.package.not.grantable - This package is not grantable. + update.service.package.grant.invalid.status - Invalid status. Valid values are ACTIVE, SUSPENDED, UNACTIVATED 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 was a problem with the client's request ___ Substatus codes are mentioned below: + framework:resource:conflict:grantee:type - Invalid grantee type. Expected {granteeType} + framework:resource:conflict:grantee:id - Invalid grantee id. Expected {granteeId} + framework:resource:conflict:servicePackage:id - Invalid service package id. Expected {servicePackageId} 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: "Revoke a package grant from an organization. [Since:3.1][Flow-name:delete-organization-package-grant]" 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 package grant was successfully revoked "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 "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] /grants/tasks/person/package/suspend: description: "used to suspend an existing service package grant for user. If the grant is already suspended, It will throw exception. [Since:3.1.0]" is: [secured] post: description: "Suspends a service package grant for user.[Flow-name:suspended-user-package-grant]" 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 body: application/vnd.com.covisint.platform.package.grant.status.request.v1+json: schema: grantStatusChangeRequest responses: "204": description: The user service package grant was successfully suspended "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.grant.not.exists - The grant of the service package %s for the person %s doesnt exists. + service.package.grant.not.suspended - The grant of the service package %s for the person %s is not active.. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /grants/tasks/person/package/unsuspend: description: "used to unsuspend an existing service package grant for user. If the grant is already unsuspended, It will throw exception. [Since:3.1.0]" is: [secured] post: description: "Unsuspends a service package grant for user.[Flow-name:unsuspended-user-package-grant]" 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 body: application/vnd.com.covisint.platform.package.grant.status.request.v1+json: schema: grantStatusChangeRequest responses: "204": description: The user service package grant was successfully unsuspended "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.grant.not.exists - The grant of the service package for the person doesnt exists. + service.package.grant.not.suspended - The grant of the service package for the person is not suspended.. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /grants/tasks/organization/package/suspend: description: "used to suspend an existing service package grant for organization. If the grant is already suspended, It will throw exception. [Since:3.1.0]" is: [secured] post: description: "Suspends a service package grant for organization.[Flow-name:suspended-organizaton-package-grant]" 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 body: application/vnd.com.covisint.platform.package.grant.status.request.v1+json: schema: grantStatusChangeRequest responses: "204": description: The organiaztion service package grant was successfully suspended "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.grant.not.exists - The grant of the service package %s for the person %s doesnt exists. + service.package.grant.not.suspended - The grant of the service package %s for the person %s is not active.. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /grants/tasks/organization/package/unsuspend: description: "used to unsuspend an existing service package grant for organization. If the grant is already unsuspended, It will throw exception. [Since:3.1.0]" is: [secured] post: description: "Unsuspends a service package grant for organization.[Flow-name:unsuspended-organization-package-grant]" 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 body: application/vnd.com.covisint.platform.package.grant.status.request.v1+json: schema: grantStatusChangeRequest responses: "204": description: The organization service package grant was successfully unsuspended "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.grant.not.exists - The grant of the service package for the person doesnt exists. + service.package.grant.not.suspended - The grant of the service package for the person is not suspended.. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /requests: description: collection endpoint for package request resources is: [secured] get: description: "Performs a search for package requests. [Since:1.0][Flow-name:service-search-requests]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.request.v1+json;includedivision=true;includeclaimrequests=true;includeclaimvaluerequests=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: requestor.id: description: The subject requesting the package. Mandatory if requestor.type query parameter is provided. type: string required: false repeat: false requestor.type: description: The type of subject requesting the package. Mandatory if requestor.id query parameter is provided. type: string required: false repeat: false enum: [person, organization] isApprovable: description: Set this parameter to 'true' to get only the approvable requests. type: string required: false repeat: false requestedPackage.id: description: Search requests for specific service packages type: string required: false repeat: false requestedClaim.id: description: Search requestw for specific service package claims type: string required: false repeat: false requestedClaimValue.id: description: Search requests for specific service package claim values type: string required: false repeat: false type: description: The type of request to search for. Default is servicePackage type: string required: false repeat: false enum: [servicePackage, servicePackageClaim, servicePackageClaimValue] 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 package requests that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.request.v1+json: schema: packageRequest "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] post: description: "Creates a new request for a package. [Since:1.0][Flow-name:service-create-request]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.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 body: application/vnd.com.covisint.platform.package.request.v1+json: schema: packageRequest responses: "201": description: The package request was successfully created body: application/vnd.com.covisint.platform.package.request.v1+json: schema: packageRequest "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} + service.package.not.found - The requested service package does not exist. + service.package.request.invalid.requestor.status - Service package cannot be requested by a requestor in UNACTIVATED status + service.package.not.requestable - The requested service package was marked as non-requestable. + service.package.request.parent.id.not.found - The parent request id was not found. + requestor.type.invalid - Only person requestors are supported + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + service.package.request.invalid.requestor.type - Unsupported requestor type {requestorType} + 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] /{id}: description: individual resource endpoint for package request/package claim request/package claim value request uriParameters: id: description: Unique identifier of the package request/package claim request/package claim value request type: string required: true repeat: false is: [secured] get: description: "Returns the package request [Since:1.0][Flow-name:service-get-request]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.request.v1+json;includeclaimrequests=true;includeclaimvaluerequests=true; Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The request was successfully retrieved body: application/vnd.com.covisint.platform.package.request.v1+json: schema: packageRequest "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] delete: description: "Deletes (cancels) an existing package request. [Since:1.0][Flow-name:service-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 body: application/vnd.com.covisint.platform.package.request.v1+json: schema: packageRequest responses: "204": description: The package request was successfully deleted "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "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] /claims: description: individual resource endpoint for package requests is: [secured] put: description: "Creates a new request for claim and claim values [Since:1.0][Flow-name:service-package-claim-request]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.claim.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 body: application/vnd.com.covisint.platform.package.request.v1+json: schema: packageRequest responses: "201": description: The package claim request was successfully created body: application/vnd.com.covisint.platform.package.request.v1+json: schema: packageRequest "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} + service.package.claim.request.package.details.not.found - The service package details does not exsit in input + service.package.claim.request.requestor.not.found - The service requestor does not exsit in input + service.package.claim.request.claims.not.found - The package claims does not exsit in input + service.package.claim.request.package.not.found - The provided service package does not exist. + service.package.claim.request.invalid.requestor.status - Service package claim cannot be requested by a requestor in UNACTIVATED status + service.package.claim.request.package.not.requestable - service.package.claim.request.package.not.requestable. + service.package.claim.request.unsupported.requestor.type - Only requests for persons are supported + service.package.claim.request.package.not.granted - Service package is not granted to requestor + service.package.claim.request.present - Request is already present for the claim + service.package.claim.request.claim.not.granted - Claim is not granted to owning organization + service.package.claim.request.claim.value.not.granted - Claim value is not granted to owning organization + service.package.claim.value.request.present - Request is already present for the claim value + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + service.package.request.invalid.requestor.type - Unsupported requestor type {requestorType} + 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 "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] /count: description: "Count endpoint for package requests [Since:3.1]" get: description: "Returns the count of packagess.[Flow-name:service-count-request]" headers: Accept: description: Used to request the appropriate package resource media type. type: string required: true repeat: false example: application/json queryParameters: requestor.id: description: The subject requesting the package. Mandatory if requestor.type query parameter is provided. type: string required: false repeat: false requestor.type: description: The type of subject requesting the package. Mandatory if requestor.id query parameter is provided. type: string required: false repeat: false enum: [person, organization] responses: "200": description: The total number of packages successfully retrieved (response collection may be empty). body: application/text: "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 /tasks/approve: description: "endpoint used to approve package requests for person requestors. [Since:1.0]" is: [secured] post: description: "Approve a package request. [Flow-name:service-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 request id. type: string required: true repeat: false justification: description: optional justification for the decision. type: string required: false repeat: false maxLength: 1000 responses: "204": description: The approval decision was accepted and will be processed accordingly. No response entity body. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + service.request.id.not.found- The service request does not exist + service.request.unsupported.requestor.type - Service package requests for persons are supported. Other requestor types (organizations) are not supported. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + service.package.request.already.processed - The request has already been processed. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /tasks/deny: description: "endpoint used to reject package requests for person requestors. [Since:1.0]" is: [secured] post: description: "Deny a package request. [Flow-name:service-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 request id. type: string required: true repeat: false justification: description: optional justification for the denial. type: string required: false repeat: false maxLength: 1000 responses: "204": description: The denial decision was accepted and will be processed. No response entity body. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + service.request.id.not.found- The service request does not exist. + service.request.unsupported.requestor.type - Service package requests for persons are supported. Other requestor types (organizations) are not supported. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + service.package.request.already.processed - The request has already been processed. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /tasks/claim/approve: description: "endpoint used to approve package claim requests for person requestors. [Since:3.16]" is: [secured] post: description: "Approve a package claim request. [Flow-name:service-task-approve-claim-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 request id. type: string required: true repeat: false justification: description: optional justification for the decision. type: string required: false repeat: false maxLength: 1000 responses: "204": description: The approval decision was accepted and will be processed accordingly. No response entity body. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + claim.not.found - Requested claim does not exist + claim.already.granted - Requested claim was already granted + package.not.granted - Package is not granted yet + package.not.found - Package does not exist + service.claim.request.id.not.found - Claim request does not exist + service.claim.request.unsupported.requestor.type - Service package claim requests for persons are supported. Other requestor types (organizations) are not supported. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + request.approval.invalid - Invalid user is trying to approve claim body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /tasks/claimValue/approve: description: "endpoint used to approve package claim value requests for person requestors. [Since:3.16]" is: [secured] post: description: "Approve a package claim value request. [Flow-name:service-task-approve-claim-value-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 request id. type: string required: true repeat: false justification: description: optional justification for the decision. type: string required: false repeat: false maxLength: 1000 responses: "204": description: The approval decision was accepted and will be processed accordingly. No response entity body. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + claim.value.not.found - Requested claim value does not exist + claim.value.already.granted - Requested claim value was already granted + claim.request.or.grant.not.found - Claim should be requested/granted before claim value + claim.request.not.approved - Claim request should be approved before claim value + package.not.found - Package does not exist + service.claim.value.request.id.not.found - Claim value request does not exist + service.claim.value.request.unsupported.requestor.type - Service package claim value requests for persons are supported. Other requestor types (organizations) are not supported. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + request.approval.invalid - Invalid user is trying to approve claim body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /tasks/claim/deny: description: "endpoint used to deny package claim requests for person requestors. [Since:3.16]" is: [secured] post: description: "Deny a package claim request. [Flow-name:service-task-deny-claim-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 request id. type: string required: true repeat: false justification: description: optional justification for the decision. type: string required: false repeat: false maxLength: 1000 responses: "204": description: The deny decision was accepted and will be processed accordingly. No response entity body. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + claim.not.found - Requested claim does not exist + service.claim.request.id.not.found - Claim request does not exist + service.claim.request.unsupported.requestor.type - Service package claim requests for persons are supported. Other requestor types (organizations) are not supported. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /tasks/claimValue/deny: description: "endpoint used to deny package claim value requests for person requestors. [Since:3.16]" is: [secured] post: description: "Deny a package claim value request. [Flow-name:service-task-deny-claim-value-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 request id. type: string required: true repeat: false justification: description: optional justification for the decision. type: string required: false repeat: false maxLength: 1000 responses: "204": description: The deny decision was accepted and will be processed accordingly. No response entity body. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + claim.value.not.found - Requested claim value does not exist + service.claim.value.request.id.not.found - Claim value request does not exist + service.claim.value.request.unsupported.requestor.type - Service package claim value requests for persons are supported. Other requestor types (organizations) are not supported. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /organizations/requests: description: collection endpoint for package request resources requested for organization. is: [secured] get: description: "Performs a search for package requests for organization. [Since:3.7][Flow-name:service-search-organization-requests]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.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: requestor.id: description: The organization id for which the package request is made. type: string required: false repeat: false organizationName: description: The organization name for which the package request is made. Wild card search is supported. Multi value search not supported. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" responses: "200": description: All package requests that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.request.v1+json: schema: packageRequest "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] /grants: description: "Search endpoint for package grants. [Since:1.0]" is: [secured] get: description: "Performs a search for all grants of the specified package id. [Since:1.0][Flow-name:service-search-grants]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.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: grantedPackageId: description: the id of the granted package which is being searched. type: string required: true repeat: false granteeType: description: The type of grantee to be filtered. Omit this parameter to retrieve grants for all grantees. type: string required: false repeat: false enum: [person, organization] 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 package grants that satisfy the search criteria were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.grant.v1+json: schema: packageGrant "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 "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] /packages/grants/claims: description: "Endpoint for assigning claims to user package grants. [Since:3.0]" is: [secured] put: description: "Assigns a claim to the person or organiaztion package grant. [Since:3.0][Flow-name:service-update-grant-claim]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.claim.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.package.grant.claim.v1+json: schema: packageGrantClaimRequest responses: "200": description: The package claims was successfully assigned to user package grants. body: "application/vnd.com.covisint.platform.package.grant.claim.v1+json:": schema: packageGrantClaimResponse "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + grantee.type.invalid - Only persons/organiaztion are allowed to grant package claims + service.package.grant.invalid.claim.id - The claim id is not associated with the package id + service.package.grant.invalid.claim.value.id - The claim value id is not associated with the claim id + service.package.grant.invalid.grantee.id - The grantee id is invalid + service.package.grant.organization.invalid - The organization service package grant does not exist 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] /persons/{grantee}/claims: description: "Search endpoint for package grant claims based on grantee. [Since:3.0]" uriParameters: grantee: description: The id of the person for whom this grant claim is being made. type: string required: true repeat: false is: [secured] get: description: "Search endpoint for package grant claims based on grantee. [Since:3.0][Flow-name:service-get-grantee-claims]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.claim.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: 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: Package grant claims for a grantee will be returned (response collection may be empty). body: application/vnd.com.covisint.platform.package.grant.claim.v1+json: schema: packageGrantClaimResponse "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] + service.package.grant.claim.not.exists - The service package grant claim does not exist for the grantee. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] /persons/{grantee}/packages/{packageId}/claims: description: "Search endpoint for package grant claims based on grantee and package id. [Since:3.0]" uriParameters: grantee: description: The id of the person for which the grant claim is requested for. type: string required: true repeat: false packageId: description: The id of the package for which the grant claim is requested for. type: string required: true repeat: false is: [secured] get: description: "Search endpoint for package grant claims based on grantee. [Since:3.0][Flow-name:service-get-grant-claim]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.claim.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: Package grant claim for a grantee will be returned. body: application/vnd.com.covisint.platform.package.grant.claim.v1+json: schema: packageGrantClaimResponse "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] + service.package.grant.claim.not.exists - The service package grant claim does not exist for the grantee and package id. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse] /packages/persons/{personId}/requestable: description: "Retrieve packages that are not granted to me and that are requestable.[Since:1.0]" uriParameters: personId: description: The id of the person for whom this request is being made. type: string required: true repeat: false is: [secured] get: description: "Retrieve packages that are not granted to me and that are requestable.[Flow-name:service-get-persons-requestable-packages]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.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: 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 packages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.v1+json: schema: package "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + search.packages.request.invalid.combination.queryParamaters - Multiple {queryParameter} are not allowed. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] /count: description: "Count endpoint for person requestable packages [Since:3.1]" get: description: "Returns the count of person's packages.[Flow-name:service-count-person-requestable-package]" headers: Accept: description: Used to request the appropriate package resource media type. type: string required: true repeat: false example: text/plain responses: "200": description: The total number of packages successfully retrieved (response collection may be empty). body: application/text: "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 /packages/organizations/{organizationId}/requestable: description: "Retrieve packages that are not granted to my organization and that are requestable.[Since:1.0]" uriParameters: organizationId: description: The id of the organization for whom this request is being made. type: string required: true repeat: false is: [secured] get: description: "Retrieve packages that are not granted to my organization and that are requestable.[Flow-name:service-get-organization-requestable-packages]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.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: 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 packages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.v1+json: schema: package "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 [organization, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + search.packages.request.invalid.combination.queryParamaters - Multiple {queryParameter} are not allowed. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] /packages/{packageId}/claims/{claimId}: description: Deletes the claim which is already present in the system. uriParameters: packageId: displayName: packageId type: string required: true repeat: false claimId: displayName: claimId type: string required: true repeat: false delete: description: "Deletes a Package Claim and User and organiaztion Package Grant based on headers. [Flow-name:service-delete-package-claims] [Since:3.14.0]" headers: Accept: description: Media Type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.claim.v1+json;deleteUserPkgGrant=true;deleteorgpkggrant=true responses: "204": description: The package claim 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:data:invalid - Missing delete flag - Claim can not be deleted + 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 is: [deleteResponse] /packages/{packageId}/claims/{claimId}/claimValue/{valueId}: description: Deletes the claim values which is already present in the system. uriParameters: packageId: displayName: packageId type: string required: true repeat: false claimId: displayName: claimId type: string required: true repeat: false valueId: displayName: valueId type: string required: true repeat: false delete: description: "Deletes Package Claim values. User and organiaztion grant claim value based on headers[Flow-name:service-delete-package-claim-values] [Since:3.14.0]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.claim.v1+json;deleteuserpkgvaluegrant=true;deleteorgpkgvaluegrant=true responses: "204": description: The package claim 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:data:invalid - Missing delete flag - Claim can not be deleted + 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 is: [deleteResponse] /applications: /persons/{personId}: description: individual resource endpoint for application resources for a person. uriParameters: personId: description: The id of the person for whom this request is being made. type: string required: true repeat: false is: [secured] get: description: "Retrieve applications that are granted to the person.[Flow-name:service-get-person-granted-applications][Since:3.2.0]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.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: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name in wild card mode. Multiple names not allowed. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false grant.status: description: Filter the search results by the given grant status. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+service.name, "-service.name", +service.creation, "-service.creation", +grant.instant, "-grant.instant"] 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 applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.v1+json: schema: application "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + framework:request:param:invalid - Multiple wild card search values not supported for the parameter: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /count: description: "Count applications that are granted to person.[Since:3.2.0]" is: [secured] get: description: "Count applications that are granted to person.[Flow-name:service-count-person-granted-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name in wild card mode. Multiple names not allowed. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false grant.status: description: Filter the search results by the given grant status. type: string required: false repeat: false responses: "200": description: All packages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: text/plain: "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + framework:request:param:invalid - Multiple wild card search values not supported for the parameter: {queryParameterName} 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: [getSearchResponse, getResponse] /requestable: description: "Retrieve applications that are not granted to the person and that are requestable.[Since:3.3]" is: [secured] get: description: "Retrieve packages that are not granted to the person and that are requestable.[Flow-name:service-get-person-requestable-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.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: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+service.name, "-service.name", +service.creation, "-service.creation"] 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 applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.v1+json: schema: application "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /count: description: "Count applications that are not granted to the person and that are requestable.[Since:3.3]" is: [secured] get: description: "Count the applications that are not granted to the person and that are requestable.[Flow-name:service-count-person-requestable-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false responses: "200": description: All packages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: text/plain: "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, getResponse] /grantable: description: "Retrieve application that are not granted to the person and that are grantable.[Since:3.1]" is: [secured] get: description: "Retrieve packages that are not granted to the person and that are grantable.[Flow-name:service-get-person-grantable-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.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: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+service.name, "-service.name", +service.creation, "-service.creation"] 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 applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.v1+json: schema: application "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /count: description: "Count applications that are not granted to the person and that are grantable.[Since:3.1]" is: [secured] get: description: "Count applications that are not granted to the person and that are grantable.[Flow-name:service-count-person-grantable-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false responses: "200": description: All applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: text/plain: "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, getResponse] /history: description: "Retrieve application history that are granted to the person.[Since:3.3]" is: [secured] get: description: "Retrieve application history that are granted to the person.[Flow-name:service-get-person-granted-applications-history]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.grant.history.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: status: description: Filter the search results by the status. type: string required: false repeat: false eventType: description: Filter the search results by the event type. type: string required: false repeat: false name: description: Filter the search results by the service name. type: string required: false repeat: false eventDate: description: Filter the search results starting with the given event date. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+eventDate, "-eventDate", +eventType, "-eventType", +actorId, "-actorId"] 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 application grant history that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.grant.history.v1+json: schema: applicationGrantHistory "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /count: description: "Count application history that are granted to the person.[Since:3.5]" is: [secured] get: description: "Count application history that are granted to the person.[Flow-name:service-count-person-granted-applications-history]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: Returns the count of application grant history which satisfy the query parameters. (response collection may be empty). body: text/plain: "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, getResponse] /organizations/{organizationId}: description: individual resource endpoint for application resources for an organization. uriParameters: organizationId: description: The id of the organization for whom this request is being made. type: string required: true repeat: false is: [secured] get: description: "Retrieve applications that are granted to the organization.[Flow-name:service-get-organization-granted-applications][Since:3.2.0]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.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: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name in wild card mode. Multiple names not allowed. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false grant.status: description: Filter the search results by the given grant status. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+service.name, "-service.name", +service.creation, "-service.creation", +grant.instant, "-grant.instant"] 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 applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.v1+json: schema: application "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + framework:request:param:invalid - Multiple wild card search values not supported for the parameter: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /count: description: "Count applications that are granted to organization.[Since:3.2.0]" is: [secured] get: description: "Count applications that are granted to the organization.[Flow-name:service-count-organization-granted-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name in wild card mode. Multiple names not allowed. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false grant.status: description: Filter the search results by the given grant status. type: string required: false repeat: false responses: "200": description: All applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: text/plain: "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + framework:request:param:invalid - Multiple wild card search values not supported for the parameter: {queryParameterName} 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: [getSearchResponse, getResponse] /requestable: description: Retrieve applications that are not granted to the organization and granted to the parent organization and that are requestable. is: [secured] get: description: "Retrieve applications that are not granted to the organization and granted to the parent organization and that are requestable.[Flow-name:service-get-organization-requestable-applications][Since:3.3]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.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: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+service.name, "-service.name", +service.creation, "-service.creation"] 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 packages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.v1+json: schema: application "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /count: description: "Retrieve applications that are not granted to the organization and granted to the parent organization and that are requestable.[Since:3.3]" is: [secured] get: description: "Retrieve applications that are not granted to the organization and granted to the parent organization and that are requestable.[Flow-name:service-count-organization-requestable-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false responses: "200": description: All packages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: text/plain: "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, getResponse] /grantable: description: Retrieve applications that are not granted to the organization and that are grantable. is: [secured] get: description: "Retrieve applications that are not granted to the organization and that are grantable.[Flow-name:service-get-organization-grantable-applications][Since:3.5]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.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: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+service.name, "-service.name", +service.creation, "-service.creation"] 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 packages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.v1+json: schema: application "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /count: description: "Count applications that are not granted to the organization that are grantable.[Since:3.5]" is: [secured] get: description: "Count applications that are not granted to the organization and that are grantable.[Flow-name:service-count-organization-grantable-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false responses: "200": description: All applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: text/plain: "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, getResponse] /history: description: "Retrieve application history that are granted to the organization.[Since:3.8]" is: [secured] get: description: "Retrieve application history that are granted to the organization.[Flow-name:service-get-organization-granted-applications-history]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.grant.history.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: status: description: Filter the search results by the status. type: string required: false repeat: false eventType: description: Filter the search results by the event type. type: string required: false repeat: false name: description: Filter the search results by the service name. type: string required: false repeat: false eventDate: description: Filter the search results starting with the given event date. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+eventDate, "-eventDate", +eventType, "-eventType", +actorId, "-actorId"] 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 application grant history that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.grant.history.v1+json: schema: applicationGrantHistory "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /categories: description: collection endpoint for category resources. is: [secured] get: description: "Performs a search for category resources.[Since:3.1][Flow-name:service-search-categories]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.category.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve all categories for given id. type: string required: false repeat: false name: description: Retrieve all categories for given name. 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 categories that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.category.v1+json: schema: category "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} + search.services.request.invalid.combination.queryParamaters - Multiple {queryParameter} are not allowed. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - Multiple wild card search values not supported for the parameter: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] /count: description: "Count endpoint for Categories [Since:3.1]" get: description: "Returns the count of Categories.[Flow-name:service-count-categories]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/json responses: "200": description: The total number of categories successfully retrieved (response collection may be empty). body: application/text: "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} + search.services.request.invalid.combination.queryParamaters - Multiple {queryParameter} 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 /persons/{personId}: description: individual resource endpoint for application resources for a person. uriParameters: personId: description: The id of the person for whom this request is being made. type: string required: true repeat: false is: [secured] get: description: "Retrieve categories of applications that are granted to the person.[Flow-name:categories-get-person-granted-applications][Since:3.3]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.category.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve all categories for given id. type: string required: false repeat: false name: description: Retrieve all categories for given name. 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 applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.category.v1+json: schema: category "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + framework:request:param:invalid - Multiple wild card search values not supported for the parameter: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /organization/{organizationId}: description: individual resource endpoint for application resources for a organization. uriParameters: organizationId: description: The id of the organization for whom this request is being made. type: string required: true repeat: false is: [secured] get: description: "Retrieve categories of applications that are granted to the organization.[Flow-name:categories-get-organization-granted-applications][Since:3.6]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.category.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve all categories for given id. type: string required: false repeat: false name: description: Retrieve all categories for given name. 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 applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.category.v1+json: schema: category "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + framework:request:param:invalid - Multiple wild card search values not supported for the parameter: {queryParameterName} 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: [getSearchResponse, pagableRequest, getResponse] /persons/{personId}/applications: uriParameters: personId: description: The id of the person for whom this . type: string required: true repeat: false /requests: description: Collection endpoint for getting pending application requests for a person is: [secured] get: description: "Performs a search for a application request for a person [Since:3.4][Flow-name:service-search-person-application-request]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.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: name: description: Filter the search results by the service (or application) name. Wild card search is supported for this field type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+requestedDate, "-requestedDate"] 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 application request for a person that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.request.v1+json: schema: applicationRequest "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, pagableRequest] /history: description: Collection endpoint for getting application request history for a person is: [secured] get: description: "Performs a search for a application request history for a person [Since:3.4][Flow-name:service-search-person-application-request-history]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.request.history.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: Filter the search results by the service (or application) name. Wild card search is supported for this field type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+requestedDate, "-requestedDate", +evaluationDate, "-evaluationDate", +evaluatorId, "-evaluatorId"] 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 application request history for a person that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.request.history.v1+json: schema: applicationRequestHistory "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, pagableRequest] /count: description: "Count application history that are requested by the person.[Since:3.5]" is: [secured] get: description: "Count application history that are requested by the person.[Flow-name:service-count-person-application-request-history]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: Returns the count of application request history which satisfy the query parameters. (response collection may be empty). body: text/plain: "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} 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: [getSearchResponse, getResponse] /organizations/{organizationId}/applications: uriParameters: organizationId: description: The global covisint org Id of the organization. type: string required: true repeat: false /requests/history: description: Collection endpoint for getting application request history for an organization. is: [secured] get: description: "Performs a search for a application request history for an organization [Since:3.8][Flow-name:service-search-organiaztion-application-request-history]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.request.history.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: 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 application request for an organization were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.request.v1+json: schema: applicationRequest "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, pagableRequest] /grants/tasks/person/packages/add: description: "used to grant multiple packages to person. [Since:3.11]" is: [secured] post: description: "Grants multiple packages to person.[Flow-name:grants-tasks-person-packages-add]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.bulk.response.v1+json Content-Type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.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.package.grant.v1+json: schema: multiPackagesPersonGrantRequest responses: "200": description: Packages are granted to person. body: application/vnd.com.covisint.platform.bulk.response.v1+json: schema: multiPackagesGrantResponse "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.grant.not.exists - The grant of the service package %s for the person %s doesnt exists. + service.package.grant.not.suspended - The grant of the service package %s for the person %s is not active.. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /grants/tasks/person/packages/revoke: description: "used to revoke multiple packages from person. [Since:3.11]" is: [secured] post: description: "Revokes multiple packages from person.[Flow-name:grants-tasks-person-packages-revoke]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.bulk.response.v1+json Content-Type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.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.package.grant.v1+json: schema: multiPackagesPersonGrantRequest responses: "200": description: Packages are revoked from person. body: application/vnd.com.covisint.platform.bulk.response.v1+json: schema: multiPackagesGrantResponse "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + service.package.grant.not.exists - The grant of the service package %s for the person %s doesnt exists. + service.package.grant.not.suspended - The grant of the service package %s for the person %s is not active.. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /organizations/{organizationId}/claim/{claimId}: description: Deletes the organiaztion claim and claim values. uriParameters: organizationId: displayName: organizationId type: string required: true repeat: false claimId: displayName: claimId type: string required: true repeat: false is: [secured] delete: description: "Deletes a Organization Claim and User claims under the organiaztion. Organization hierarchy claim removal is based on headers. [Flow-name:service-delete-organization-package-claims] [Since:3.14.0]" headers: Accept: description: Media Type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.claim.v1+json;deleteorghierarchyclaim=true Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The organization claim 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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + service.package.grant.claim.not.exists - The service package grant claim does not exist for the grantee Org and claim id 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] /claimValue/{valueId}: uriParameters: valueId: displayName: valueId type: string required: true repeat: false delete: description: "Deletes a Organization Claim value and User claims value under the organiaztion.Organization hierarchy claim value removal is based on headers. [Flow-name:service-delete-organization-package-claim-value] [Since:3.14.0]" headers: Accept: description: Media Type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.claim.v1+json;deleteorghierarchyclaimvalue=true responses: "204": description: The organization claim value 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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + service.package.grant.claim.value.not.exists - The service package grant claim value does not exist for the grantee Org and claim value id 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 is: [deleteResponse] /organizations/{granteeOrgId}/packages/{packageId}/claims: uriParameters: granteeOrgId: displayName: granteeOrgId type: string required: true repeat: false packageId: displayName: packageId type: string required: true repeat: false is: [secured] get: description: "Get endpoint for package grant claims based on grantee and package.[Flow-name:service-get-organization-package-claims] [Since:3.0]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.claim.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: Package grant claims for a grantee will be returned (response collection may be empty). body: application/vnd.com.covisint.platform.package.grant.claim.v1+json: schema: packageGrantClaimResponse "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] + service.package.grant.claim.not.exists - The service package grant claim does not exist for the grantee Org and package id. 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] /organizations/{granteeOrgId}/claims: description: "Search endpoint for package grant claims based on grantee. [Since:3.0]" uriParameters: granteeOrgId: displayName: granteeOrgId type: string required: true repeat: false is: [secured] get: description: "Search endpoint for package grant claims based on grantee. [Since:3.0][Flow-name:service-get-organization-claims]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.claim.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: 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: Package grant claims for a grantee will be returned (response collection may be empty). body: application/vnd.com.covisint.platform.package.grant.claim.v1+json: schema: packageGrantClaimResponse "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] + service.package.grant.claim.not.exists - The service package grant claim does not exist for the grantee. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest]