#%RAML 0.8 title: Datahub Trading Partner API baseUri: https://api.us1.covisint.com/tradingPartner/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.", "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: | { "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.", "required": true }, "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.", "required": false }, "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.", "required": true, "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.", "required": true, "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.", "required": true, "readonly": true } } } } } - resourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/resourceV2\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Core schema\",\n \ \"definitions\" : {\n \"resource\" : {\n \"id\" : \"resourceV2\",\n \ \"type\" : \"object\",\n \"description\" : \"A basic resource (version V2).\",\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\" : \"string\",\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 read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.\",\n \"required\": true,\n \ \"readonly\": true\n },\n \"creatorAppId\" : {\n \"type\" : \"string\",\n \"maxLength\" : 64,\n \"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.\",\n \"required\": true,\n \"readonly\": true\n },\n \ \"creation\" : {\n \"type\" : \"number\",\n \"minimum\" : 0,\n \"maximum\" : 9223372036854775807,\n \"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.\",\n \ \"required\": true,\n \"readonly\": true\n }\n }\n \ }\n } \n}\n" - realmScopedResource: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"Expands on the base resource and adds a realm attribute.\",\n \ \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resource#\"\n \ },\n \"properties\" : {\n \"realm\" : {\n \"type\" : \"string\",\n \ \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"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.\",\n \"required\": true,\n \"readonly\": true \n \ }\n }\n}\n" - realmScopedResourceV2: "{\n \"id\" : \"http://api.covisint.com/schema/realmScopedResourceV2\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\" : {\n \"$ref\" : \"http://api.covisint.com/schema/resourceV2#\"\n },\n \"properties\" : {\n \ \"realm\" : {\n \"type\" : \"string\",\n \"maxLength\" : 25,\n \"pattern\" : \"^[A-Za-z0-9]{2,25}$\",\n \"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.\",\n \"required\": true,\n \"readonly\": true \n }\n }\n} \n" - 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" - 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" : { "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." } } } } - 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: "{\n \"id\" : \"http://api.covisint.com/schema/baseDefinitionResource\",\n \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \ \"description\" : \"A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.\",\n \"extends\": {\n \"$ref\" : \"http://api.covisint.com/schema/realmScopedResourceV2#\"\n },\n \"properties\": {\n \"name\": {\n \"description\": \"The application name (internationalized).\",\n \ \"required\": true,\n \"$ref\": \"http://api.covisint.com/schema/internationalString#\"\n \ },\n \"description\": {\n \"required\": false,\n \"description\": \"The application description (internationalized).\",\n \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n \ }, \n \"properties\":{\n \"type\":\"array\",\n \"description\":\"Properties used by the implementation.\",\n \"required\":false,\n \"minItems\":0,\n \ \"items\":[ \n { \n \"anyOf\": [\n {\n \ \"type\": \"string\",\n \"description\": \"The name of the property.\",\n \"required\": true\n },\n \ {\n \"type\": \"string\",\n \"description\": \"The value of the property.\",\n \"required\": true\n }\n \ ]\n }\n ]\n }\n }\n}\n" - 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 } } } - 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": true } } } - dataType: "{\n \"id\" : \"http://api.covisint.com/schema/dataType\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"Data type enum.\",\n \"enum\":[ \n \"string\",\n \"integer\",\n \"bool\",\n \ \"decimal\"\n ]\n}\n" - attribute: "{\n \"id\" : \"http://api.covisint.com/schema/attribute\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"object\",\n \"description\" : \"An attribute.\",\n \"properties\" : {\n \"oneOf\" : [\n {\n \"attributeTypeId\" : {\n \"type\" : \"string\",\n \"description\" : \"The attribute type id.\",\n \"required\" : true\n }\n },\n { \n \"attributeType\" : {\n \"description\" : \"The full attribute type definition.\",\n \"$ref\" : \"http://api.covisint.com/schema/attributeType#\" \n }\n }\n ],\n \ \"value\" : {\n \"type\" : \"any\",\n \"description\" : \"The attribute value.\",\n \"required\" : false\n }\n }\n}\n" - attributes: "{\n \"id\" : \"http://api.covisint.com/schema/attributes\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"type\" : \"array\",\n \"description\" : \"Collection of attributes.\",\n \"items\" : { \n \"$ref\" : \"http://api.covisint.com/schema/attribute#\"\n \ }\n}\n" - expression: "{\n \"id\" : \"http://api.covisint.com/schema/expression#\",\n \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n \"description\" : \"The DSL for defining conditional expressions.\",\n \"oneOf\" : [\n {\n \"type\" : \"object\",\n \"properties\" : {\n \"any\" : {\n \"type\" : \"array\",\n \"description\" : \"An aggregate expression representing an 'any' condition.\",\n \"items\" : {\n \"$ref\" : \"http://api.covisint.com/schema/expression#\"\n }\n }\n \ }\n },\n {\n \"type\" : \"object\",\n \"properties\" : {\n \"all\" : {\n \"type\" : \"array\",\n \"description\" : \"An aggregate expression representing an 'all' condition.\",\n \"items\" : {\n \"$ref\" : \"http://api.covisint.com/schema/expression#\"\n \ }\n }\n }\n },\n {\n \"type\" : \"object\",\n \"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.\",\n \"properties\" : {\n \"expr\" : {\n \"type\" : \"string\",\n \"required\" : \"true\"\n }\n }\n }\n ]\n}\n \n" - tradingPartners: | { "id": "http://api.covisint.com/schema/tradingPartner", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of Trading Partner definitions.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/tradingPartner#" } } - tradingPartner: | { "id":"http://api.covisint.com/schema/tradingPartner", "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "description": "Trading Partner API description.", "extends":{ "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties":{ "name" : { "description": "Internationalized name. Language code must be a valid ISO language code.", "required": true, "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized description. Language code must be a valid ISO language code.", "required": false, "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "status" : { "enum": [ "ACTIVE", "INACTIVE" ], "description":"status of Trading Partner Relationship.", "default":"INACTIVE", "readOnly": true } } } - applications: | { "id": "http://api.covisint.com/schema/application", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of Trading Partner codes.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/application#" } } - application: | { "id":"http://api.covisint.com/schema/application", "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "description": "Trading Partner application description.", "extends":{ "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties":{ "tradingPartnerId": { "description": "The Trading Partner Id.", "type": "string", "required": true }, "applications": { "required": true, "type":"array", "description":"The list of application ids.", "minItems":0, "items":[ { "type": "string", "description": "Value of the application id.", "required": true } ] } } } - tradingPartnerRelationships: | { "id": "http://api.covisint.com/schema/tradingPartnerRelationship", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of Trading Partner Relationship.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/tradingPartnerRelationship#" } } - tradingPartnerRelationship: | { "id":"http://api.covisint.com/schema/tradingPartnerRelationship", "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "description": "Trading Partner relationship API description.", "extends":{ "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties":{ "description" : { "description": "Internationalized description. Language code must be a valid ISO language code.", "required": false, "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "requestorTradingPartnerId": { "description": "The id of the requstor trading partner id.", "type": "string", "required": true, "readOnly": false }, "approverTradingPartnerId": { "description": "The id of the approver trading partner id.", "type": "string", "required": true, "readOnly": false }, "status" : { "enum": [ "PENDING_APPROVAL", "ACTIVE", "INACTIVE" ], "description":"status of Trading Partner Relationship.", "default":"PENDING_APPROVAL", "readOnly": true } } } - codes: | { "id": "http://api.covisint.com/schema/code", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of Trading Partner codes.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/code#" } } - code: | { "id":"http://api.covisint.com/schema/code", "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "description": "Trading Partner code description.", "extends":{ "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties":{ "description" : { "description": "Internationalized description. Language code must be a valid ISO language code.", "required": false, "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "code": { "description": "The code.", "type": "string", "required": true }, "tradingPartnerId": { "description": "The Trading Partner Id.", "type": "string", "required": true, "readOnly": true }, "qualifier": { "description": "The qualifier.", "type": "string", "required": false }, "status" : { "enum": [ "ACTIVE", "INACTIVE" ], "description":"status of Trading Partner Relationship.", "default":"INACTIVE", "readOnly": true } } } - codeRelationships: | { "id": "http://api.covisint.com/schema/codeRelationship", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of Trading Partner codes.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/codeRelationship#" } } - codeRelationship: | { "id":"http://api.covisint.com/schema/codeRelationship", "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "description": "Trading Partner codeRelationship description.", "extends":{ "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties":{ "description" : { "description": "Internationalized description. Language codeRelationship must be a valid ISO language codeRelationship.", "required": false, "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "fromCodeId": { "description": "The from Code Id.", "type": "string", "required": true, "readOnly": false }, "toCodeId": { "description": "The to Code Id.", "type": "string", "required": true, "readOnly": false }, "fromTradingPartnerId": { "description": "The from Trading Partner Id.", "type": "string", "required": true, "readOnly": false }, "toTradingPartnerId": { "description": "The to Trading Partner Id.", "type": "string", "required": true, "readOnly": false }, "status" : { "enum": [ "ACTIVE", "INACTIVE" ], "description":"status of Trading Partner Relationship.", "default":"INACTIVE", "readOnly": true } } } - routingSourceRelationships: | { "id": "http://api.covisint.com/schema/routingSourceRelationship", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of Trading Partner codes.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/routingSourceRelationship#" } } - routingSourceRelationship: | { "id":"http://api.covisint.com/schema/routingSourceRelationship", "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "description": "Trading Partner routingSourceRelationship description.", "extends":{ "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties":{ "senderOwnerId": { "description": "The sender Owner Id.", "type": "string", "required": false, "readOnly": false }, "receiverOwnerId": { "description": "The receiver Owner Id.", "type": "string", "required": true, "readOnly": false }, "documentInfoId": { "description": "The document Info Id.", "type": "string", "required": false, "readOnly": false }, "fromCodeId": { "description": "The from Code Id.", "type": "string", "required": false, "readOnly": false }, "toCodeId": { "description": "The to Code Id.", "type": "string", "required": false, "readOnly": false }, "status" : { "enum": [ "ACTIVE", "INACTIVE" ], "description":"status of Trading Partner Relationship.", "default":"INACTIVE", "readOnly": true } } } - contacts: | { "id": "http://api.covisint.com/schema/contact", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of Trading Partner codes.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/contact#" } } - contact: | { "id":"http://api.covisint.com/schema/contact", "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "description": "Trading Partner contact description.", "extends":{ "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties":{ "tradingPartnerId": { "description": "The Trading Partner Id.", "type": "string", "required": true, "readOnly": false }, "title": { "description": "The title.", "type": "string", "required": false }, "firstName": { "description": "The first Name.", "type": "string", "required": true }, "lastName": { "description": "The last Name.", "type": "string", "required": true }, "address": { "description": "The address.", "type": "string", "required": true }, "city": { "description": "The city.", "type": "string", "required": false }, "email": { "description": "The email.", "type": "string", "required": false }, "phoneNumber": { "description": "The phoneNumber.", "type": "string", "required": false }, "cellNumber": { "description": "The cellNumber.", "type": "string", "required": false } } } - tradingPartnerAddresses: | { "id": "http://api.covisint.com/schema/address", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of Trading Partner Addresses.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/address#" } } - tradingPartnerAddress: | { "id":"http://api.covisint.com/schema/address", "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "description": "Trading Partner address description.", "extends":{ "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties":{ "tradingPartnerId": { "description": "The Trading Partner Id.", "type": "string", "required": true, "readOnly": false }, "address1": { "description": "The address1.", "type": "string", "required": true }, "address2": { "description": "The address2.", "type": "string", "required": true }, "city": { "description": "The city.", "type": "string", "required": true }, "stateProvidence": { "description": "The stateProvidence.", "type": "string", "required": true }, "postalCode": { "description": "The postalCode.", "type": "string", "required": true }, "countryCode": { "description": "The countryCode.", "type": "string", "required": true } } } traits: - secured: usage: Apply this to any method that needs to be secured. Requests with this trait require 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: &6 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: &7 description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema - unsecured: usage: Apply this to any method that needs to be unsecured. Requests with this trait do not require any authentication. headers: SolutionInstanceId: description: The solution instance id. example: abcd123e-0109-441c-8a20-123a456b789c required: true responses: 400: description: Bad request. Please provide the valid solution instance id. 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 - putResponseV2: responses: 404: *3 406: *1 409: description: | There is a conflict in identifying the resource being acted on. The unique identifier in the URL and body are different. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 415: *4 500: *2 - putCreateResponse: responses: 406: *1 409: *5 415: *4 500: *2 - taskResponse: responses: 401: *6 403: *7 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 - taggable: queryParameters: tag: description: Get the resource based on specified tag. Multiple parameters are allowed and the search results will be a union. type: string required: false - sortable: queryParameters: sortBy: description: Sort the results based on some criteria. example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). type: string required: false - searchable: description: Search resources based on the given filter parameters. Search is case-insensitive. <> <> "/tradingPartners": post: is: - postResponse - secured description: Trading Partner API. headers: Accept: description: Media type. example: application/vnd.com.covisint.platform.trading.partner.v1+json type: string required: true Content-Type: description: The Content type example: application/vnd.com.covisint.platform.trading.partner.v1+json type: string required: true body: application/vnd.com.covisint.platform.trading.partner.v1+json: schema: tradingPartner responses: 201: description: Trading Partner was successfully added. body: application/vnd.com.covisint.platform.trading.partner.v1+json: schema: tradingPartner 400: description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema%RAML 0.8 get: is: - pagableRequest - sortable - getSearchResponse - secured description: List all trading partner. headers: Accept: description: The media type for v1 trading partner. Specify parameter fetchcodes with a value of true to return the associated codes list nested within the trading partner resource. Specify parameter fetchcontacts with a value of true to return the associated contacts list nested within the trading partner resource. Specify parameter fetchapplications with a value of true to return the associated application list nested within the trading partner resource. Specify parameter fetchcoderelationships with a value of true to return the associated code relationship information nested within the trading partner resource. Specify parameter fetchrelationships with a value of true to return the associated relationship information nested within the trading partner resource. Specify parameter fetchaddresses with a value of true to return the associated address information nested within the trading partner resource. example: application/vnd.com.covisint.platform.trading.partner.v1+json;fetchcodes=true; fetchcontacts=true; fetchapplications=true;fetchcoderelationships=true; fetchrelationships=true;fetchaddresses=true type: string required: true Content-Type: description: The Content type example: application/vnd.com.covisint.platform.trading.partner.v1+json type: string required: true queryParameters: address: description: Retrieve trading partner with the specified address. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false routingSourceRelationship: description: Retrieve trading partner with the specified routingSourceRelationship. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. the pattern would be datapoints=key:>value. type: string required: false creation: description: Retrieve trading partner with the specified creation. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. the pattern would be creation=>value1&creation=value1&creation=value. type: string required: false sortBy: description: Sort the search results. type: string required: false enum: - "+creation" - "-creation" - "-status" - "+status" responses: 200: description: The trading partner was successfully retrieved. body: application/vnd.com.covisint.platform.trading.partner.v1+json: schema: tradingPartner 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: | There was an unhandled server-side error. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: description: Delete an existing trading partner. Throws an error if {id} does not already exist. headers: is: - secured responses: 204: description: Successfully deleted the trading partner. 400: description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 404: description: | The requested trading partner was not found. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema 500: description: | There was an unhandled server-side error. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "/tradingPartners/count": get: is: - pagableRequest - sortable - getSearchResponse - secured description: End point for a count of trading partner. headers: Accept: description: Media type. example: text/plain type: string required: true Content-Type: description: The Content type example: application/vnd.com.covisint.platform.trading.partner.v1+json type: string required: true queryParameters: tradingPartnerRelationship: description: Retrieve attribute types with the specified tradingPartnerRelationship. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false codeRelationship: description: Retrieve attribute types with the specified codeRelationship. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false codes: description: Retrieve attribute types with the specified codes. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false contacts: description: Retrieve attribute types with the specified contacts. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false address: description: Retrieve attribute types with the specified address. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. type: string required: false creation: description: Retrieve attribute types with the specified creation. Case-insensitive, wild card and fuzzy search is supported. Multiple parameters are allowed and the search results will be a union. the pattern would be creation=>value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=value1&creation=