GET
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
/
versions
/
{version}
/
actions

Authorizations

Authorization
string
headerrequired

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.

Query Parameters

first
integer
default: 20
after
string
before
string
name
string

Name filters Actions by name using a case-insensitive substring-match.

Response

200 - application/json

ActionPage defines a paginated list of Actions.

totalCount
integer
required
next
string
prev
string
actions
object[]
required
actions.id
string
required

ID is the unique identifier of the Action.

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

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

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

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

actions.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
actions.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.
actions.parameters
object[]
required
actions.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.

actions.responses
object[]
required

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

Create ActionGet Action