PUT
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
/
versions
/
{version}
/
definitions
/
{definition_name}
curl --request PUT \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "name": "<string>",
  "accept": [
    "<string>"
  ],
  "description": "<string>",
  "schema": {
    "contentType": "application/schema+json",
    "content": "<string>"
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "accept": [
    "<string>"
  ],
  "description": "<string>",
  "url": "<string>",
  "referencedBy": [
    {
      "type": "definition",
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

​
organisation_id
string
required
​
connector_id
string
required

ID is the unique identifier of the Connector.

​
version
string
required

Version is the version name of the Connector 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

Body

application/json

DefinitionCommon is the common properties which are shared between Definitions for all of creation, retrieval and updates.

DefinitionUpdate is the payload used to update an existing Definition.

Response

200
application/json

OK

DefinitionCommon is the common properties which are shared between Definitions for all of creation, retrieval and updates.

Definition describes a single definition of a type which is used by the Connector. The schema language used is dependent on the media-type of the Definition, for example JSON Schema is used for media-types application/json.