#%RAML 0.8 title: batchRequest API baseUri: "https://api.covisintlabs.com/batchRequest/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", "description" : "The unique identifier for the resource." }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } , "required":[ "id" ] } - namedResourceReference: | { "id" : "http://api.covisint.com/schema/namedScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the basic resource reference and adds internationalized name and description.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceReference#" }, "properties" : { "name" : { "description": "Internationalized resource name.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized resource description.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" } } } - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource." }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - resourceV2: | { "id" : "http://api.covisint.com/schema/resourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resourceV2", "type" : "object", "description" : "A basic resource (version V2).", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource." }, "version": { "type" : "string", "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - realmScopedResource: | { "id" : "http://api.covisint.com/schema/realmScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the base resource and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resource#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.", "readonly": true } } , "required":[ "realm" ] } - realmScopedResourceV2: | { "id" : "http://api.covisint.com/schema/realmScopedResourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceV2#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.", "readonly": true } } , "required":[ "realm" ] } - errorResponseSchema: | { "id" : "http://api.covisint.com/schema/errorResponseSchema", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of an HTTP 4xx/5xx error response.", "properties" : { "status" : { "type" : "number", "minimum" : 400, "maximum" : 599, "description" : "The HTTP status code." }, "apiMessage" : { "type" : "string", "description" : "A helpful, human-readable description of the error, useful for basic diagnostics." }, "apiStatusCode" : { "type" : "string", "description" : "The API-specific status code." } } , "required":[ "status" ] } - serviceCode: | { "id" : "http://api.covisint.com/schema/serviceCodes", "$schema" : "http://json-schema.org/draft-04/schema", "type": "object", "description": "The site/service/location codes granted along with a service.", "properties": { "code": { "type": "string", "maxLength": 200, "description": "The code value." }, "codeKind": { "type": "string", "maxLength": 36, "description": "The associated business unit." } } , "required":[ "code", "codeKind" ] } - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type" : "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: | { "id" : "http://api.covisint.com/idm/schema/phone", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for phone number details.", "properties" : { "number" : { "type" : "string","maxLength" : 100, "description" : "The phone number." }, "type" : { "enum" : [ "main", "mobile", "fax" ], "description" : "The phone number type." } }, "required" : [ "type" ] } - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.", "extends": { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "name": { "description": "The application name (internationalized).", "$ref": "http://api.covisint.com/schema/internationalString#" }, "description": { "description": "The application description (internationalized).", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "properties":{ "type":"array", "description":"Properties used by the implementation.", "minItems":0, "items":[ { "anyOf": [ { "type": "string", "description": "The name of the property." }, { "type": "string", "description": "The value of the property." } ] } ] } , "required":[ "items" ] } , "required":[ "name" ] } - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } , "required":[ "type" ] } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ] } } , "required":[ "type" ] } - dataType: | { "id" : "http://api.covisint.com/schema/dataType", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Data type enum.", "enum":[ "string", "integer", "bool", "decimal" ] } - attribute: | { "id" : "http://api.covisint.com/schema/attribute", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "An attribute.", "properties" : { "oneOf" : [ { "attributeTypeId" : { "type" : "string", "description" : "The attribute type id." } }, { "attributeType" : { "description" : "The full attribute type definition.", "$ref" : "http://api.covisint.com/schema/attributeType#" } } ], "value" : { "type" : "any", "description" : "The attribute value." } } , "required":[ "attributeTypeId" ] } - attributes: | { "id" : "http://api.covisint.com/schema/attributes", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Collection of attributes.", "items" : { "$ref" : "http://api.covisint.com/schema/attribute#" } } - expression: | { "id" : "http://api.covisint.com/schema/expression#", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "The DSL for defining conditional expressions.", "oneOf" : [ { "type" : "object", "properties" : { "any" : { "type" : "array", "description" : "An aggregate expression representing an 'any' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "properties" : { "all" : { "type" : "array", "description" : "An aggregate expression representing an 'all' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "description" : "A simple leaf-node expression. The format of this expression is: '(f:, v:())'. The supported expressions are: equal, notEqual, startsWith, endsWith, matches, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual. The field name can be a simple field name i.e. 'id' or hierarchical field name using dot-notation like 'resource.id' / 'resource.tag[0]' . The value corresponding to the field name provided should always be a simple data type and cannot be an array or an object.", "properties" : { "expr" : { "type" : "string" } } , "required":[ "expr" ] } ] } - batchRequest: | { "id" : "http://api.covisint.com/schema/batchRequest#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an batch request resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "type": { "enum" : [ "PERSON_CREATE", "PERSON_SUSPEND", "PERSON_DELETE", "ORGANIZATION_CREATE", "PERSON_PACKAGE_GRANT", "ORGANIZATION_PACKAGE_GRANT" ], "description" : "The batch request type." }, "data": { "type" : "array", "description" : "The array of person or organization or servicePackageGrant." } } , "required" : [ "type", "data"] } - batchResponse: | { "id" : "http://api.covisint.com/schema/batchResponse#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an batch response resource.", "properties" : { "jobId": { "type" : "string", "description" : "The jobId of batch." } } } - person: | { "id" : "https://api.covisintlabs.com/batchRequest/v1/schema/personv1", "$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"] }, "readyToMigrate" : { "type" : "boolean", "description" : "whether or not person is ready to migrate." }, "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()", "required": true }, "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." }, "attributeTemplateId" : { "type" : "string", "maxLength" : 50, "description" : "template Id of an attribute." }, "attributes":{ "type": "array", "minItems": 0, "description": "The attribute templates for persons.", "items": { "id": { "type": "string", "description": "The key name for the person's attribute template data." }, "name": { "type": "string", "description": "The name of the extended attribute." }, "value": { "type": "string", "description": "The text value." } } } }, "required" : [ "language", "timezone", "email", "organization", "attributeTemplateId", "attributes"] } - organization: | { "id" : "https://api.covisintlabs.com/batchRequest/v1/schema/organization/v1", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema respreseing an organization resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 100 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, and will be ignored for POST requests." }, "status" : { "enum" : [ "active", "suspended", "inactive", "unactivated" ], "description" : "The organization's status. This property is read-only. Status can be changed through tasks." }, "parentOrganization": { "description": "The parent organization. Used to create an organization hierarchy. Required only when creating a division, read only when updating.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "rootOrganization": { "description": "The organization at the root of this hierarchy. This is the top-most organization that does not have a parent. This property is read-only.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "name" : { "type" : "string", "description" : "The organization's name.", "maxLength" : 244 }, "addresses" : { "type" : "array", "description" : "A container for the organization's addresses.", "minItems" : 1, "items" : { "ref" : "http://api.covisint.com/schema/address#", "properties" : { "streets" : { "minItems" : 1 }, "city" : { "description" : "The organization's city." }, "state" : { "description" : "The organization's state." }, "country" : { "description" : "The organization's country." } } } }, "phones" : { "type" : "array", "description" : "A container for the organization's phone number(s).", "minItems" : 0, "items" : { "$ref" : "http://api.covisint.com/schema/phone#" } }, "email" : { "type" : "string", "maxLength" : 1000, "description" : "The organization's email address." }, "url" : { "type" : "string", "description" : "A URL representing this organization.", "maxLength" : 1000 }, "authDomain" : { "type" : "string", "description" : "This organization's authentication domain.", "maxLength" : 50 }, "organizationType" : { "type" : "string", "description" : "The organization type. Unless there is reason to specify otherwise, this value doesn't need to be provided and will be defaulted.", "maxLength" : 5, "default" : "AO" }, "organizationSubtype" : { "type" : "string", "description" : "The organization subtype. Unless there is reason to specify otherwise, this value doesn't need to be provided and will be defaulted.", "maxLength" : 10 }, "accountNumber" : { "type" : "string", "description" : "The organization account number.", "maxLength" : 50 }, "externalCode" : { "type" : "string", "description" : "Code assigned to identify the organization to external systems.", "maxLength" : 50 }, "duns" : { "type" : "string", "description" : "The organization DUNS number.", "maxLength" : 50 }, "classification" : { "type" : "string", "description" : "The organization classification.", "maxLength" : 100 }, "public" : { "type" : "boolean", "description" : "Whether this is a public organization. Defaults to true." }, "passwordPolicy" : { "description": "The password policy associated to this particular organization.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "authenticationPolicy" : { "description": "The authentication policy associated to this particular organization.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "attributes":{ "type": "array", "minItems": 1, "description": "The extended attributes for organization.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the extended attribute." }, "name": { "type": "string", "description": "The name of the extended attribute." }, "value": { "type": "string", "description": "The value of the extended attribute." } } } } } } - packageGrant: | { "id": "https://api.covisintlabs.com/batchRequest/v1/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": "id of grantee (organization/person)." }, "servicePackages.id": { "type": "array", "minItems": 0, "description": "List of service package ids", "items": { "servicePackages.id": { "type": "string", "description": "Service Package Id" } } } }, "required": ["id", "servicePackages.id"] } - jobDetails: | { "id" : "http://api.covisint.com/schema/jobDetails#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an batch request job details.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "data": { "type": "array", "items": { "type": "object", "properties": { "generatedId": { "type": "string", "description" : "The CUID generated for the resource.", "maxLength" : 244 }, "inputId": { "type": "string", "description" : "The username(IdpUserId) provided by requestor.", "maxLength" : 244 }, "status": { "enum" : [ "complete", "incomplete", "inprogress","success","failed" ], "description" : "The item status." }, "errorMessage": { "type" : "string", "description" : " message giving details why the item failed .", "maxLength" : 244 }, "processDate": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "Time at which item was proccessed." } }, "required" : [ "generatedId", "inputId", "processDate"] } }, "jobId": { "type": "string", "description" : "The bulk migartion type.", "maxLength" : 244 }, "status": { "enum" : [ "complete", "incomplete", "inprogress","success","failed" ], "description" : "The job status." }, "errorMessage": { "type" : "string", "description" : " message giving details why the job failed .", "maxLength" : 244 }, "startDate": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "time at which the batch process for the given batch request started " }, "endDate": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "time at which the batch process for the given batch request completed " }, "required" : [ "jobId", "startDate", "endDate"] } 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 /batchRequest: description: "Collection endpoint for batch request.[Since:1.0]" is: [secured] post: description: "batch request with array of resource list. [visibility:public][Since:1.0][Flow-name:batchRequest-create-batchRequest]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.migrate.bulk.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.migrate.bulk.v1+json: schema: batchRequest responses: "201": description: The batch request is successfully completed. body: application/vnd.com.covisint.platform.migrate.bulk.v1+json: schema: batchResponse "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:data:illegal - The following properties contained illegal values: Status shoud be active/inactive for authdomain which is different than realm 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] /{jobId}: description: "Collection endpoint for getting the status of batch request.[Since:1.0]" uriParameters: jobId: displayName: jobId type: string required: true repeat: false is: [secured] get: description: "job status of batch request. [Since:1.0][Flow-name:batchRequest-get-status][visibility:public]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.migrate.bulk.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.migrate.bulk.v1+json: schema: jobDetails responses: "200": description: The job status is successfully retieved. body: application/vnd.com.covisint.platform.migrate.bulk.v1+json: schema: jobDetails "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "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] /upload: description: "Upload a batch request file.[Since:1.3]" is: [secured] post: description: "Upload a batch request file. [Since:1.3][Flow-name:batchRequest-upload][visibility:public]" headers: Accept: description: Media type. type: string required: true repeat: false example: multipart/form-data.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: multipart/form-data: formParameters: file: description: The file to be uploaded. Supported Formats is csv. type: file required: true repeat: false type: description: The type of operation for bulk load. type: string required: true repeat: false enum: [PERSON_PACKAGE_REVOKE, PERSON_PACKAGE_SUSPEND, PACKAGE_CLAIM_ACTIVE, PACKAGE_CLAIM_INACTIVE, PERSON_PACKAGE_GRANT, PERSON_PACKAGE_CLAIM_VALUE_GRANT] "<>": description: "<> is required for type {type} ." type: string required: false repeat: false "<>": description: "<> if this parameter set to true then user package grants is revoked irrespective of status." type: string required: false repeat: false "<>": description: "<> if this parameter set to true then organization package grants is suspended for the claimType of CODE And it is applied for type PACKAGE_CLAIM_INACTIVE" type: string required: false repeat: false "<>": description: "<> if this parameter set to true then organization package grants is revoked for the claimType of CODE irrespective of status And it is applied for type PACKAGE_CLAIM_INACTIVE" type: string required: false repeat: false "<>": description: "<> for the above specific type." type: string required: false repeat: false responses: "201": description: The batch request is successfully completed. body: multipart/form-data.json: schema: batchResponse "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + upload.missing.metadata - Reason metadata is missing. + upload.missing.metadata - ForceRevokeGrants metadata is missing. + upload.invalid.metadata - Invalid metadata. ForeRequestGrants is not allowed for type {type} + upload.invalid.metadata - Invalid forceRevokeGrants. Allowed values are [ true , false ]. + upload.invalid.file.size - File should not have more than {csvmaxRows} lines. + upload.invalid.metadata - Reason is empty. + upload.invalid.metadata - Invalid reason. Invalid characters found [ = and , ] + upload.invalid.metadata - Invalid reason. Length of reason cannot exceed more then 50 characters. + upload.missing.file - File is missing. + upload.missing.file - File is empty. Upload proper file. + upload.missing.Type - Type is missing. + upload.invalid.file - Invalid file. Upload a csv file. + pip.metadata.invalid.authorize.action.type - Invalid authorize action type: {type}. + upload.invalid.type - Invalid type. Allowed values are + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + upload.invalid.key - Invalid key. Allowed only for [skipStatusCheck, reason, type, revokeOrganizationPackageGrant] + upload.invalid.file - Invalid csv headers. Allowed headers [PACKAGEID, CLAIMTYPE, CLAIMID]. + upload.invalid.file - Invalid csv headers. Allowed headers [PACKAGEID, USERID] Or [PACKAGEID, USERNAME]. + upload.invalid.file - Invalid csv headers. Allowed headers [PACKAGEID, USERNAME, CLAIMTYPE, CLAIMID, CLAIMVALUE] Or [PACKAGEID, SSOUSERID, CLAIMTYPE, CLAIMID, CLAIMVALUE]. + upload.invalid.metadata - Invalid metadata. RevokeOrganizationPackageGrant is not allowed for type {type} 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]