curl --request POST \
--url https://platform.versori.com/api/connect/v1/o/{organisation_id}/protocols/http/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'metadata={
"format": "openapi"
}'{
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"public": true,
"protocol": "http",
"authSchemeConfigs": [
{
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
],
"connections": [
{
"id": "<string>",
"name": "<string>",
"credentials": {
"action": [
{
"id": "<string>",
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"data": {},
"usages": [
{
"connection": {
"id": "<string>",
"name": "<string>",
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"protocol": "http",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"errors": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"trigger": [
{
"id": "<string>",
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"data": {},
"usages": [
{
"connection": {
"id": "<string>",
"name": "<string>",
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"protocol": "http",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"errors": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z"
}
}
]
},
"variables": [
{
"name": "<string>",
"value": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"versions": [
{
"id": "<string>",
"name": "<string>",
"isLatest": true,
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"messages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"documentationURL": "<string>",
"imageURL": "<string>",
"tags": {},
"connectionVariables": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"definitions": [
{
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"url": "<string>",
"description": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
],
"actions": [
{
"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>"
}
]
}
}
]
}
}
],
"triggers": [
{
"id": "<string>",
"type": "http",
"name": "<string>",
"method": "GET",
"parameters": [
{
"name": "<string>",
"in": "cookie",
"required": true,
"type": "string",
"default": "<unknown>"
}
],
"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>"
}
]
}
}
]
}
}
],
"messages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}Import HTTP Connector
ImportHTTPConnector imports a Connector from another format such as OpenAPI or Postman Collections.
The Connector will be created in a draft state and will need to be published before it can be used in a live board.
curl --request POST \
--url https://platform.versori.com/api/connect/v1/o/{organisation_id}/protocols/http/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'metadata={
"format": "openapi"
}'{
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"public": true,
"protocol": "http",
"authSchemeConfigs": [
{
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
],
"connections": [
{
"id": "<string>",
"name": "<string>",
"credentials": {
"action": [
{
"id": "<string>",
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"data": {},
"usages": [
{
"connection": {
"id": "<string>",
"name": "<string>",
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"protocol": "http",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"errors": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"trigger": [
{
"id": "<string>",
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"data": {},
"usages": [
{
"connection": {
"id": "<string>",
"name": "<string>",
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"protocol": "http",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"errors": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z"
}
}
]
},
"variables": [
{
"name": "<string>",
"value": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"versions": [
{
"id": "<string>",
"name": "<string>",
"isLatest": true,
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"messages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"documentationURL": "<string>",
"imageURL": "<string>",
"tags": {},
"connectionVariables": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"definitions": [
{
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"url": "<string>",
"description": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
],
"actions": [
{
"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>"
}
]
}
}
]
}
}
],
"triggers": [
{
"id": "<string>",
"type": "http",
"name": "<string>",
"method": "GET",
"parameters": [
{
"name": "<string>",
"in": "cookie",
"required": true,
"type": "string",
"default": "<unknown>"
}
],
"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>"
}
]
}
}
]
}
}
],
"messages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}Authorizations
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
Body
The file to be imported.
ImportHTTPConnectorMetadata defines the metadata part of the multipart/form-data request when importing a Connector from another format.
Show child attributes
Show child attributes
The format of the file to be imported.
openapi- OpenAPI 3.x specification, we may include support for 2.x in the future.
openapi Response
Created
ImportHTTPConnectorResult defines the result of importing a Connector from an external format, such as OpenAPI.
HTTPConnector represents a connector to an external system over HTTP. ConnectorBase holds common fields which exist across all Connector protocols.
Show child attributes
Show child attributes
ID is the unique identifier of the Connector.
OrganisationID is the unique identifier of the Organisation that owns the Connector.
Name is the user-provided name of the Connector
ProtocolType denotes the set of all valid connector types.
http, bigquery "http"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its authentication requirements. This is purely the configuration and not the actual credential which is used to authenticate. The credential uses this configuration to determine how to authenticate.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and only requires to be unique amongst the elements of the array in which is it contained.
Description enables users to distinguish multiple configurations which use the same schemeType.
"none"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig is validated. This is typically used to provide feedback to the user when they are creating or updating the AuthSchemeConfig.
This field will be ignored if sent to the API.
Show child attributes
Show child attributes
Text contains the text of the message.
info, warning, error Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.
Connections is a list of all the connections this Connector has.
Show child attributes
Show child attributes
ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)
public-facing APIs will use the name in combination with the Connector's id instead.
Name is the name of the Connection. This must be unique within the owning Connector.
ConnectionCredentials defines the Action and Trigger credentials for the owning Connector. If multiple credentials are defined for each type, they are applied to the request in the order they are defined. This is to enable Connectors which require both a user session token and an API key to be provided in the request.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its authentication requirements. This is purely the configuration and not the actual credential which is used to authenticate. The credential uses this configuration to determine how to authenticate.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and only requires to be unique amongst the elements of the array in which is it contained.
Description enables users to distinguish multiple configurations which use the same schemeType.
"none"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig is validated. This is typically used to provide feedback to the user when they are creating or updating the AuthSchemeConfig.
This field will be ignored if sent to the API.
Show child attributes
Show child attributes
Text contains the text of the message.
info, warning, error Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.
CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.
Show child attributes
Show child attributes
ID is the unique identifier of the Credential.
OrganisationID is the unique identifier of the Organisation which owns the Credential.
CredentialType denotes the type of the credential which determines what the Credential's data property will
contain.
- none: No credential is required to authenticate with the Connector.
- string: The credential is a string value, such as an API key or password.
- binary: The credential is a binary value, such as a private key, certificate or other file.
- basic-auth: The credential is a username and password to be used for basic authentication.
- oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
- oauth2-code: The credential is a temporary authorization code which will be exchanged for an oauth2-token.
- oauth2-password: The credential is an OAuth2 username and password with an optional client ID and secret to be used for OAuth2 authentication.
- oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.
- custom-function: The credential is a custom function which will be called to authenticate with the Connector.
- jwt-bearer: The credential is the JWT setup values to be used for generating a bearer token.
- certificate: The credential is a PEM encoded certificate, key and CA to be used for TLS client authentication.
none, string, binary, basic-auth, oauth2-client, oauth2-code, oauth2-password, oauth2-token, custom-function, certificate, jwt-bearer Name is the name of the Credential.
CredentialDataNone contains no data as no credential is required to authenticate with the Connector. It is used purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
CredentialUsages is a list of references to the Connectors which are using this Credential. To aid performance, this field will only be defined for specific endpoints. An undefined property means that the usages have not been loaded, whereas an empty array indicates that the credential is not used by any connectors.
Show child attributes
Show child attributes
CredentialUsageConnection contains the information about an Connection which is using a Credential. This also includes a summary of the Connector it belongs to.
Show child attributes
Show child attributes
ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)
public-facing APIs will use the name in combination with the Connector's id instead.
Name is the name of the Connection.
ConnectorSummaryBase exposes a summary of a Connector irrespective of protocol.
Show child attributes
Show child attributes
ID is the unique identifier of the Connector.
OrganisationID is the unique identifier of the Organisation that owns the Connector.
Name is the user-provided name of the Connector
ProtocolType denotes the set of all valid connector types.
http, bigquery CreatedAt is the time at which the ConnectorVersion was created.
UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.
CreatedAt is the time the Connection was created.
UpdatedAt is the time the Connection was last updated.
Errors is a list of errors which occurred when attempting to validate the credential. This field may be undefined, which implies that validation has not occurred and the consumer cannot assume whether this Credential is valid or not. An empty array indicates that the Credential is valid.
ExpiresAt denotes the time this credential should be automatically deleted. External systems can subscribe to deletion events and if the reason is "expired", can trigger the correct notifications to interested parties (such as un-publishing jobs which rely on the credential and emailing the owner to rectify it).
Show child attributes
Show child attributes
AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its authentication requirements. This is purely the configuration and not the actual credential which is used to authenticate. The credential uses this configuration to determine how to authenticate.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and only requires to be unique amongst the elements of the array in which is it contained.
Description enables users to distinguish multiple configurations which use the same schemeType.
"none"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig is validated. This is typically used to provide feedback to the user when they are creating or updating the AuthSchemeConfig.
This field will be ignored if sent to the API.
Show child attributes
Show child attributes
Text contains the text of the message.
info, warning, error Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.
CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.
Show child attributes
Show child attributes
ID is the unique identifier of the Credential.
OrganisationID is the unique identifier of the Organisation which owns the Credential.
CredentialType denotes the type of the credential which determines what the Credential's data property will
contain.
- none: No credential is required to authenticate with the Connector.
- string: The credential is a string value, such as an API key or password.
- binary: The credential is a binary value, such as a private key, certificate or other file.
- basic-auth: The credential is a username and password to be used for basic authentication.
- oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
- oauth2-code: The credential is a temporary authorization code which will be exchanged for an oauth2-token.
- oauth2-password: The credential is an OAuth2 username and password with an optional client ID and secret to be used for OAuth2 authentication.
- oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.
- custom-function: The credential is a custom function which will be called to authenticate with the Connector.
- jwt-bearer: The credential is the JWT setup values to be used for generating a bearer token.
- certificate: The credential is a PEM encoded certificate, key and CA to be used for TLS client authentication.
none, string, binary, basic-auth, oauth2-client, oauth2-code, oauth2-password, oauth2-token, custom-function, certificate, jwt-bearer Name is the name of the Credential.
CredentialDataNone contains no data as no credential is required to authenticate with the Connector. It is used purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
CredentialUsages is a list of references to the Connectors which are using this Credential. To aid performance, this field will only be defined for specific endpoints. An undefined property means that the usages have not been loaded, whereas an empty array indicates that the credential is not used by any connectors.
Show child attributes
Show child attributes
CredentialUsageConnection contains the information about an Connection which is using a Credential. This also includes a summary of the Connector it belongs to.
Show child attributes
Show child attributes
ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)
public-facing APIs will use the name in combination with the Connector's id instead.
Name is the name of the Connection.
ConnectorSummaryBase exposes a summary of a Connector irrespective of protocol.
Show child attributes
Show child attributes
ID is the unique identifier of the Connector.
OrganisationID is the unique identifier of the Organisation that owns the Connector.
Name is the user-provided name of the Connector
ProtocolType denotes the set of all valid connector types.
http, bigquery CreatedAt is the time at which the ConnectorVersion was created.
UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.
CreatedAt is the time the Connection was created.
UpdatedAt is the time the Connection was last updated.
Errors is a list of errors which occurred when attempting to validate the credential. This field may be undefined, which implies that validation has not occurred and the consumer cannot assume whether this Credential is valid or not. An empty array indicates that the Credential is valid.
ExpiresAt denotes the time this credential should be automatically deleted. External systems can subscribe to deletion events and if the reason is "expired", can trigger the correct notifications to interested parties (such as un-publishing jobs which rely on the credential and emailing the owner to rectify it).
CreatedAt is the time the Connection was created.
UpdatedAt is the time the Connection was last updated.
Versions is a list of all the versions this Connector has.
Show child attributes
Show child attributes
ID is the unique identifier of the ConnectorVersion, this is typically only used internally and the version
name is used externally in combination with the Connector id.
Name denotes the actual version value for the Connector. This can be any value but a consistent naming strategy is recommended, such as SemVer, CalVer or an incrementing number. The names "default" and "latest" are reserved words and cannot be used.
IsLatest denotes whether this is the latest version of the Connector.
IsDefault denotes whether this is the default version of the Connector.
CreatedAt is the time at which the ConnectorVersion was created.
UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.
PublishedAt is the time at which the ConnectorVersion was published.
Description allows specifying additional information about the ConnectorVersion, such as what changed since the last version etc.
Show child attributes
Show child attributes
Text contains the text of the message.
info, warning, error Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.
CreatedAt is the time at which the ConnectorVersion was created.
UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.
BaseURL is the base URL of all HTTP Actions within the Connector.
Hold an optional link to the documentation for the API.
The URL for the icon for the connector
Connection Variables is a list of default variables initialised in every connector connection.
Show child attributes
Show child attributes
ID is the unique identifier of the Definition.
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".
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.
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 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 is a list of DefinitionReference objects which defines what other entities are referencing the this Definition.
Show child attributes
Show child attributes
definition, action, trigger ID is the unique identifier of the Definition/Action/Trigger.
Name is unique identifier for the Definition/Action/Trigger within the scope of the Connector. It is expected to both human and machine-readable, i.e. "ProductFeature" or "stock_item".
Show child attributes
Show child attributes
ID is the unique identifier of the Action.
http "http"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.
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.
GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, CONNECT, TRACE 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.
Show child attributes
Show child attributes
Name is the name of the parameter which will be sent to the HTTP endpoint.
cookie, header, path, query Required denotes whether this parameter is required.
Type is the type of the parameter. Currently only scalar types are supported, if you require complex types then get in touch with support to discuss options.
string, number, integer, boolean Default is the default value to use for the parameter if no value is provided by the user. If this is not defined then the parameter will not be sent to the HTTP endpoint if no value is explicitly provided by the user.
If this value is a string, it may be templated using a Go-formatted template
string, i.e. {{ .conn.foo }} where foo is an connection variable defined in the
Connector's Connection.
ActionCompletion defines how an Action may be completed by Switchboard to aid the user in selecting a valid value. Schema TBD.
Responses defines the expected responses from the HTTP endpoint. This is used to determine whether the Action was successful or not.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
ID is a unique identifier for the request body within the scope of the Action.
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.
DefinitionCommon is the common properties which are shared between Definitions for all of creation, retrieval and updates.
Show child attributes
Show child attributes
ID is the unique identifier of the Definition.
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".
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.
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 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 is a list of DefinitionReference objects which defines what other entities are referencing the this Definition.
Show child attributes
Show child attributes
definition, action, trigger ID is the unique identifier of the Definition/Action/Trigger.
Name is unique identifier for the Definition/Action/Trigger within the scope of the Connector. It is expected to both human and machine-readable, i.e. "ProductFeature" or "stock_item".
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.
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
Show child attributes
Field is the field which failed validation. This is typically a JSON Pointer, i.e. "/parameters/0/properties/id", however this is open for discussion (we should be consistent with the ErrorField type).
Message is a human-readable description of the error. This is typically a human-readable string, i.e. "The parameter 'id' is invalid".
Severity is the severity of the error. This is used to determine how the error should be displayed to the user, i.e. a warning may be displayed in a modal dialog, whereas an error may be displayed inline.
error, warning 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 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.
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
Show child attributes
Required denotes whether a request body is required for this Action.
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.
Show child attributes
Show child attributes
ID is a unique identifier for the request body within the scope of the Action.
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.
DefinitionCommon is the common properties which are shared between Definitions for all of creation, retrieval and updates.
Show child attributes
Show child attributes
ID is the unique identifier of the Definition.
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".
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.
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 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 is a list of DefinitionReference objects which defines what other entities are referencing the this Definition.
Show child attributes
Show child attributes
definition, action, trigger ID is the unique identifier of the Definition/Action/Trigger.
Name is unique identifier for the Definition/Action/Trigger within the scope of the Connector. It is expected to both human and machine-readable, i.e. "ProductFeature" or "stock_item".
Show child attributes
Show child attributes
ID is the unique identifier of the Trigger.
http "http"Name is a unique identifier for the Trigger 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.
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.
GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, CONNECT, TRACE Show child attributes
Show child attributes
Name is the name of the parameter which will be sent to the HTTP endpoint.
cookie, header, query Required denotes whether this parameter is required.
Type is the type of the parameter. Currently only scalar types are supported, if you require complex types then get in touch with support to discuss options.
string, number, integer, boolean Default is the default value to use for the parameter if no value is provided by the user. If this is not defined then the parameter will not be sent to the HTTP endpoint if no value is explicitly provided by the user.
If this value is a string, it may be templated using a Go-formatted template
string, i.e. {{ .conn.foo }} where foo is an connection variable defined in the
Connector's Connection.
Responses defines the expected responses from the HTTP endpoint. This is used to determine whether the Trigger was successful or not.
Show child attributes
Show child attributes
a Trigger 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.
Show child attributes
Show child attributes
ID is a unique identifier for the request body within the scope of the Trigger.
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.
DefinitionCommon is the common properties which are shared between Definitions for all of creation, retrieval and updates.
Show child attributes
Show child attributes
ID is the unique identifier of the Definition.
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".
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.
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 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 is a list of DefinitionReference objects which defines what other entities are referencing the this Definition.
Show child attributes
Show child attributes
definition, action, trigger ID is the unique identifier of the Definition/Action/Trigger.
Name is unique identifier for the Definition/Action/Trigger within the scope of the Connector. It is expected to both human and machine-readable, i.e. "ProductFeature" or "stock_item".
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. a Trigger may only have one default response and each response must have a unique status code.
Errors is a list of ErrorField objects which defines the errors which may be returned by the Trigger. An empty array denotes that the Trigger has been validated and no errors were found. If this field is undefined then this means validation has not occurred.
Show child attributes
Show child attributes
Field is the field which failed validation. This is typically a JSON Pointer, i.e. "/parameters/0/properties/id", however this is open for discussion (we should be consistent with the ErrorField type).
Message is a human-readable description of the error. This is typically a human-readable string, i.e. "The parameter 'id' is invalid".
Severity is the severity of the error. This is used to determine how the error should be displayed to the user, i.e. a warning may be displayed in a modal dialog, whereas an error may be displayed inline.
error, warning Summary is a human-readable version of the id field, i.e. "Get Product" or "Get Products". This is used
when displaying the Trigger to users, however if omitted the TriggerId can be used to display to users
instead.
Description is a human-readable description of the Trigger. It can provide extra information to users about how the Trigger operates and anything the user may need to be aware of when using it.
TriggerHTTPRequestBody defines whether a request body is required for a particular HTTP Trigger, and if so which Definitions are considered valid. If this value is undefined then no request body will be sent.
Show child attributes
Show child attributes
Required denotes whether a request body is required for this Trigger.
a Trigger 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.
Show child attributes
Show child attributes
ID is a unique identifier for the request body within the scope of the Trigger.
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.
DefinitionCommon is the common properties which are shared between Definitions for all of creation, retrieval and updates.
Show child attributes
Show child attributes
ID is the unique identifier of the Definition.
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".
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.
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 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 is a list of DefinitionReference objects which defines what other entities are referencing the this Definition.
Show child attributes
Show child attributes
definition, action, trigger ID is the unique identifier of the Definition/Action/Trigger.
Name is unique identifier for the Definition/Action/Trigger within the scope of the Connector. It is expected to both human and machine-readable, i.e. "ProductFeature" or "stock_item".
Show child attributes
Show child attributes
Text contains the text of the message.
info, warning, error Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.