Create Action - Versori User Documentation

POST

{organisation_id}

connectors

{connector_id}

versions

{version}

actions

Create Action

curl --request POST \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "http",
  "name": "<string>",
  "path": "<string>",
  "parameters": [
    {
      "name": "<string>",
      "required": true,
      "default": "<unknown>",
      "completion": {}
    }
  ],
  "responses": [
    {
      "definitions": [
        {
          "definition": {
            "id": "<string>"
          }
        }
      ],
      "status": 123
    }
  ],
  "summary": "<string>",
  "description": "<string>"
}
'

import requests

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

payload = {
    "type": "http",
    "name": "<string>",
    "path": "<string>",
    "parameters": [
        {
            "name": "<string>",
            "required": True,
            "default": "<unknown>",
            "completion": {}
        }
    ],
    "responses": [
        {
            "definitions": [{ "definition": { "id": "<string>" } }],
            "status": 123
        }
    ],
    "summary": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'http',
    name: '<string>',
    path: '<string>',
    parameters: [{name: '<string>', required: true, default: '<unknown>', completion: {}}],
    responses: [{definitions: [{definition: {id: '<string>'}}], status: 123}],
    summary: '<string>',
    description: '<string>'
  })
};

fetch('https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/actions', 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}/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'http',
    'name' => '<string>',
    'path' => '<string>',
    'parameters' => [
        [
                'name' => '<string>',
                'required' => true,
                'default' => '<unknown>',
                'completion' => [
                                
                ]
        ]
    ],
    'responses' => [
        [
                'definitions' => [
                                [
                                                                'definition' => [
                                                                                                                                'id' => '<string>'
                                                                ]
                                ]
                ],
                'status' => 123
        ]
    ],
    'summary' => '<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}/actions"

	payload := strings.NewReader("{\n  \"type\": \"http\",\n  \"name\": \"<string>\",\n  \"path\": \"<string>\",\n  \"parameters\": [\n    {\n      \"name\": \"<string>\",\n      \"required\": true,\n      \"default\": \"<unknown>\",\n      \"completion\": {}\n    }\n  ],\n  \"responses\": [\n    {\n      \"definitions\": [\n        {\n          \"definition\": {\n            \"id\": \"<string>\"\n          }\n        }\n      ],\n      \"status\": 123\n    }\n  ],\n  \"summary\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/actions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"http\",\n  \"name\": \"<string>\",\n  \"path\": \"<string>\",\n  \"parameters\": [\n    {\n      \"name\": \"<string>\",\n      \"required\": true,\n      \"default\": \"<unknown>\",\n      \"completion\": {}\n    }\n  ],\n  \"responses\": [\n    {\n      \"definitions\": [\n        {\n          \"definition\": {\n            \"id\": \"<string>\"\n          }\n        }\n      ],\n      \"status\": 123\n    }\n  ],\n  \"summary\": \"<string>\",\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}/actions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"http\",\n  \"name\": \"<string>\",\n  \"path\": \"<string>\",\n  \"parameters\": [\n    {\n      \"name\": \"<string>\",\n      \"required\": true,\n      \"default\": \"<unknown>\",\n      \"completion\": {}\n    }\n  ],\n  \"responses\": [\n    {\n      \"definitions\": [\n        {\n          \"definition\": {\n            \"id\": \"<string>\"\n          }\n        }\n      ],\n      \"status\": 123\n    }\n  ],\n  \"summary\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "type": "http",
  "name": "<string>",
  "method": "GET",
  "path": "<string>",
  "parameters": [
    {
      "name": "<string>",
      "in": "cookie",
      "required": true,
      "type": "string",
      "default": "<unknown>",
      "completion": {}
    }
  ],
  "responses": [
    {
      "id": "<string>",
      "definitions": [
        {
          "id": "<string>",
          "definition": {
            "id": "<string>",
            "name": "<string>",
            "accept": [
              "<string>"
            ],
            "url": "<string>",
            "description": "<string>",
            "referencedBy": [
              {
                "type": "definition",
                "id": "<string>",
                "name": "<string>"
              }
            ]
          }
        }
      ],
      "status": 123
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "severity": "error"
    }
  ],
  "summary": "<string>",
  "description": "<string>",
  "requestBody": {
    "required": true,
    "definitions": [
      {
        "id": "<string>",
        "definition": {
          "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.

Body

application/json

ActionCreate defines a new Action to be created.

type

enum<string>

required

Available options:

http

Allowed value: "http"

name

string

required

Name is a unique identifier for the Action within the scope of the Connector. It is expected to both human and machine-readable, i.e. "GetProduct" or "get_products", see the validation regex for more details.

method

enum<string>

required

HTTPMethod defines the HTTP method which will be used when invoking the Action. This is typically one of the standard HTTP methods such as GET, POST, PUT, PATCH or DELETE, but may be any valid HTTP method.

Available options:

GET,

POST,

PUT,

PATCH,

DELETE,

HEAD,

OPTIONS,

CONNECT,

TRACE

path

string

required

ActionPath is appended to the Connector's base URL to build the full URL to send requests to. It may also contain placeholders to inject dynamic values from the following sources:

{{ param.<name> }} - Injects the value of the parameter with the given name.
{{ conn.<name> }} - Injects the value of the connection variable with the given name.

parameters

object[]

required

Show child attributes

responses

object[]

required

Responses defines the expected responses from the HTTP endpoint. This is used to determine whether the Action was successful or not. At least one response must be defined in order for the Action to be valid.

Show child attributes

summary

string

Summary is a human-readable version of the id field, i.e. "Get Product" or "Get Products". This is used when displaying the Action to users, however if omitted the actionId can be used to display to users instead.

description

string

Description is a human-readable description of the Action. It can provide extra information to users about how the Action operates and anything the user may need to be aware of when using it.

requestBody

object

ActionHTTPRequestBody defines whether a request body is required for a particular HTTP Action, and if so which Definitions are considered valid. If this value is undefined then no request body will be sent.

Show child attributes

Response

Created

ActionHTTP defines an HTTP Action.

string

required

ID is the unique identifier of the Action.

type

enum<string>

required

Available options:

http

Allowed value: "http"

name

string

required

method

enum<string>

required

Available options:

GET,

POST,

PUT,

PATCH,

DELETE,

HEAD,

OPTIONS,

CONNECT,

TRACE

path

string

required

ActionPath is appended to the Connector's base URL to build the full URL to send requests to. It may also contain placeholders to inject dynamic values from the following sources:

{{ param.<name> }} - Injects the value of the parameter with the given name.
{{ conn.<name> }} - Injects the value of the connection variable with the given name.

parameters

object[]

required

Show child attributes

responses

object[]

required

Responses defines the expected responses from the HTTP endpoint. This is used to determine whether the Action was successful or not.

Show child attributes

errors

object[]

Errors is a list of ErrorField objects which defines the errors which may be returned by the Action. An empty array denotes that the Action has been validated and no errors were found. If this field is undefined then this means validation has not occurred.

Show child attributes

summary

string

description

string

Description is a human-readable description of the Action. It can provide extra information to users about how the Action operates and anything the user may need to be aware of when using it.

requestBody

object

Show child attributes

⌘I

Create Action

curl --request POST \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "http",
  "name": "<string>",
  "path": "<string>",
  "parameters": [
    {
      "name": "<string>",
      "required": true,
      "default": "<unknown>",
      "completion": {}
    }
  ],
  "responses": [
    {
      "definitions": [
        {
          "definition": {
            "id": "<string>"
          }
        }
      ],
      "status": 123
    }
  ],
  "summary": "<string>",
  "description": "<string>"
}
'

import requests

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

payload = {
    "type": "http",
    "name": "<string>",
    "path": "<string>",
    "parameters": [
        {
            "name": "<string>",
            "required": True,
            "default": "<unknown>",
            "completion": {}
        }
    ],
    "responses": [
        {
            "definitions": [{ "definition": { "id": "<string>" } }],
            "status": 123
        }
    ],
    "summary": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'http',
    name: '<string>',
    path: '<string>',
    parameters: [{name: '<string>', required: true, default: '<unknown>', completion: {}}],
    responses: [{definitions: [{definition: {id: '<string>'}}], status: 123}],
    summary: '<string>',
    description: '<string>'
  })
};

fetch('https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/actions', 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}/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'http',
    'name' => '<string>',
    'path' => '<string>',
    'parameters' => [
        [
                'name' => '<string>',
                'required' => true,
                'default' => '<unknown>',
                'completion' => [
                                
                ]
        ]
    ],
    'responses' => [
        [
                'definitions' => [
                                [
                                                                'definition' => [
                                                                                                                                'id' => '<string>'
                                                                ]
                                ]
                ],
                'status' => 123
        ]
    ],
    'summary' => '<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}/actions"

	payload := strings.NewReader("{\n  \"type\": \"http\",\n  \"name\": \"<string>\",\n  \"path\": \"<string>\",\n  \"parameters\": [\n    {\n      \"name\": \"<string>\",\n      \"required\": true,\n      \"default\": \"<unknown>\",\n      \"completion\": {}\n    }\n  ],\n  \"responses\": [\n    {\n      \"definitions\": [\n        {\n          \"definition\": {\n            \"id\": \"<string>\"\n          }\n        }\n      ],\n      \"status\": 123\n    }\n  ],\n  \"summary\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/actions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"http\",\n  \"name\": \"<string>\",\n  \"path\": \"<string>\",\n  \"parameters\": [\n    {\n      \"name\": \"<string>\",\n      \"required\": true,\n      \"default\": \"<unknown>\",\n      \"completion\": {}\n    }\n  ],\n  \"responses\": [\n    {\n      \"definitions\": [\n        {\n          \"definition\": {\n            \"id\": \"<string>\"\n          }\n        }\n      ],\n      \"status\": 123\n    }\n  ],\n  \"summary\": \"<string>\",\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}/actions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"http\",\n  \"name\": \"<string>\",\n  \"path\": \"<string>\",\n  \"parameters\": [\n    {\n      \"name\": \"<string>\",\n      \"required\": true,\n      \"default\": \"<unknown>\",\n      \"completion\": {}\n    }\n  ],\n  \"responses\": [\n    {\n      \"definitions\": [\n        {\n          \"definition\": {\n            \"id\": \"<string>\"\n          }\n        }\n      ],\n      \"status\": 123\n    }\n  ],\n  \"summary\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "type": "http",
  "name": "<string>",
  "method": "GET",
  "path": "<string>",
  "parameters": [
    {
      "name": "<string>",
      "in": "cookie",
      "required": true,
      "type": "string",
      "default": "<unknown>",
      "completion": {}
    }
  ],
  "responses": [
    {
      "id": "<string>",
      "definitions": [
        {
          "id": "<string>",
          "definition": {
            "id": "<string>",
            "name": "<string>",
            "accept": [
              "<string>"
            ],
            "url": "<string>",
            "description": "<string>",
            "referencedBy": [
              {
                "type": "definition",
                "id": "<string>",
                "name": "<string>"
              }
            ]
          }
        }
      ],
      "status": 123
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "severity": "error"
    }
  ],
  "summary": "<string>",
  "description": "<string>",
  "requestBody": {
    "required": true,
    "definitions": [
      {
        "id": "<string>",
        "definition": {
          "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>"
}