GET
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
/
versions
/
{version}
/
actions
/
{action_name}
curl --request GET \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/versions/{version}/actions/{action_name} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "severity": "error"
    }
  ],
  "type": "http",
  "name": "<string>",
  "summary": "<string>",
  "description": "<string>",
  "method": "GET",
  "path": "<string>",
  "parameters": [
    {
      "name": "<string>",
      "in": "cookie",
      "required": true,
      "type": "string",
      "default": "<any>",
      "completion": {}
    }
  ],
  "requestBody": {
    "required": true,
    "definitions": [
      {
        "id": "<string>",
        "definition": {
          "id": "<string>",
          "name": "<string>",
          "accept": [
            "<string>"
          ],
          "description": "<string>",
          "url": "<string>",
          "referencedBy": [
            {
              "type": "definition",
              "id": "<string>",
              "name": "<string>"
            }
          ]
        }
      }
    ]
  },
  "responses": [
    {
      "status": 123,
      "id": "<string>",
      "definitions": [
        {
          "id": "<string>",
          "definition": {
            "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.

​
action_name
string
required

Response

200
application/json
OK

ActionHTTPCommon defines the common fields for all HTTP Actions.

​
type
enum<string>
required
Available options:
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.

​
id
string
required

ID is the unique identifier of the Action.

​
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

ActionHTTPParameter defines a parameter which is sent to the HTTP endpoint when invoking the Action. This may be a query parameter, header or cookie depending on the in field.

​
responses
object[]
required

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

ActionHTTPResponse defines what responses may be returned by the HTTP server when invoking the Action.

​
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.

​
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.

ActionError is the payload returned when an Action fails validation

​
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.