POST
/
o
/
{organisation_id}
/
protocols
/
bigquery
/
connections
curl --request POST \
  --url https://platform.versori.com/api/connect/v1alpha1/o/{organisation_id}/protocols/bigquery/connections \
  --header 'Content-Type: application/json' \
  --data '{
  "datasetId": "<string>",
  "environments": [
    {
      "credentials": {
        "action": [
          {
            "authSchemeConfig": {
              "schemeType": "<string>"
            },
            "credential": {
              "data": {},
              "name": "<string>",
              "type": "none"
            }
          }
        ],
        "trigger": [
          {
            "authSchemeConfig": {
              "schemeType": "<string>"
            },
            "credential": {
              "data": {},
              "name": "<string>",
              "type": "none"
            }
          }
        ]
      },
      "name": "<string>",
      "variables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "name": "<string>"
}'
{
  "authSchemeConfigs": [
    {
      "schemeType": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "environmentVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "environments": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "credentials": {
        "action": [
          {
            "authSchemeConfig": {
              "schemeType": "<string>"
            },
            "credential": {
              "createdAt": "2023-11-07T05:31:56Z",
              "data": {},
              "errors": [
                "<string>"
              ],
              "id": "<string>",
              "name": "<string>",
              "type": "none",
              "updatedAt": "2023-11-07T05:31:56Z",
              "usages": [
                {
                  "environment": {
                    "connection": {
                      "createdAt": "2023-11-07T05:31:56Z",
                      "id": "<string>",
                      "name": "<string>",
                      "organisationId": "<string>",
                      "protocol": "http",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "id": "<string>",
                    "name": "<string>",
                    "slug": "<string>",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ]
            },
            "id": "<string>"
          }
        ],
        "trigger": [
          {
            "authSchemeConfig": {
              "schemeType": "<string>"
            },
            "credential": {
              "createdAt": "2023-11-07T05:31:56Z",
              "data": {},
              "errors": [
                "<string>"
              ],
              "id": "<string>",
              "name": "<string>",
              "type": "none",
              "updatedAt": "2023-11-07T05:31:56Z",
              "usages": [
                {
                  "environment": {
                    "connection": {
                      "createdAt": "2023-11-07T05:31:56Z",
                      "id": "<string>",
                      "name": "<string>",
                      "organisationId": "<string>",
                      "protocol": "http",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    },
                    "createdAt": "2023-11-07T05:31:56Z",
                    "id": "<string>",
                    "name": "<string>",
                    "slug": "<string>",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                }
              ]
            },
            "id": "<string>"
          }
        ]
      },
      "id": "<string>",
      "name": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "variables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "id": "<string>",
  "name": "<string>",
  "organisationId": "<string>",
  "protocol": "http",
  "updatedAt": "2023-11-07T05:31:56Z",
  "versions": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "isDefault": true,
      "isLatest": true,
      "name": "<string>",
      "publishedAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "datasetId": "<string>"
}

Authorizations

cookie
string
cookierequired

Cookie authentication used by the Versori Platform.

Path Parameters

organisation_id
string
required

Body

application/json
datasetId
string

DatasetID is the ID of the BigQuery dataset, in the format "<project_id>.<dataset_name>"

environments
object[]
required
name
string
required

Name is the user-provided name of the Connection

Response

201 - application/json
authSchemeConfigs
object[]
  • Option 1

  • Option 2

  • Option 3

  • Option 4

  • Option 5

  • Option 6

createdAt
string
required

CreatedAt is the time at which the ConnectionVersion was created.

environmentVariables
object[]

Environment Variables is a list of default variables initialised in every connection environment.

environments
object[]
required

Environments is a list of all the environments this Connection has.

id
string
required

ID is the unique identifier of the Connection.

name
string
required

Name is the user-provided name of the Connection

organisationId
string
required

OrganisationID is the unique identifier of the Organisation that owns the Connection.

protocol
enum<string>
required

ProtocolType denotes the set of all valid connection types.

Available options:
http,
bigquery
updatedAt
string
required

UpdatedAt is the time at which the ConnectionVersion was last updated, including any changes to child resources.

versions
object[]

Versions is a list of all the versions this Connection has.

datasetId
string
required

DatasetID is the ID of the BigQuery dataset, in the format "<project_id>.<dataset_name>"