Get Action

id

string

required

ID is the unique identifier of the Action.

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.

type

enum<string>

required

Available options:

http

name

string

required

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

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.

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

ActionPath is appended to the Connection'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.
{{ env.<name> }} - Injects the value of the environment variable with the given name.

parameters

object[]

required

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.

requestBody.required

boolean

required

Required denotes whether a request body is required for this Action.

requestBody.definitions

object[]

required

An Action may support one Definition per media-type, i.e. application/json or application/xml etc. Attempts to link multiple Definitions with the same media-type will result in an error.

requestBody.definitions.id

string

required

ID is a unique identifier for the request body within the scope of the Action.

requestBody.definitions.definition

object

required

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

requestBody.definitions.definition.id

string

required

ID is the unique identifier of the Definition.

requestBody.definitions.definition.name

string

required

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

requestBody.definitions.definition.accept

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.

requestBody.definitions.definition.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.

requestBody.definitions.definition.url

string

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

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

requestBody.definitions.definition.referencedBy

object[]

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

responses

object[]

required

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

responses.status

integer

Status is the HTTP status code which is expected from the HTTP endpoint. If this is not defined then this response is treated as the default response, i.e. if no other response matches then this response will be used. An action may only have one default response and each response must have a unique status code.

responses.id

string

required

responses.definitions

object[]

required

An Action may support one Definition per media-type, i.e. application/json or application/xml etc. Attempts to link multiple Definitions with the same media-type will result in an error.

responses.definitions.id

string

required

ID is a unique identifier for the request body within the scope of the Action.

responses.definitions.definition

object

required

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

responses.definitions.definition.id

string

required

ID is the unique identifier of the Definition.

responses.definitions.definition.name

string

required

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

responses.definitions.definition.accept

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.

responses.definitions.definition.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.

responses.definitions.definition.url

string

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

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

responses.definitions.definition.referencedBy

object[]

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

API Reference

Authorizations

Path Parameters

Response