#%RAML 0.8 title: Service API baseUri: https://api.us1.covisint.com/service/v1 protocols: - HTTPS schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "maxLength" : 36, "description" : "The unique identifier for the resource.", "required": true }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } } - namedResourceReference: "{\n \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the basic resource reference and adds internationalized name and description.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"properties\" : {\n \"name\" : { \n \"description\": \"Internationalized resource name.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : { \n \"description\": \"Internationalized resource description.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }\n }\n}\n" - resource: "{\n \"id\" : \"http://api.covisint.com/schema/resource\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resource\",\n \"type\" : \"object\",\n \"description\" : \"A basic resource.\",\n \"properties\" : {\n \"id\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The unique identifier for this resource.\",\n \ \"required\": true\n },\n \"version\": {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \ \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests.\",\n \"required\": false\n },\n \ \"creator\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The creator of this resource. This is mandatory if x-requestor header is NOT available\",\n \"required\": false\n },\n \ \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"description\" : \"The application id of the creator of this resource.\",\n \"required\": false\n },\n \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"description\" : \"If this value is provided in a POST / PUT request body, it will be ignored and system will generate value as time, in milliseconds since the epoch, when this resource was created or upda\",\n \ \"required\": false \n }\n }\n }\n }\n}\n" - realmScopedResource: | { "id" : "http://api.covisint.com/schema/realmScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the base resource and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resource#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available", "required": false } } } - errorResponseSchema: "{\n \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n \"properties\" : {\n \"status\" : { \n \"type\" : \"number\",\n \"minimum\" : 400,\n \ \"maximum\" : 599,\n \"description\" : \"The HTTP status code.\",\n \ \"required\": true\n },\n \"apiMessage\" : { \n \"type\" : \"string\",\n \ \"description\" : \"A helpful, human-readable description of the error, useful for basic diagnostics.\" \n },\n \"apiStatusCode\" : {\n \"type\" : \"string\",\n \"description\" : \"The API-specific status code.\"\n }\n\n \ }\n}\n" - serviceCode: "{\n \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\": \"object\",\n \"description\": \"The site/service/location codes granted along with a service.\",\n \"properties\": {\n \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200, \"description\": \"The code value.\" },\n \"codeKind\": { \"type\": \"string\", \"required\": true, \"maxLength\": 36, \"description\": \"The associated business unit.\" }\n }\n} \n" - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "type" : "string", "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type": "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: "{\n \"id\" : \"http://api.covisint.com/idm/schema/phone\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"A container for phone number details.\",\n \"properties\" : {\n \"number\" : { \"type\" : \"string\",\"maxLength\" : 100, \"description\" : \"The phone number.\" },\n \"type\" : { \"enum\" : [ \"main\", \"mobile\", \"fax\" ], \"description\" : \"The phone number type.\" }\n },\n \"required\" : [ \"type\" ]\n} \n" - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - service: "{\n \"id\" : \"http://api.covisint.com/schema/service\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"Schema representing a service resource.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n },\n \"properties\" : {\n \"id\" : {\n \"maxLength\" : 15\n },\n \"version\": {\n \"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.\"\n },\n \ \"name\" : {\n \"description\": \"Internationalized service names.\",\n \ \"required\": true,\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"description\" : {\n \"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.\",\n \"required\": false,\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"parentService\": {\n \"description\": \"The parent service. \ Used to create a service hierarchy.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"category\" : {\n \"description\": \"Internationalized category names.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\",\n \ \"required\": true\n },\n \"owningOrganization\": {\n \"description\": \"The organization that owns this service.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\": true\n },\n \"urls\": {\n \"type\": \"array\",\n \ \"minItems\": 1,\n \"required\": true,\n \"description\": \"A listing of all URLs defined for this service, by type.\",\n \"items\": {\n \ \"type\": \"object\",\n \"properties\": {\n \"type\": { \"type\": \"string\", \"description\": \"The URL type.\", \"maxLength\": 100 },\n \"value\": { \"type\": \"string\", \"description\": \"The URL value.\", \"maxLength\": 4000 }\n }\n }\n },\n \"remoteAppId\": { \n \"type\": \"string\", \n \"description\": \"Links this service to a remote application known to the client.\", \n \"maxLength\": 500 \n },\n \"mobileServiceId\": {\n \"type\": \"string\",\n \"description\": \"Mobile service id.\",\n \ \"maxLength\": 200\n },\n \"federationConnectionWizard\": {\n \"type\": \"string\",\n \"maxLength\": 255,\n \"description\": \"Location of the federation connection set-up wizard. e.g. salesforce, unauthenticated website, etc.\"\n },\n \"protected\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether this service is synced back to cleartrust entitlements server, and therefore protected by the ct web agent.\"\n },\n \"messagingEnabled\": {\n \"type\": \"boolean\", \n \"description\": \"Indicates whether to perform messaging when this service is updated.\"\n }\n }\n}\n" - packageGrant: "{\n \"id\" : \"http://api.covisint.com/schema/packageGrant\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"extends\" : {\n \ \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n },\n \ \"type\" : \"object\",\n \"description\" : \"Representation of a package grant.\",\n \ \"properties\" : {\n \"id\": {\n \"required\" : false\n },\n \"version\": {\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests. User supplied value will be ignored and will be set to the creation value.\"\n },\n \"status\" : { \n \"type\" : \"string\",\n \ \"enum\" : [ \"active\", \"suspended\", \"unactivated\" ],\n \"description\" : \"The status of the grant. Only required when grant is retrieved. Not required when grant is created.\",\n \"required\": false\n },\n \"grantee\": {\n \"description\": \"The subject owning the grant\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\": true\n },\n \"servicePackage\": {\n \"description\": \"The granted package.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\": true\n }\n }\n}\n" - packageRequest: "{\n \"id\" : \"http://api.covisint.com/schema/packageRequest\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Schema representing a package request resource.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n \ },\n \"properties\" : {\n \"id\": {\n \"maxLength\" : 15\n },\n \ \"version\": {\n \"description\" : \"The current version for this resource. \ Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests. User supplied value will be ignored and will be set to the creation value.\"\n },\n \"requestor\": { \n \"description\": \"The subject for which this request is being made\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\": true\n },\n \"servicePackage\": {\n \"description\": \"The package being requested.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \ \"description\": \"The justification for the request.\",\n \"maxLength\": 1000\n },\n \"prerequisite\": {\n \"description\": \"The parent request, if applicable.\",\n \"extends\": {\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\"\n \ }\n }\n }\n} \n" - package: "{\n \"id\" : \"http://api.covisint.com/schema/service\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"Schema representing a package resource.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n },\n \"properties\" : {\n \"id\": {\n \"maxLength\" : 100\n }, \n \"version\": {\n \"description\" : \"The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests. User supplied value will be ignored and will be set to the creation value.\"\n },\n \"owningOrganization\": {\n \"description\": \"The organization that owns this package.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\",\n \ \"required\": true\n },\n \"parent\": {\n \"description\": \"The parent package. Used to create a package hierarchy.\",\n \"$ref\": \"http://api.covisint.com/schema/resourceReference#\"\n \ },\n \"codeRestrictions\": {\n \"type\": \"object\",\n \"description\": \"Indicates whether site/location code(s) must be specified when requesting/granting this package.\",\n \"properties\": {\n \"requestorType\": {\n \"type\": \"string\",\n \"enum\": [ \"person\", \"organization\" ],\n \"required\": true\n },\n \"restriction\": {\n \"type\": \"string\",\n \ \"enum\": [ \"site\", \"location\" ],\n \"required\": true\n \ }\n }\n },\n \"termsAndConditions\": {\n \"type\": \"array\",\n \ \"minItems\": 1,\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": { \n \"type\": \"string\", \n \"enum\": [ \"person\", \"organization\" ],\n \"description\": \"The target entity of the terms and conditions.\"\n },\n \"tacId\": {\n \"type\": \"string\", \n \"description\": \"The identifier of the T&C record.\",\n \ \"maxLength\": 15,\n \"required\": true\n }\n \ }\n }\n },\n \"protected\": {\n \"type\": \"boolean\",\n \ \"description\": \"Indicates whether this package is synced back to cleartrust entitlements server, and therefore protected by the ct web agent.\",\n \"default\" : false\n },\n \"requestable\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether this package may be requested by persons or organizations.\",\n \ \"default\" : false\n },\n \"grantable\": {\n \"type\": \"boolean\",\n \ \"description\": \"Indicates whether this package may be granted to persons or organizations.\",\n \"default\" : true\n }, \n \ \"displayable\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether this package may be displayed or should be suppressed in UIs.\",\n \"default\" : true\n }, \n \"requestReasonRequired\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether package requests must be accompanied by a reason supplied by the requestor.\",\n \"default\" : false\n }, \n \"name\" : {\n \"description\": \"Internationalized package names.\",\n \"required\": true,\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n },\n \"description\" : {\n \"description\": \"Internationalized package descriptions.\",\n \"required\": false,\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ },\n \"category\" : {\n \"description\": \"Internationalized category names.\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\",\n \ \"required\": true\n },\n \"requiredApprovals\" : {\n \"type\" : \"array\",\n \"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.\",\n \"minItems\": 0,\n \"items\": {\n \"enum\" : [ \"organizationAdmin\", \"applicationAdmin\", \"provisioningAdmin\" ]\n },\n \ \"default\" : \"organizationAdmin\"\n }\n }\n}\n\n \n" traits: - secured: usage: Apply this to any method that needs to be secured description: Requests requires authentication using a bearer token. headers: Authorization: description: Access token that is obtained from the /token endpoint of the oauth API. pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk required: true responses: 401: description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 403: description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getResponse: responses: 404: &3 description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 406: &1 description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: &2 description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - getSearchResponse: responses: 406: *1 500: *2 - postResponse: responses: 406: *1 415: &4 description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: *2 - deleteResponse: responses: 500: *2 - putResponse: responses: 404: *3 406: *1 409: &5 description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 415: *4 500: *2 - putCreateResponse: responses: 406: *1 409: *5 415: *4 500: *2 - pagableRequest: queryParameters: page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false minimum: 1 default: 50 maximum: 200 "/services": is: - secured description: collection endpoint for service resources. get: is: - getSearchResponse - pagableRequest description: Performs a search for service resources. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.service.v1+json type: string required: true 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 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 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 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 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 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 remoteAppId: description: Filter the search results by the given remote application id. type: string required: false mobileServiceId: description: Filter the search results by given mobile service id. type: string required: false sortBy: description: Sort the search results. Currently creation is the only sortable property. type: string required: false enum: - "+creation" - "-creation" 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\n___ \nSubstatus codes are mentioned below:\n+ framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName}\n+ search.services.request.invalid.combination.queryParamaters - Multiple {queryParameter} are not allowed.\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \ \n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema post: is: - postResponse description: Creates a new service. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.service.v1+json type: string required: true 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 "/{id}": uriParameters: id: description: Unique identifier of the service. type: string required: true is: - secured description: individual resource endpoint for service resources. get: is: - getResponse description: Returns the service by its unique id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.service.v1+json type: string required: true 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 "/packages": is: - secured description: collection endpoint for package resources get: is: - getSearchResponse - pagableRequest description: Performs a search for packages. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.v1+json type: string required: true 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 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 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 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 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 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 grantable: description: Return all packages that are flagged as grantable. type: boolean required: false requestable: description: Return all packages that are flagged as requestable. type: boolean required: false sortBy: description: Sort the search results according to creation timestamp property. type: string required: false enum: - "+creation" - "-creation" 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 post: is: - postResponse description: Creates a new service package with a default service. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.v1+json type: string required: true 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 "/{packageId}": description: individual resource endpoint for packages. uriParameters: packageId: description: Unique identifier of the package type: string required: true is: - secured get: is: - getResponse description: Returns the package by its id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.v1+json type: string required: true 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 "/services": description: collection endpoints for the services that are members of this package. is: - secured get: is: - getResponse description: get the services that are members of this package. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.service.v1+json type: string required: true 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\n___ \nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tasks/assignServiceMembership": is: - secured description: Assign services to a package post: is: - postResponse description: Assigns the given services as members of the package. headers: queryParameters: packageId: description: The package to add the services to. type: string maxLength: 100 required: true serviceId: description: The services to be added to the package. Multiple parameters are supported. type: string maxLength: 15 required: true 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 "/tasks/removeServiceMembership": is: - secured description: Remove services from a package post: is: - postResponse description: Removes the given services from the package. headers: queryParameters: packageId: description: The package to remove the services from. type: string required: true serviceId: description: The services to be removed from the package. Multiple parameters are supported. type: string required: true 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 "/persons/{personId}/packages": is: - secured 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 get: is: - getResponse - pagableRequest description: Performs a search for a person's package grants. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. type: string required: true 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 "/{packageId}": uriParameters: packageId: description: Unique identifier of the granted package. type: string required: true is: - secured description: individual resource endpoint for package grants get: is: - getResponse description: Returns the package grant headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. type: string required: true 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 put: is: - putResponse description: Grant (push) a package to a person. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.grant.v1+json type: string required: true 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 "/organizations/{organizationId}/packages": is: - secured 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 get: is: - getResponse - pagableRequest description: Performs a search for an organization's package grants. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. type: string required: true 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 "/{packageId}": uriParameters: packageId: description: Unique identifier of the granted package. type: string required: true is: - secured description: individual resource endpoint for package grants get: is: - getResponse description: Returns the package grant headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. type: string required: true 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\n___ \nSubstatus codes are mentioned below:\n+ service.package.grant.organization.invalid - The organization service package grant does not exist\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema put: is: - putResponse description: Grant (push) a package to an organization. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.grant.v1+json type: string required: true 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 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 "/requests": is: - secured description: collection endpoint for package request resources get: is: - getSearchResponse - pagableRequest description: Performs a search for package requests. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.request.v1+json type: string required: true queryParameters: requestor.id: description: The subject requesting the package. Mandatory if requestor.type query parameter is provided. type: string required: false requestor.type: description: The type of subject requesting the package. Mandatory if requestor.id query parameter is provided. type: string enum: - person - organization required: false 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 post: is: - postResponse description: Creates a new request for a package. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.request.v1+json type: string required: true 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\n___\nSubstatus codes are mentioned below:\n+ framework:request\n+ framework:request:io\n+ framework:request:io:read - Invalid input. There was an error while parsing.\n+ framework:request:io:read:parsing\n+ framework:request:io:write\n+ framework:request:header:missing - Missing request header: {headerName}\n+ framework:request:param:missing - Missing request parameter: {queryParameterName}\n+ framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}\n+ framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName}\n+ service.package.not.found - The requested service package does not exist.\n+ service.package.request.invalid.requestor.status - Service package cannot be requested by a requestor in UNACTIVATED status \n+ service.package.not.requestable - The requested service package was marked as non-requestable.\n+ service.package.request.parent.id.not.found - The parent request id was not found.\n+ requestor.type.invalid - Only person requestors are supported\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]\n+ service.package.request.invalid.requestor.type - Unsupported requestor type {requestorType}\n+ framework:resource:missing - The following resources were not found: {resources}\n" body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/{id}": uriParameters: id: description: Unique identifier of the package request type: string required: true is: - secured description: individual resource endpoint for package requests get: is: - getResponse description: Returns the package request headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.request.v1+json type: string required: true responses: 200: description: The package 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 delete: is: - deleteResponse description: Deletes (cancels) an existing package request. headers: 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 "/tasks/approve": is: - secured description: endpoint used to approve package requests for person requestors. post: is: - postResponse description: Approve a package request. headers: queryParameters: requestId: description: the request id. type: string required: true justification: description: optional justification for the decision. type: string maxLength: 1000 required: false 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 "/tasks/deny": is: - secured description: endpoint used to reject package requests for person requestors. post: is: - postResponse description: Deny a package request. headers: queryParameters: requestId: description: the request id. type: string required: true justification: description: optional justification for the denial. type: string maxLength: 1000 required: false 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 "/grants": is: - secured description: Search endpoint for package grants. get: is: - getSearchResponse - pagableRequest description: Performs a search for all grants of the specified package id. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.package.grant.v1+json type: string required: true queryParameters: grantedPackageId: description: the id of the granted package which is being searched. type: string required: true granteeType: description: The type of grantee to be filtered. Omit this parameter to retrieve grants for all grantees. required: false enum: - person - organization 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