Update Definition - Versori User Documentation

PUT

{organisation_id}

connectors

{connector_id}

versions

{version}

definitions

{definition_name}

Update Definition

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>"
}
'

import requests

url = "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}"

payload = {
    "id": "<string>",
    "name": "<string>",
    "accept": ["<string>"],
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    name: '<string>',
    accept: ['<string>'],
    description: '<string>'
  })
};

fetch('https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'name' => '<string>',
    'accept' => [
        '<string>'
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"accept\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("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")
  .body("{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"accept\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"accept\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "accept": [
    "<string>"
  ],
  "url": "<string>",
  "description": "<string>",
  "referencedBy": [
    {
      "type": "definition",
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<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<ulid>

required

connector_id

string<ulid>

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

DefinitionUpdate is the payload used to update an existing Definition.

string<ulid>

required

ID is the unique identifier of the Definition. This must be set for updates.

name

string

required

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

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.

schema

object

InlineSchema is a Schema which is defined inline within the Definition. This is typically used when creating or updating a Definition and the actual schema payload is sent with the request. For retrieval operations, the Definition will contain a URL which resolves to the Schema.

Show child attributes

Response

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.

string<ulid>

required

ID is the unique identifier of the Definition.

name

string

required

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

string[]

required

url

string<uri>

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 connection, for example:

https://platform.versori.com/api/schemas/v1/o/{organisation_id}/{connector_id}/{connector_version}/{definition_slug}.{media_type_ext}

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.

referencedBy

object[]

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

Show child attributes

⌘I

Update Definition

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>"
}
'

import requests

url = "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}"

payload = {
    "id": "<string>",
    "name": "<string>",
    "accept": ["<string>"],
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    name: '<string>',
    accept: ['<string>'],
    description: '<string>'
  })
};

fetch('https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'name' => '<string>',
    'accept' => [
        '<string>'
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"accept\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("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")
  .body("{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"accept\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/definitions/{definition_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"accept\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "accept": [
    "<string>"
  ],
  "url": "<string>",
  "description": "<string>",
  "referencedBy": [
    {
      "type": "definition",
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<string>"
}