GET
/
o
/
{organisation_id}
/
connections
/
{connection_id}
/
versions
/
{version}
/
definitions
/
{definition_name}
curl --request GET \
  --url https://platform.versori.com/api/connect/v1alpha1/o/{organisation_id}/connections/{connection_id}/versions/{version}/definitions/{definition_name}
{
  "id": "<string>",
  "accept": [
    "<string>"
  ],
  "description": "<string>",
  "name": "<string>",
  "referencedBy": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "definition"
    }
  ],
  "url": "<string>"
}

Authorizations

cookie
string
cookierequired

Cookie authentication used by the Versori Platform.

Path Parameters

organisation_id
string
required
connection_id
string
required

ID is the unique identifier of the Connection.

version
string
required

Version is the version name of the Connection to retrieve. The reserved names "latest" and "default" may be used to retrieve the latest version or the default version respectively.

definition_name
string
required

Response

200 - application/json
id
string
required

ID is the unique identifier of the Definition.

accept
string[]
required

Accept indicates which content types, expressed as MIME types, that this definition can accept. This value is analogous to the Accept HTTP header, as defined in RFC 7231, section 5.3.2, except each type is defined in a separate array element, rather than as a comma-separated list.

This does not represent the content type of the schema body itself, but the data which conforms to this definition. For example, an API may respond in JSON or YAML, but the schema may be a YAML-formatted JSON Schema. In this case, the Definition's accept field could be ["application/json", "text/yaml"] and schema.contentType will be application/schema+yaml.

description
string

Description is a human-friendly description of the Definition. This is typically used to describe the purpose of the Definition and how it should be used.

name
string
required

Name is a unique identifier for the Definition within the scope of the Connection. It is expected to both human and machine-readable, i.e. "Product" or "product_variant".

referencedBy
object[]

ReferencedBy is a list of DefinitionReference objects which defines what other entities are referencing the this Definition.

url
string
required

URL is the location of the actual Schema definition for this Definition entity.

The structure of this URL will be consistent across all media types for each environment, for example:

  • https://platform.versori.com/api/schemas/v1/o/{organisation_id}/{connection_id}/{connection_version}/{definition_slug}.{media_type_ext}