37c53db4bb
* Implement database migrator * Add unit tests * Add RUN_FLYWAY_MIGRATION variable * Run flyway migration in server * Add db migration info api * Add db migration migrate api * Add unit test * Remove base airbyte migration * Implement migration dev helper * Dry and format code * Fix url * Use camel case * Add db migration page * Add button to run migration * Update migration table * Fix resource warning * Update readme * Revert package-lock changes * Update readme * Address simple frontend review comments * Add java migration template (not completed yet) * Add method to generate migration file * Set up jooq code generation * Check in generated code * Move generated code to build directory * Exclude db dev center methods in gradle * Update airbyte-db/README.md Co-authored-by: Davin Chia <davinchia@gmail.com> * Mark getMigrator as private Co-authored-by: Davin Chia <davinchia@gmail.com> * Address review comments * Format code * Fix format output column name * Remove config persistence builder * Remove dumpSchemaToFile method * Run baseline in server * Rename info to list Co-authored-by: Charles <giardina.charles@gmail.com> * Rename executeDbMigrationInfo to listMigrations Co-authored-by: Charles <giardina.charles@gmail.com> * Rename RUN_FLYWAY_MIGRATION * Clean up migration apis * Remove redundant version comparison * Refactor db migrator * Add migration file location parameter back This is necessary because other databases may exist in a different module and follow different patterns. * Fix build * Generate jooq code in gradle * Remove frontend changes * Remove testing migration Co-authored-by: Davin Chia <davinchia@gmail.com> Co-authored-by: Charles <giardina.charles@gmail.com>
6510 lines
279 KiB
HTML
6510 lines
279 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<title>Airbyte Configuration API</title>
|
|
<style type="text/css">
|
|
body {
|
|
font-family: Trebuchet MS, sans-serif;
|
|
font-size: 15px;
|
|
color: #444;
|
|
margin-right: 24px;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 25px;
|
|
}
|
|
h2 {
|
|
font-size: 20px;
|
|
}
|
|
h3 {
|
|
font-size: 16px;
|
|
font-weight: bold;
|
|
}
|
|
hr {
|
|
height: 1px;
|
|
border: 0;
|
|
color: #ddd;
|
|
background-color: #ddd;
|
|
}
|
|
|
|
.app-desc {
|
|
clear: both;
|
|
margin-left: 20px;
|
|
}
|
|
.param-name {
|
|
width: 100%;
|
|
}
|
|
.license-info {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.license-url {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.model {
|
|
margin: 0 0 0px 20px;
|
|
}
|
|
|
|
.method {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.method-notes {
|
|
margin: 10px 0 20px 0;
|
|
font-size: 90%;
|
|
color: #555;
|
|
}
|
|
|
|
pre {
|
|
padding: 10px;
|
|
margin-bottom: 2px;
|
|
}
|
|
|
|
.http-method {
|
|
text-transform: uppercase;
|
|
}
|
|
|
|
pre.get {
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
pre.post {
|
|
background-color: #10a54a;
|
|
}
|
|
|
|
pre.put {
|
|
background-color: #c5862b;
|
|
}
|
|
|
|
pre.delete {
|
|
background-color: #a41e22;
|
|
}
|
|
|
|
.huge {
|
|
color: #fff;
|
|
}
|
|
|
|
pre.example {
|
|
background-color: #f3f3f3;
|
|
padding: 10px;
|
|
border: 1px solid #ddd;
|
|
}
|
|
|
|
code {
|
|
white-space: pre;
|
|
}
|
|
|
|
.nickname {
|
|
font-weight: bold;
|
|
}
|
|
|
|
.method-path {
|
|
font-size: 1.5em;
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
.up {
|
|
float:right;
|
|
}
|
|
|
|
.parameter {
|
|
width: 500px;
|
|
}
|
|
|
|
.param {
|
|
width: 500px;
|
|
padding: 10px 0 0 20px;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-desc {
|
|
width: 700px;
|
|
padding: 0 0 0 20px;
|
|
color: #777;
|
|
}
|
|
|
|
.param-type {
|
|
font-style: italic;
|
|
}
|
|
|
|
.param-enum-header {
|
|
width: 700px;
|
|
padding: 0 0 0 60px;
|
|
color: #777;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-enum {
|
|
width: 700px;
|
|
padding: 0 0 0 80px;
|
|
color: #777;
|
|
font-style: italic;
|
|
}
|
|
|
|
.field-label {
|
|
padding: 0;
|
|
margin: 0;
|
|
clear: both;
|
|
}
|
|
|
|
.field-items {
|
|
padding: 0 0 15px 0;
|
|
margin-bottom: 15px;
|
|
}
|
|
|
|
.return-type {
|
|
clear: both;
|
|
padding-bottom: 10px;
|
|
}
|
|
|
|
.param-header {
|
|
font-weight: bold;
|
|
}
|
|
|
|
.method-tags {
|
|
text-align: right;
|
|
}
|
|
|
|
.method-tag {
|
|
background: none repeat scroll 0% 0% #24A600;
|
|
border-radius: 3px;
|
|
padding: 2px 10px;
|
|
margin: 2px;
|
|
color: #FFF;
|
|
display: inline-block;
|
|
text-decoration: none;
|
|
}
|
|
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<h1>Airbyte Configuration API</h1>
|
|
<div class="app-desc"><p>Airbyte Configuration API
|
|
<a href="https://airbyte.io">https://airbyte.io</a>.</p>
|
|
<p>This API is a collection of HTTP RPC-style methods. While it is not a REST API, those familiar with REST should find the conventions of this API recognizable.</p>
|
|
<p>Here are some conventions that this API follows:</p>
|
|
<ul>
|
|
<li>All endpoints are http POST methods.</li>
|
|
<li>All endpoints accept data via <code>application/json</code> request bodies. The API does not accept any data via query params.</li>
|
|
<li>The naming convention for endpoints is: localhost:8000/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. <code>localhost:8000/v1/connections/create</code>.</li>
|
|
<li>For all <code>update</code> methods, the whole object must be passed in, even the fields that did not change.</li>
|
|
</ul>
|
|
<p>Change Management:</p>
|
|
<ul>
|
|
<li>The major version of the API endpoint can be determined / specified in the URL <code>localhost:8080/v1/connections/create</code></li>
|
|
<li>Minor version bumps will be invisible to the end user. The user cannot specify minor versions in requests.</li>
|
|
<li>All backwards incompatible changes will happen in major version bumps. We will not make backwards incompatible changes in minor version bumps. Examples of non-breaking changes (includes but not limited to...):
|
|
<ul>
|
|
<li>Adding fields to request or response bodies.</li>
|
|
<li>Adding new HTTP endpoints.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="app-desc">More information: <a href="https://openapi-generator.tech">https://openapi-generator.tech</a></div>
|
|
<div class="app-desc">Contact Info: <a href="contact@airbyte.io">contact@airbyte.io</a></div>
|
|
<div class="app-desc">Version: 1.0.0</div>
|
|
<div class="app-desc">BasePath:/api</div>
|
|
<div class="license-info">MIT</div>
|
|
<div class="license-url">https://opensource.org/licenses/MIT</div>
|
|
<h2>Access</h2>
|
|
<ol>
|
|
<li>HTTP Basic Authentication</li>
|
|
</ol>
|
|
|
|
<h2><a name="__Methods">Methods</a></h2>
|
|
[ Jump to <a href="#__Models">Models</a> ]
|
|
|
|
<h3>Table of Contents </h3>
|
|
<div class="method-summary"></div>
|
|
<h4><a href="#Connection">Connection</a></h4>
|
|
<ul>
|
|
<li><a href="#createConnection"><code><span class="http-method">post</span> /v1/connections/create</code></a></li>
|
|
<li><a href="#deleteConnection"><code><span class="http-method">post</span> /v1/connections/delete</code></a></li>
|
|
<li><a href="#getConnection"><code><span class="http-method">post</span> /v1/connections/get</code></a></li>
|
|
<li><a href="#getState"><code><span class="http-method">post</span> /v1/state/get</code></a></li>
|
|
<li><a href="#listConnectionsForWorkspace"><code><span class="http-method">post</span> /v1/connections/list</code></a></li>
|
|
<li><a href="#resetConnection"><code><span class="http-method">post</span> /v1/connections/reset</code></a></li>
|
|
<li><a href="#syncConnection"><code><span class="http-method">post</span> /v1/connections/sync</code></a></li>
|
|
<li><a href="#updateConnection"><code><span class="http-method">post</span> /v1/connections/update</code></a></li>
|
|
</ul>
|
|
<h4><a href="#DbMigration">DbMigration</a></h4>
|
|
<ul>
|
|
<li><a href="#executeMigrations"><code><span class="http-method">post</span> /v1/db_migrations/migrate</code></a></li>
|
|
<li><a href="#listMigrations"><code><span class="http-method">post</span> /v1/db_migrations/list</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Deployment">Deployment</a></h4>
|
|
<ul>
|
|
<li><a href="#exportArchive"><code><span class="http-method">post</span> /v1/deployment/export</code></a></li>
|
|
<li><a href="#importArchive"><code><span class="http-method">post</span> /v1/deployment/import</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Destination">Destination</a></h4>
|
|
<ul>
|
|
<li><a href="#checkConnectionToDestination"><code><span class="http-method">post</span> /v1/destinations/check_connection</code></a></li>
|
|
<li><a href="#checkConnectionToDestinationForUpdate"><code><span class="http-method">post</span> /v1/destinations/check_connection_for_update</code></a></li>
|
|
<li><a href="#createDestination"><code><span class="http-method">post</span> /v1/destinations/create</code></a></li>
|
|
<li><a href="#deleteDestination"><code><span class="http-method">post</span> /v1/destinations/delete</code></a></li>
|
|
<li><a href="#getDestination"><code><span class="http-method">post</span> /v1/destinations/get</code></a></li>
|
|
<li><a href="#listDestinationsForWorkspace"><code><span class="http-method">post</span> /v1/destinations/list</code></a></li>
|
|
<li><a href="#updateDestination"><code><span class="http-method">post</span> /v1/destinations/update</code></a></li>
|
|
</ul>
|
|
<h4><a href="#DestinationDefinition">DestinationDefinition</a></h4>
|
|
<ul>
|
|
<li><a href="#createDestinationDefinition"><code><span class="http-method">post</span> /v1/destination_definitions/create</code></a></li>
|
|
<li><a href="#getDestinationDefinition"><code><span class="http-method">post</span> /v1/destination_definitions/get</code></a></li>
|
|
<li><a href="#listDestinationDefinitions"><code><span class="http-method">post</span> /v1/destination_definitions/list</code></a></li>
|
|
<li><a href="#listLatestDestinationDefinitions"><code><span class="http-method">post</span> /v1/destination_definitions/list_latest</code></a></li>
|
|
<li><a href="#updateDestinationDefinition"><code><span class="http-method">post</span> /v1/destination_definitions/update</code></a></li>
|
|
</ul>
|
|
<h4><a href="#DestinationDefinitionSpecification">DestinationDefinitionSpecification</a></h4>
|
|
<ul>
|
|
<li><a href="#getDestinationDefinitionSpecification"><code><span class="http-method">post</span> /v1/destination_definition_specifications/get</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Health">Health</a></h4>
|
|
<ul>
|
|
<li><a href="#getHealthCheck"><code><span class="http-method">get</span> /v1/health</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Jobs">Jobs</a></h4>
|
|
<ul>
|
|
<li><a href="#cancelJob"><code><span class="http-method">post</span> /v1/jobs/cancel</code></a></li>
|
|
<li><a href="#getJobInfo"><code><span class="http-method">post</span> /v1/jobs/get</code></a></li>
|
|
<li><a href="#listJobsFor"><code><span class="http-method">post</span> /v1/jobs/list</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Logs">Logs</a></h4>
|
|
<ul>
|
|
<li><a href="#getLogs"><code><span class="http-method">post</span> /v1/logs/get</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Notifications">Notifications</a></h4>
|
|
<ul>
|
|
<li><a href="#tryNotificationConfig"><code><span class="http-method">post</span> /v1/notifications/try</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Openapi">Openapi</a></h4>
|
|
<ul>
|
|
<li><a href="#getOpenApiSpec"><code><span class="http-method">get</span> /v1/openapi</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Operation">Operation</a></h4>
|
|
<ul>
|
|
<li><a href="#checkOperation"><code><span class="http-method">post</span> /v1/operations/check</code></a></li>
|
|
<li><a href="#createOperation"><code><span class="http-method">post</span> /v1/operations/create</code></a></li>
|
|
<li><a href="#deleteOperation"><code><span class="http-method">post</span> /v1/operations/delete</code></a></li>
|
|
<li><a href="#getOperation"><code><span class="http-method">post</span> /v1/operations/get</code></a></li>
|
|
<li><a href="#listOperationsForConnection"><code><span class="http-method">post</span> /v1/operations/list</code></a></li>
|
|
<li><a href="#updateOperation"><code><span class="http-method">post</span> /v1/operations/update</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Scheduler">Scheduler</a></h4>
|
|
<ul>
|
|
<li><a href="#executeDestinationCheckConnection"><code><span class="http-method">post</span> /v1/scheduler/destinations/check_connection</code></a></li>
|
|
<li><a href="#executeSourceCheckConnection"><code><span class="http-method">post</span> /v1/scheduler/sources/check_connection</code></a></li>
|
|
<li><a href="#executeSourceDiscoverSchema"><code><span class="http-method">post</span> /v1/scheduler/sources/discover_schema</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Source">Source</a></h4>
|
|
<ul>
|
|
<li><a href="#checkConnectionToSource"><code><span class="http-method">post</span> /v1/sources/check_connection</code></a></li>
|
|
<li><a href="#checkConnectionToSourceForUpdate"><code><span class="http-method">post</span> /v1/sources/check_connection_for_update</code></a></li>
|
|
<li><a href="#createSource"><code><span class="http-method">post</span> /v1/sources/create</code></a></li>
|
|
<li><a href="#deleteSource"><code><span class="http-method">post</span> /v1/sources/delete</code></a></li>
|
|
<li><a href="#discoverSchemaForSource"><code><span class="http-method">post</span> /v1/sources/discover_schema</code></a></li>
|
|
<li><a href="#getSource"><code><span class="http-method">post</span> /v1/sources/get</code></a></li>
|
|
<li><a href="#listSourcesForWorkspace"><code><span class="http-method">post</span> /v1/sources/list</code></a></li>
|
|
<li><a href="#updateSource"><code><span class="http-method">post</span> /v1/sources/update</code></a></li>
|
|
</ul>
|
|
<h4><a href="#SourceDefinition">SourceDefinition</a></h4>
|
|
<ul>
|
|
<li><a href="#createSourceDefinition"><code><span class="http-method">post</span> /v1/source_definitions/create</code></a></li>
|
|
<li><a href="#getSourceDefinition"><code><span class="http-method">post</span> /v1/source_definitions/get</code></a></li>
|
|
<li><a href="#listLatestSourceDefinitions"><code><span class="http-method">post</span> /v1/source_definitions/list_latest</code></a></li>
|
|
<li><a href="#listSourceDefinitions"><code><span class="http-method">post</span> /v1/source_definitions/list</code></a></li>
|
|
<li><a href="#updateSourceDefinition"><code><span class="http-method">post</span> /v1/source_definitions/update</code></a></li>
|
|
</ul>
|
|
<h4><a href="#SourceDefinitionSpecification">SourceDefinitionSpecification</a></h4>
|
|
<ul>
|
|
<li><a href="#getSourceDefinitionSpecification"><code><span class="http-method">post</span> /v1/source_definition_specifications/get</code></a></li>
|
|
</ul>
|
|
<h4><a href="#WebBackend">WebBackend</a></h4>
|
|
<ul>
|
|
<li><a href="#webBackendCreateConnection"><code><span class="http-method">post</span> /v1/web_backend/connections/create</code></a></li>
|
|
<li><a href="#webBackendGetConnection"><code><span class="http-method">post</span> /v1/web_backend/connections/get</code></a></li>
|
|
<li><a href="#webBackendListConnectionsForWorkspace"><code><span class="http-method">post</span> /v1/web_backend/connections/list</code></a></li>
|
|
<li><a href="#webBackendRecreateDestination"><code><span class="http-method">post</span> /v1/web_backend/destinations/recreate</code></a></li>
|
|
<li><a href="#webBackendRecreateSource"><code><span class="http-method">post</span> /v1/web_backend/sources/recreate</code></a></li>
|
|
<li><a href="#webBackendUpdateConnection"><code><span class="http-method">post</span> /v1/web_backend/connections/update</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Workspace">Workspace</a></h4>
|
|
<ul>
|
|
<li><a href="#createWorkspace"><code><span class="http-method">post</span> /v1/workspaces/create</code></a></li>
|
|
<li><a href="#deleteWorkspace"><code><span class="http-method">post</span> /v1/workspaces/delete</code></a></li>
|
|
<li><a href="#getWorkspace"><code><span class="http-method">post</span> /v1/workspaces/get</code></a></li>
|
|
<li><a href="#getWorkspaceBySlug"><code><span class="http-method">post</span> /v1/workspaces/get_by_slug</code></a></li>
|
|
<li><a href="#listWorkspaces"><code><span class="http-method">post</span> /v1/workspaces/list</code></a></li>
|
|
<li><a href="#updateWorkspace"><code><span class="http-method">post</span> /v1/workspaces/update</code></a></li>
|
|
</ul>
|
|
|
|
<h1><a name="Connection">Connection</a></h1>
|
|
<div class="method"><a name="createConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/connections/create</code></pre></div>
|
|
<div class="method-summary">Create a connection between a source and a destination (<span class="nickname">createConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">ConnectionCreate <a href="#ConnectionCreate">ConnectionCreate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#ConnectionRead">ConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"prefix" : "prefix",
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#ConnectionRead">ConnectionRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deleteConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/connections/delete</code></pre></div>
|
|
<div class="method-summary">Delete a connection (<span class="nickname">deleteConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">ConnectionIdRequestBody <a href="#ConnectionIdRequestBody">ConnectionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">204</h4>
|
|
The resource was deleted successfully.
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/connections/get</code></pre></div>
|
|
<div class="method-summary">Get a connection (<span class="nickname">getConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">ConnectionIdRequestBody <a href="#ConnectionIdRequestBody">ConnectionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#ConnectionRead">ConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"prefix" : "prefix",
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#ConnectionRead">ConnectionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getState"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/state/get</code></pre></div>
|
|
<div class="method-summary">Fetch the current state for a connection. (<span class="nickname">getState</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">ConnectionIdRequestBody <a href="#ConnectionIdRequestBody">ConnectionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#ConnectionState">ConnectionState</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#ConnectionState">ConnectionState</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listConnectionsForWorkspace"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/connections/list</code></pre></div>
|
|
<div class="method-summary">Returns all connections for a workspace. (<span class="nickname">listConnectionsForWorkspace</span>)</div>
|
|
<div class="method-notes">List connections for workspace. Does not return deleted connections.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WorkspaceIdRequestBody <a href="#WorkspaceIdRequestBody">WorkspaceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#ConnectionReadList">ConnectionReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"connections" : [ {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"prefix" : "prefix",
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"prefix" : "prefix",
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#ConnectionReadList">ConnectionReadList</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="resetConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/connections/reset</code></pre></div>
|
|
<div class="method-summary">Reset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state. (<span class="nickname">resetConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">ConnectionIdRequestBody <a href="#ConnectionIdRequestBody">ConnectionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#JobInfoRead">JobInfoRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"job" : {
|
|
"createdAt" : 6,
|
|
"configId" : "configId",
|
|
"id" : 0,
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"attempt" : {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
}, {
|
|
"attempt" : {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#JobInfoRead">JobInfoRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="syncConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/connections/sync</code></pre></div>
|
|
<div class="method-summary">Trigger a manual sync of the connection (<span class="nickname">syncConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">ConnectionIdRequestBody <a href="#ConnectionIdRequestBody">ConnectionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#JobInfoRead">JobInfoRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"job" : {
|
|
"createdAt" : 6,
|
|
"configId" : "configId",
|
|
"id" : 0,
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"attempt" : {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
}, {
|
|
"attempt" : {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#JobInfoRead">JobInfoRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/connections/update</code></pre></div>
|
|
<div class="method-summary">Update a connection (<span class="nickname">updateConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">ConnectionUpdate <a href="#ConnectionUpdate">ConnectionUpdate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#ConnectionRead">ConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"prefix" : "prefix",
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#ConnectionRead">ConnectionRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="DbMigration">DbMigration</a></h1>
|
|
<div class="method"><a name="executeMigrations"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/db_migrations/migrate</code></pre></div>
|
|
<div class="method-summary">Migrate the database to the latest version (<span class="nickname">executeMigrations</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DbMigrationRequestBody <a href="#DbMigrationRequestBody">DbMigrationRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DbMigrationExecutionRead">DbMigrationExecutionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"initialVersion" : "initialVersion",
|
|
"executedMigrations" : [ {
|
|
"migrationVersion" : "migrationVersion",
|
|
"migrationDescription" : "migrationDescription",
|
|
"migratedAt" : 0,
|
|
"migrationType" : "migrationType",
|
|
"migrationScript" : "migrationScript",
|
|
"migratedBy" : "migratedBy"
|
|
}, {
|
|
"migrationVersion" : "migrationVersion",
|
|
"migrationDescription" : "migrationDescription",
|
|
"migratedAt" : 0,
|
|
"migrationType" : "migrationType",
|
|
"migrationScript" : "migrationScript",
|
|
"migratedBy" : "migratedBy"
|
|
} ],
|
|
"targetVersion" : "targetVersion"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DbMigrationExecutionRead">DbMigrationExecutionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listMigrations"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/db_migrations/list</code></pre></div>
|
|
<div class="method-summary">List all database migrations (<span class="nickname">listMigrations</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DbMigrationRequestBody <a href="#DbMigrationRequestBody">DbMigrationRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DbMigrationReadList">DbMigrationReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"migrations" : [ {
|
|
"migrationVersion" : "migrationVersion",
|
|
"migrationDescription" : "migrationDescription",
|
|
"migratedAt" : 0,
|
|
"migrationType" : "migrationType",
|
|
"migrationScript" : "migrationScript",
|
|
"migratedBy" : "migratedBy"
|
|
}, {
|
|
"migrationVersion" : "migrationVersion",
|
|
"migrationDescription" : "migrationDescription",
|
|
"migratedAt" : 0,
|
|
"migrationType" : "migrationType",
|
|
"migrationScript" : "migrationScript",
|
|
"migratedBy" : "migratedBy"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DbMigrationReadList">DbMigrationReadList</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Deployment">Deployment</a></h1>
|
|
<div class="method"><a name="exportArchive"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/deployment/export</code></pre></div>
|
|
<div class="method-summary">Export Airbyte Configuration and Data Archive (<span class="nickname">exportArchive</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
File
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/x-gzip</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#File">File</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="importArchive"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/deployment/import</code></pre></div>
|
|
<div class="method-summary">Import Airbyte Configuration and Data Archive (<span class="nickname">importArchive</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/x-gzip</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#file">file</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#ImportRead">ImportRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"reason" : "reason",
|
|
"status" : "succeeded"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#ImportRead">ImportRead</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Destination">Destination</a></h1>
|
|
<div class="method"><a name="checkConnectionToDestination"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destinations/check_connection</code></pre></div>
|
|
<div class="method-summary">Check connection to the destination (<span class="nickname">checkConnectionToDestination</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationIdRequestBody <a href="#DestinationIdRequestBody">DestinationIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"message" : "message",
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
},
|
|
"status" : "succeeded"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="checkConnectionToDestinationForUpdate"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destinations/check_connection_for_update</code></pre></div>
|
|
<div class="method-summary">Check connection for a proposed update to a destination (<span class="nickname">checkConnectionToDestinationForUpdate</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationUpdate <a href="#DestinationUpdate">DestinationUpdate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"message" : "message",
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
},
|
|
"status" : "succeeded"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="createDestination"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destinations/create</code></pre></div>
|
|
<div class="method-summary">Create a destination (<span class="nickname">createDestination</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationCreate <a href="#DestinationCreate">DestinationCreate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationRead">DestinationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationRead">DestinationRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deleteDestination"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destinations/delete</code></pre></div>
|
|
<div class="method-summary">Delete the destination (<span class="nickname">deleteDestination</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationIdRequestBody <a href="#DestinationIdRequestBody">DestinationIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">204</h4>
|
|
The resource was deleted successfully.
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getDestination"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destinations/get</code></pre></div>
|
|
<div class="method-summary">Get configured destination (<span class="nickname">getDestination</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationIdRequestBody <a href="#DestinationIdRequestBody">DestinationIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationRead">DestinationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationRead">DestinationRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listDestinationsForWorkspace"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destinations/list</code></pre></div>
|
|
<div class="method-summary">List configured destinations for a workspace (<span class="nickname">listDestinationsForWorkspace</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WorkspaceIdRequestBody <a href="#WorkspaceIdRequestBody">WorkspaceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationReadList">DestinationReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"destinations" : [ {
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationReadList">DestinationReadList</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateDestination"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destinations/update</code></pre></div>
|
|
<div class="method-summary">Update a destination (<span class="nickname">updateDestination</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationUpdate <a href="#DestinationUpdate">DestinationUpdate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationRead">DestinationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationRead">DestinationRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="DestinationDefinition">DestinationDefinition</a></h1>
|
|
<div class="method"><a name="createDestinationDefinition"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destination_definitions/create</code></pre></div>
|
|
<div class="method-summary">Creates a destinationsDefinition (<span class="nickname">createDestinationDefinition</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationDefinitionCreate <a href="#DestinationDefinitionCreate">DestinationDefinitionCreate</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationDefinitionRead">DestinationDefinitionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationDefinitionRead">DestinationDefinitionRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getDestinationDefinition"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destination_definitions/get</code></pre></div>
|
|
<div class="method-summary">Get destinationDefinition (<span class="nickname">getDestinationDefinition</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationDefinitionIdRequestBody <a href="#DestinationDefinitionIdRequestBody">DestinationDefinitionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationDefinitionRead">DestinationDefinitionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationDefinitionRead">DestinationDefinitionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listDestinationDefinitions"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destination_definitions/list</code></pre></div>
|
|
<div class="method-summary">List all the destinationDefinitions the current Airbyte deployment is configured to use (<span class="nickname">listDestinationDefinitions</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationDefinitionReadList">DestinationDefinitionReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"destinationDefinitions" : [ {
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationDefinitionReadList">DestinationDefinitionReadList</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listLatestDestinationDefinitions"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destination_definitions/list_latest</code></pre></div>
|
|
<div class="method-summary">List the latest destinationDefinitions Airbyte supports (<span class="nickname">listLatestDestinationDefinitions</span>)</div>
|
|
<div class="method-notes">Guaranteed to retrieve the latest information on supported destinations.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationDefinitionReadList">DestinationDefinitionReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"destinationDefinitions" : [ {
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationDefinitionReadList">DestinationDefinitionReadList</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateDestinationDefinition"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destination_definitions/update</code></pre></div>
|
|
<div class="method-summary">Update destinationDefinition (<span class="nickname">updateDestinationDefinition</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationDefinitionUpdate <a href="#DestinationDefinitionUpdate">DestinationDefinitionUpdate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationDefinitionRead">DestinationDefinitionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationDefinitionRead">DestinationDefinitionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="DestinationDefinitionSpecification">DestinationDefinitionSpecification</a></h1>
|
|
<div class="method"><a name="getDestinationDefinitionSpecification"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/destination_definition_specifications/get</code></pre></div>
|
|
<div class="method-summary">Get specification for a destinationDefinition (<span class="nickname">getDestinationDefinitionSpecification</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationDefinitionIdRequestBody <a href="#DestinationDefinitionIdRequestBody">DestinationDefinitionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationDefinitionSpecificationRead">DestinationDefinitionSpecificationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"documentationUrl" : "documentationUrl",
|
|
"supportsNormalization" : true,
|
|
"connectionSpecification" : {
|
|
"user" : {
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"supportedDestinationSyncModes" : [ null, null ],
|
|
"supportsDbt" : true,
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
}
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationDefinitionSpecificationRead">DestinationDefinitionSpecificationRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Health">Health</a></h1>
|
|
<div class="method"><a name="getHealthCheck"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /v1/health</code></pre></div>
|
|
<div class="method-summary">Health Check (<span class="nickname">getHealthCheck</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#HealthCheckRead">HealthCheckRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"db" : true
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#HealthCheckRead">HealthCheckRead</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Jobs">Jobs</a></h1>
|
|
<div class="method"><a name="cancelJob"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/jobs/cancel</code></pre></div>
|
|
<div class="method-summary">Cancels a job (<span class="nickname">cancelJob</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">JobIdRequestBody <a href="#JobIdRequestBody">JobIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#JobInfoRead">JobInfoRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"job" : {
|
|
"createdAt" : 6,
|
|
"configId" : "configId",
|
|
"id" : 0,
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"attempt" : {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
}, {
|
|
"attempt" : {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#JobInfoRead">JobInfoRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getJobInfo"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/jobs/get</code></pre></div>
|
|
<div class="method-summary">Get information about a job (<span class="nickname">getJobInfo</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">JobIdRequestBody <a href="#JobIdRequestBody">JobIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#JobInfoRead">JobInfoRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"job" : {
|
|
"createdAt" : 6,
|
|
"configId" : "configId",
|
|
"id" : 0,
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"attempt" : {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
}, {
|
|
"attempt" : {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#JobInfoRead">JobInfoRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listJobsFor"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/jobs/list</code></pre></div>
|
|
<div class="method-summary">Returns recent jobs for a connection. Jobs are returned in descending order by createdAt. (<span class="nickname">listJobsFor</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">JobListRequestBody <a href="#JobListRequestBody">JobListRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#JobReadList">JobReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"jobs" : [ {
|
|
"job" : {
|
|
"createdAt" : 6,
|
|
"configId" : "configId",
|
|
"id" : 0,
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
}, {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
} ]
|
|
}, {
|
|
"job" : {
|
|
"createdAt" : 6,
|
|
"configId" : "configId",
|
|
"id" : 0,
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
}, {
|
|
"createdAt" : 5,
|
|
"bytesSynced" : 9,
|
|
"endedAt" : 7,
|
|
"id" : 5,
|
|
"recordsSynced" : 3,
|
|
"updatedAt" : 2
|
|
} ]
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#JobReadList">JobReadList</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Logs">Logs</a></h1>
|
|
<div class="method"><a name="getLogs"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/logs/get</code></pre></div>
|
|
<div class="method-summary">Get logs (<span class="nickname">getLogs</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">LogsRequestBody <a href="#LogsRequestBody">LogsRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
File
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>text/plain</code></li>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Returns the log file
|
|
<a href="#File">File</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Notifications">Notifications</a></h1>
|
|
<div class="method"><a name="tryNotificationConfig"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/notifications/try</code></pre></div>
|
|
<div class="method-summary">Try sending a notifications (<span class="nickname">tryNotificationConfig</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">Notification <a href="#Notification">Notification</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#NotificationRead">NotificationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"message" : "message",
|
|
"status" : "succeeded"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#NotificationRead">NotificationRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Openapi">Openapi</a></h1>
|
|
<div class="method"><a name="getOpenApiSpec"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /v1/openapi</code></pre></div>
|
|
<div class="method-summary">Returns the openapi specification (<span class="nickname">getOpenApiSpec</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
|
|
File
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>text/plain</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Returns the openapi specification file
|
|
<a href="#File">File</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Operation">Operation</a></h1>
|
|
<div class="method"><a name="checkOperation"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/operations/check</code></pre></div>
|
|
<div class="method-summary">Check if an operation to be created is valid (<span class="nickname">checkOperation</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">OperatorConfiguration <a href="#OperatorConfiguration">OperatorConfiguration</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CheckOperationRead">CheckOperationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"message" : "message",
|
|
"status" : "succeeded"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#CheckOperationRead">CheckOperationRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="createOperation"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/operations/create</code></pre></div>
|
|
<div class="method-summary">Create an operation to be applied as part of a connection pipeline (<span class="nickname">createOperation</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">OperationCreate <a href="#OperationCreate">OperationCreate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#OperationRead">OperationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#OperationRead">OperationRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deleteOperation"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/operations/delete</code></pre></div>
|
|
<div class="method-summary">Delete an operation (<span class="nickname">deleteOperation</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">OperationIdRequestBody <a href="#OperationIdRequestBody">OperationIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">204</h4>
|
|
The resource was deleted successfully.
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getOperation"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/operations/get</code></pre></div>
|
|
<div class="method-summary">Returns an operation (<span class="nickname">getOperation</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">OperationIdRequestBody <a href="#OperationIdRequestBody">OperationIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#OperationRead">OperationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#OperationRead">OperationRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listOperationsForConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/operations/list</code></pre></div>
|
|
<div class="method-summary">Returns all operations for a connection. (<span class="nickname">listOperationsForConnection</span>)</div>
|
|
<div class="method-notes">List operations for connection.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">ConnectionIdRequestBody <a href="#ConnectionIdRequestBody">ConnectionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#OperationReadList">OperationReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"operations" : [ {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#OperationReadList">OperationReadList</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateOperation"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/operations/update</code></pre></div>
|
|
<div class="method-summary">Update an operation (<span class="nickname">updateOperation</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">OperationUpdate <a href="#OperationUpdate">OperationUpdate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#OperationRead">OperationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#OperationRead">OperationRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Scheduler">Scheduler</a></h1>
|
|
<div class="method"><a name="executeDestinationCheckConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/scheduler/destinations/check_connection</code></pre></div>
|
|
<div class="method-summary">Run check connection for a given destination configuration (<span class="nickname">executeDestinationCheckConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationCoreConfig <a href="#DestinationCoreConfig">DestinationCoreConfig</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"message" : "message",
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
},
|
|
"status" : "succeeded"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="executeSourceCheckConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/scheduler/sources/check_connection</code></pre></div>
|
|
<div class="method-summary">Run check connection for a given source configuration (<span class="nickname">executeSourceCheckConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceCoreConfig <a href="#SourceCoreConfig">SourceCoreConfig</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"message" : "message",
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
},
|
|
"status" : "succeeded"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="executeSourceDiscoverSchema"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/scheduler/sources/discover_schema</code></pre></div>
|
|
<div class="method-summary">Run discover schema for a given source a source configuration (<span class="nickname">executeSourceDiscoverSchema</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceCoreConfig <a href="#SourceCoreConfig">SourceCoreConfig</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceDiscoverSchemaRead">SourceDiscoverSchemaRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"catalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
}
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceDiscoverSchemaRead">SourceDiscoverSchemaRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Source">Source</a></h1>
|
|
<div class="method"><a name="checkConnectionToSource"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/sources/check_connection</code></pre></div>
|
|
<div class="method-summary">Check connection to the source (<span class="nickname">checkConnectionToSource</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceIdRequestBody <a href="#SourceIdRequestBody">SourceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"message" : "message",
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
},
|
|
"status" : "succeeded"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="checkConnectionToSourceForUpdate"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/sources/check_connection_for_update</code></pre></div>
|
|
<div class="method-summary">Check connection for a proposed update to a source (<span class="nickname">checkConnectionToSourceForUpdate</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceUpdate <a href="#SourceUpdate">SourceUpdate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"message" : "message",
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
},
|
|
"status" : "succeeded"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#CheckConnectionRead">CheckConnectionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="createSource"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/sources/create</code></pre></div>
|
|
<div class="method-summary">Create a source (<span class="nickname">createSource</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceCreate <a href="#SourceCreate">SourceCreate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceRead">SourceRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceRead">SourceRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deleteSource"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/sources/delete</code></pre></div>
|
|
<div class="method-summary">Delete a source (<span class="nickname">deleteSource</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceIdRequestBody <a href="#SourceIdRequestBody">SourceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">204</h4>
|
|
The resource was deleted successfully.
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="discoverSchemaForSource"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/sources/discover_schema</code></pre></div>
|
|
<div class="method-summary">Discover the schema catalog of the source (<span class="nickname">discoverSchemaForSource</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceIdRequestBody <a href="#SourceIdRequestBody">SourceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceDiscoverSchemaRead">SourceDiscoverSchemaRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"catalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
}
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceDiscoverSchemaRead">SourceDiscoverSchemaRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getSource"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/sources/get</code></pre></div>
|
|
<div class="method-summary">Get source (<span class="nickname">getSource</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceIdRequestBody <a href="#SourceIdRequestBody">SourceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceRead">SourceRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceRead">SourceRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listSourcesForWorkspace"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/sources/list</code></pre></div>
|
|
<div class="method-summary">List sources for workspace (<span class="nickname">listSourcesForWorkspace</span>)</div>
|
|
<div class="method-notes">List sources for workspace. Does not return deleted sources.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WorkspaceIdRequestBody <a href="#WorkspaceIdRequestBody">WorkspaceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceReadList">SourceReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sources" : [ {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceReadList">SourceReadList</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateSource"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/sources/update</code></pre></div>
|
|
<div class="method-summary">Update a source (<span class="nickname">updateSource</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceUpdate <a href="#SourceUpdate">SourceUpdate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceRead">SourceRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceRead">SourceRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="SourceDefinition">SourceDefinition</a></h1>
|
|
<div class="method"><a name="createSourceDefinition"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/source_definitions/create</code></pre></div>
|
|
<div class="method-summary">Creates a sourceDefinition (<span class="nickname">createSourceDefinition</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceDefinitionCreate <a href="#SourceDefinitionCreate">SourceDefinitionCreate</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceDefinitionRead">SourceDefinitionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceDefinitionRead">SourceDefinitionRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getSourceDefinition"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/source_definitions/get</code></pre></div>
|
|
<div class="method-summary">Get source (<span class="nickname">getSourceDefinition</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceDefinitionIdRequestBody <a href="#SourceDefinitionIdRequestBody">SourceDefinitionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceDefinitionRead">SourceDefinitionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceDefinitionRead">SourceDefinitionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listLatestSourceDefinitions"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/source_definitions/list_latest</code></pre></div>
|
|
<div class="method-summary">List the latest sourceDefinitions Airbyte supports (<span class="nickname">listLatestSourceDefinitions</span>)</div>
|
|
<div class="method-notes">Guaranteed to retrieve the latest information on supported sources.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceDefinitionReadList">SourceDefinitionReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceDefinitions" : [ {
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceDefinitionReadList">SourceDefinitionReadList</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listSourceDefinitions"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/source_definitions/list</code></pre></div>
|
|
<div class="method-summary">List all the sourceDefinitions the current Airbyte deployment is configured to use (<span class="nickname">listSourceDefinitions</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceDefinitionReadList">SourceDefinitionReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceDefinitions" : [ {
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceDefinitionReadList">SourceDefinitionReadList</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateSourceDefinition"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/source_definitions/update</code></pre></div>
|
|
<div class="method-summary">Update a sourceDefinition (<span class="nickname">updateSourceDefinition</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceDefinitionUpdate <a href="#SourceDefinitionUpdate">SourceDefinitionUpdate</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceDefinitionRead">SourceDefinitionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceDefinitionRead">SourceDefinitionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="SourceDefinitionSpecification">SourceDefinitionSpecification</a></h1>
|
|
<div class="method"><a name="getSourceDefinitionSpecification"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/source_definition_specifications/get</code></pre></div>
|
|
<div class="method-summary">Get specification for a SourceDefinition. (<span class="nickname">getSourceDefinitionSpecification</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceDefinitionIdRequestBody <a href="#SourceDefinitionIdRequestBody">SourceDefinitionIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceDefinitionSpecificationRead">SourceDefinitionSpecificationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"documentationUrl" : "documentationUrl",
|
|
"connectionSpecification" : {
|
|
"user" : {
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
}
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceDefinitionSpecificationRead">SourceDefinitionSpecificationRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="WebBackend">WebBackend</a></h1>
|
|
<div class="method"><a name="webBackendCreateConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/web_backend/connections/create</code></pre></div>
|
|
<div class="method-summary">Create a connection (<span class="nickname">webBackendCreateConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WebBackendConnectionCreate <a href="#WebBackendConnectionCreate">WebBackendConnectionCreate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WebBackendConnectionRead">WebBackendConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"latestSyncJobCreatedAt" : 0,
|
|
"prefix" : "prefix",
|
|
"destination" : {
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"isSyncing" : true,
|
|
"source" : {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"operations" : [ {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#WebBackendConnectionRead">WebBackendConnectionRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="webBackendGetConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/web_backend/connections/get</code></pre></div>
|
|
<div class="method-summary">Get a connection (<span class="nickname">webBackendGetConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WebBackendConnectionRequestBody <a href="#WebBackendConnectionRequestBody">WebBackendConnectionRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WebBackendConnectionRead">WebBackendConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"latestSyncJobCreatedAt" : 0,
|
|
"prefix" : "prefix",
|
|
"destination" : {
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"isSyncing" : true,
|
|
"source" : {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"operations" : [ {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#WebBackendConnectionRead">WebBackendConnectionRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="webBackendListConnectionsForWorkspace"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/web_backend/connections/list</code></pre></div>
|
|
<div class="method-summary">Returns all connections for a workspace. (<span class="nickname">webBackendListConnectionsForWorkspace</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WorkspaceIdRequestBody <a href="#WorkspaceIdRequestBody">WorkspaceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WebBackendConnectionReadList">WebBackendConnectionReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"connections" : [ {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"latestSyncJobCreatedAt" : 0,
|
|
"prefix" : "prefix",
|
|
"destination" : {
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"isSyncing" : true,
|
|
"source" : {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"operations" : [ {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ]
|
|
}, {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"latestSyncJobCreatedAt" : 0,
|
|
"prefix" : "prefix",
|
|
"destination" : {
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"isSyncing" : true,
|
|
"source" : {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"operations" : [ {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ]
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#WebBackendConnectionReadList">WebBackendConnectionReadList</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="webBackendRecreateDestination"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/web_backend/destinations/recreate</code></pre></div>
|
|
<div class="method-summary">Recreate a destination (<span class="nickname">webBackendRecreateDestination</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">DestinationRecreate <a href="#DestinationRecreate">DestinationRecreate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#DestinationRead">DestinationRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#DestinationRead">DestinationRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="webBackendRecreateSource"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/web_backend/sources/recreate</code></pre></div>
|
|
<div class="method-summary">Recreate a source (<span class="nickname">webBackendRecreateSource</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SourceRecreate <a href="#SourceRecreate">SourceRecreate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#SourceRead">SourceRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#SourceRead">SourceRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="webBackendUpdateConnection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/web_backend/connections/update</code></pre></div>
|
|
<div class="method-summary">Update a connection (<span class="nickname">webBackendUpdateConnection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WebBackendConnectionUpdate <a href="#WebBackendConnectionUpdate">WebBackendConnectionUpdate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WebBackendConnectionRead">WebBackendConnectionRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"latestSyncJobCreatedAt" : 0,
|
|
"prefix" : "prefix",
|
|
"destination" : {
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"isSyncing" : true,
|
|
"source" : {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"connectionConfiguration" : {
|
|
"user" : "charles"
|
|
},
|
|
"name" : "name",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"operations" : [ {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"name" : "name",
|
|
"syncCatalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
}, {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#WebBackendConnectionRead">WebBackendConnectionRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Workspace">Workspace</a></h1>
|
|
<div class="method"><a name="createWorkspace"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/workspaces/create</code></pre></div>
|
|
<div class="method-summary">Creates a workspace (<span class="nickname">createWorkspace</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WorkspaceCreate <a href="#WorkspaceCreate">WorkspaceCreate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WorkspaceRead">WorkspaceRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"displaySetupWizard" : true,
|
|
"news" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
} ],
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#WorkspaceRead">WorkspaceRead</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deleteWorkspace"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/workspaces/delete</code></pre></div>
|
|
<div class="method-summary">Deletes a workspace (<span class="nickname">deleteWorkspace</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WorkspaceIdRequestBody <a href="#WorkspaceIdRequestBody">WorkspaceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">204</h4>
|
|
The resource was deleted successfully.
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getWorkspace"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/workspaces/get</code></pre></div>
|
|
<div class="method-summary">Find workspace by ID (<span class="nickname">getWorkspace</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WorkspaceIdRequestBody <a href="#WorkspaceIdRequestBody">WorkspaceIdRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WorkspaceRead">WorkspaceRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"displaySetupWizard" : true,
|
|
"news" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
} ],
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#WorkspaceRead">WorkspaceRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getWorkspaceBySlug"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/workspaces/get_by_slug</code></pre></div>
|
|
<div class="method-summary">Find workspace by slug (<span class="nickname">getWorkspaceBySlug</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">SlugRequestBody <a href="#SlugRequestBody">SlugRequestBody</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WorkspaceRead">WorkspaceRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"displaySetupWizard" : true,
|
|
"news" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
} ],
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#WorkspaceRead">WorkspaceRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="listWorkspaces"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/workspaces/list</code></pre></div>
|
|
<div class="method-summary">List all workspaces registered in the current Airbyte deployment (<span class="nickname">listWorkspaces</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WorkspaceReadList">WorkspaceReadList</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"workspaces" : [ {
|
|
"displaySetupWizard" : true,
|
|
"news" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
} ],
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"displaySetupWizard" : true,
|
|
"news" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
} ],
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#WorkspaceReadList">WorkspaceReadList</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateWorkspace"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/workspaces/update</code></pre></div>
|
|
<div class="method-summary">Update workspace state (<span class="nickname">updateWorkspace</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">WorkspaceUpdate <a href="#WorkspaceUpdate">WorkspaceUpdate</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WorkspaceRead">WorkspaceRead</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"displaySetupWizard" : true,
|
|
"news" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
}
|
|
} ],
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
<a href="#WorkspaceRead">WorkspaceRead</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
<h4 class="field-label">422</h4>
|
|
Input failed validation
|
|
<a href="#InvalidInputExceptionInfo">InvalidInputExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<h2><a name="__Models">Models</a></h2>
|
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
|
|
|
<h3>Table of Contents</h3>
|
|
<ol>
|
|
<li><a href="#AirbyteCatalog"><code>AirbyteCatalog</code> - </a></li>
|
|
<li><a href="#AirbyteStream"><code>AirbyteStream</code> - </a></li>
|
|
<li><a href="#AirbyteStreamAndConfiguration"><code>AirbyteStreamAndConfiguration</code> - </a></li>
|
|
<li><a href="#AirbyteStreamConfiguration"><code>AirbyteStreamConfiguration</code> - </a></li>
|
|
<li><a href="#AttemptInfoRead"><code>AttemptInfoRead</code> - </a></li>
|
|
<li><a href="#AttemptRead"><code>AttemptRead</code> - </a></li>
|
|
<li><a href="#AttemptStatus"><code>AttemptStatus</code> - </a></li>
|
|
<li><a href="#CheckConnectionRead"><code>CheckConnectionRead</code> - </a></li>
|
|
<li><a href="#CheckOperationRead"><code>CheckOperationRead</code> - </a></li>
|
|
<li><a href="#ConnectionCreate"><code>ConnectionCreate</code> - </a></li>
|
|
<li><a href="#ConnectionIdRequestBody"><code>ConnectionIdRequestBody</code> - </a></li>
|
|
<li><a href="#ConnectionRead"><code>ConnectionRead</code> - </a></li>
|
|
<li><a href="#ConnectionReadList"><code>ConnectionReadList</code> - </a></li>
|
|
<li><a href="#ConnectionSchedule"><code>ConnectionSchedule</code> - </a></li>
|
|
<li><a href="#ConnectionState"><code>ConnectionState</code> - </a></li>
|
|
<li><a href="#ConnectionStatus"><code>ConnectionStatus</code> - </a></li>
|
|
<li><a href="#ConnectionUpdate"><code>ConnectionUpdate</code> - </a></li>
|
|
<li><a href="#DataType"><code>DataType</code> - </a></li>
|
|
<li><a href="#DbMigrationExecutionRead"><code>DbMigrationExecutionRead</code> - </a></li>
|
|
<li><a href="#DbMigrationRead"><code>DbMigrationRead</code> - </a></li>
|
|
<li><a href="#DbMigrationReadList"><code>DbMigrationReadList</code> - </a></li>
|
|
<li><a href="#DbMigrationRequestBody"><code>DbMigrationRequestBody</code> - </a></li>
|
|
<li><a href="#DbMigrationState"><code>DbMigrationState</code> - </a></li>
|
|
<li><a href="#DestinationCoreConfig"><code>DestinationCoreConfig</code> - </a></li>
|
|
<li><a href="#DestinationCreate"><code>DestinationCreate</code> - </a></li>
|
|
<li><a href="#DestinationDefinitionCreate"><code>DestinationDefinitionCreate</code> - </a></li>
|
|
<li><a href="#DestinationDefinitionIdRequestBody"><code>DestinationDefinitionIdRequestBody</code> - </a></li>
|
|
<li><a href="#DestinationDefinitionRead"><code>DestinationDefinitionRead</code> - </a></li>
|
|
<li><a href="#DestinationDefinitionReadList"><code>DestinationDefinitionReadList</code> - </a></li>
|
|
<li><a href="#DestinationDefinitionSpecificationRead"><code>DestinationDefinitionSpecificationRead</code> - </a></li>
|
|
<li><a href="#DestinationDefinitionUpdate"><code>DestinationDefinitionUpdate</code> - </a></li>
|
|
<li><a href="#DestinationIdRequestBody"><code>DestinationIdRequestBody</code> - </a></li>
|
|
<li><a href="#DestinationRead"><code>DestinationRead</code> - </a></li>
|
|
<li><a href="#DestinationReadList"><code>DestinationReadList</code> - </a></li>
|
|
<li><a href="#DestinationRecreate"><code>DestinationRecreate</code> - </a></li>
|
|
<li><a href="#DestinationSyncMode"><code>DestinationSyncMode</code> - </a></li>
|
|
<li><a href="#DestinationUpdate"><code>DestinationUpdate</code> - </a></li>
|
|
<li><a href="#HealthCheckRead"><code>HealthCheckRead</code> - </a></li>
|
|
<li><a href="#ImportRead"><code>ImportRead</code> - </a></li>
|
|
<li><a href="#InvalidInputExceptionInfo"><code>InvalidInputExceptionInfo</code> - </a></li>
|
|
<li><a href="#InvalidInputProperty"><code>InvalidInputProperty</code> - </a></li>
|
|
<li><a href="#JobConfigType"><code>JobConfigType</code> - </a></li>
|
|
<li><a href="#JobIdRequestBody"><code>JobIdRequestBody</code> - </a></li>
|
|
<li><a href="#JobInfoRead"><code>JobInfoRead</code> - </a></li>
|
|
<li><a href="#JobListRequestBody"><code>JobListRequestBody</code> - </a></li>
|
|
<li><a href="#JobRead"><code>JobRead</code> - </a></li>
|
|
<li><a href="#JobReadList"><code>JobReadList</code> - </a></li>
|
|
<li><a href="#JobStatus"><code>JobStatus</code> - </a></li>
|
|
<li><a href="#JobWithAttemptsRead"><code>JobWithAttemptsRead</code> - </a></li>
|
|
<li><a href="#KnownExceptionInfo"><code>KnownExceptionInfo</code> - </a></li>
|
|
<li><a href="#LogRead"><code>LogRead</code> - </a></li>
|
|
<li><a href="#LogType"><code>LogType</code> - </a></li>
|
|
<li><a href="#LogsRequestBody"><code>LogsRequestBody</code> - </a></li>
|
|
<li><a href="#NamespaceDefinitionType"><code>NamespaceDefinitionType</code> - </a></li>
|
|
<li><a href="#NotFoundKnownExceptionInfo"><code>NotFoundKnownExceptionInfo</code> - </a></li>
|
|
<li><a href="#Notification"><code>Notification</code> - </a></li>
|
|
<li><a href="#NotificationRead"><code>NotificationRead</code> - </a></li>
|
|
<li><a href="#NotificationType"><code>NotificationType</code> - </a></li>
|
|
<li><a href="#OperationCreate"><code>OperationCreate</code> - </a></li>
|
|
<li><a href="#OperationIdRequestBody"><code>OperationIdRequestBody</code> - </a></li>
|
|
<li><a href="#OperationRead"><code>OperationRead</code> - </a></li>
|
|
<li><a href="#OperationReadList"><code>OperationReadList</code> - </a></li>
|
|
<li><a href="#OperationUpdate"><code>OperationUpdate</code> - </a></li>
|
|
<li><a href="#OperatorConfiguration"><code>OperatorConfiguration</code> - </a></li>
|
|
<li><a href="#OperatorDbt"><code>OperatorDbt</code> - </a></li>
|
|
<li><a href="#OperatorNormalization"><code>OperatorNormalization</code> - </a></li>
|
|
<li><a href="#OperatorType"><code>OperatorType</code> - </a></li>
|
|
<li><a href="#Pagination"><code>Pagination</code> - </a></li>
|
|
<li><a href="#ResourceRequirements"><code>ResourceRequirements</code> - </a></li>
|
|
<li><a href="#SlackNotificationConfiguration"><code>SlackNotificationConfiguration</code> - </a></li>
|
|
<li><a href="#SlugRequestBody"><code>SlugRequestBody</code> - </a></li>
|
|
<li><a href="#SourceCoreConfig"><code>SourceCoreConfig</code> - </a></li>
|
|
<li><a href="#SourceCreate"><code>SourceCreate</code> - </a></li>
|
|
<li><a href="#SourceDefinitionCreate"><code>SourceDefinitionCreate</code> - </a></li>
|
|
<li><a href="#SourceDefinitionIdRequestBody"><code>SourceDefinitionIdRequestBody</code> - </a></li>
|
|
<li><a href="#SourceDefinitionRead"><code>SourceDefinitionRead</code> - </a></li>
|
|
<li><a href="#SourceDefinitionReadList"><code>SourceDefinitionReadList</code> - </a></li>
|
|
<li><a href="#SourceDefinitionSpecificationRead"><code>SourceDefinitionSpecificationRead</code> - </a></li>
|
|
<li><a href="#SourceDefinitionUpdate"><code>SourceDefinitionUpdate</code> - </a></li>
|
|
<li><a href="#SourceDiscoverSchemaRead"><code>SourceDiscoverSchemaRead</code> - </a></li>
|
|
<li><a href="#SourceIdRequestBody"><code>SourceIdRequestBody</code> - </a></li>
|
|
<li><a href="#SourceRead"><code>SourceRead</code> - </a></li>
|
|
<li><a href="#SourceReadList"><code>SourceReadList</code> - </a></li>
|
|
<li><a href="#SourceRecreate"><code>SourceRecreate</code> - </a></li>
|
|
<li><a href="#SourceUpdate"><code>SourceUpdate</code> - </a></li>
|
|
<li><a href="#SyncMode"><code>SyncMode</code> - </a></li>
|
|
<li><a href="#SynchronousJobRead"><code>SynchronousJobRead</code> - </a></li>
|
|
<li><a href="#WebBackendConnectionCreate"><code>WebBackendConnectionCreate</code> - </a></li>
|
|
<li><a href="#WebBackendConnectionRead"><code>WebBackendConnectionRead</code> - </a></li>
|
|
<li><a href="#WebBackendConnectionReadList"><code>WebBackendConnectionReadList</code> - </a></li>
|
|
<li><a href="#WebBackendConnectionRequestBody"><code>WebBackendConnectionRequestBody</code> - </a></li>
|
|
<li><a href="#WebBackendConnectionUpdate"><code>WebBackendConnectionUpdate</code> - </a></li>
|
|
<li><a href="#WebBackendOperationCreateOrUpdate"><code>WebBackendOperationCreateOrUpdate</code> - </a></li>
|
|
<li><a href="#WorkspaceCreate"><code>WorkspaceCreate</code> - </a></li>
|
|
<li><a href="#WorkspaceIdRequestBody"><code>WorkspaceIdRequestBody</code> - </a></li>
|
|
<li><a href="#WorkspaceRead"><code>WorkspaceRead</code> - </a></li>
|
|
<li><a href="#WorkspaceReadList"><code>WorkspaceReadList</code> - </a></li>
|
|
<li><a href="#WorkspaceUpdate"><code>WorkspaceUpdate</code> - </a></li>
|
|
</ol>
|
|
|
|
<div class="model">
|
|
<h3><a name="AirbyteCatalog"><code>AirbyteCatalog</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>describes the available schema (catalog).</div>
|
|
<div class="field-items">
|
|
<div class="param">streams </div><div class="param-desc"><span class="param-type"><a href="#AirbyteStreamAndConfiguration">array[AirbyteStreamAndConfiguration]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AirbyteStream"><code>AirbyteStream</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>the immutable schema defined by the source</div>
|
|
<div class="field-items">
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Stream's name. </div>
|
|
<div class="param">jsonSchema (optional)</div><div class="param-desc"><span class="param-type"><a href="#StreamJsonSchema">StreamJsonSchema</a></span> </div>
|
|
<div class="param">supportedSyncModes (optional)</div><div class="param-desc"><span class="param-type"><a href="#SyncMode">array[SyncMode]</a></span> </div>
|
|
<div class="param">sourceDefinedCursor (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> If the source defines the cursor field, then any other cursor field inputs will be ignored. If it does not, either the user_provided one is used, or the default one is used as a backup. </div>
|
|
<div class="param">defaultCursorField (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> Path to the field that will be used to determine if a record is new or modified since the last sync. If not provided by the source, the end user will have to specify the comparable themselves. </div>
|
|
<div class="param">sourceDefinedPrimaryKey (optional)</div><div class="param-desc"><span class="param-type"><a href="#array">array[array[String]]</a></span> If the source defines the primary key, paths to the fields that will be used as a primary key. If not provided by the source, the end user will have to specify the primary key themselves. </div>
|
|
<div class="param">namespace (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Optional Source-defined namespace. Airbyte streams from the same sources should have the same namespace. Currently only used by JDBC destinations to determine what schema to write to. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AirbyteStreamAndConfiguration"><code>AirbyteStreamAndConfiguration</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>each stream is split in two parts; the immutable schema from source and mutable configuration for destination</div>
|
|
<div class="field-items">
|
|
<div class="param">stream (optional)</div><div class="param-desc"><span class="param-type"><a href="#AirbyteStream">AirbyteStream</a></span> </div>
|
|
<div class="param">config (optional)</div><div class="param-desc"><span class="param-type"><a href="#AirbyteStreamConfiguration">AirbyteStreamConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AirbyteStreamConfiguration"><code>AirbyteStreamConfiguration</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>the mutable part of the stream to configure the destination</div>
|
|
<div class="field-items">
|
|
<div class="param">syncMode </div><div class="param-desc"><span class="param-type"><a href="#SyncMode">SyncMode</a></span> </div>
|
|
<div class="param">cursorField (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if <code>sync_mode</code> is <code>incremental</code>. Otherwise it is ignored. </div>
|
|
<div class="param">destinationSyncMode </div><div class="param-desc"><span class="param-type"><a href="#DestinationSyncMode">DestinationSyncMode</a></span> </div>
|
|
<div class="param">primaryKey (optional)</div><div class="param-desc"><span class="param-type"><a href="#array">array[array[String]]</a></span> Paths to the fields that will be used as primary key. This field is REQUIRED if <code>destination_sync_mode</code> is <code>*_dedup</code>. Otherwise it is ignored. </div>
|
|
<div class="param">aliasName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Alias name to the stream to be used in the destination </div>
|
|
<div class="param">selected (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AttemptInfoRead"><code>AttemptInfoRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">attempt </div><div class="param-desc"><span class="param-type"><a href="#AttemptRead">AttemptRead</a></span> </div>
|
|
<div class="param">logs </div><div class="param-desc"><span class="param-type"><a href="#LogRead">LogRead</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AttemptRead"><code>AttemptRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#AttemptStatus">AttemptStatus</a></span> </div>
|
|
<div class="param">createdAt </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">updatedAt </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">endedAt (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">bytesSynced (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">recordsSynced (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AttemptStatus"><code>AttemptStatus</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="CheckConnectionRead"><code>CheckConnectionRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">succeeded</div><div class="param-enum">failed</div>
|
|
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">jobInfo </div><div class="param-desc"><span class="param-type"><a href="#SynchronousJobRead">SynchronousJobRead</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="CheckOperationRead"><code>CheckOperationRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">succeeded</div><div class="param-enum">failed</div>
|
|
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionCreate"><code>ConnectionCreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Optional name of the connection </div>
|
|
<div class="param">namespaceDefinition (optional)</div><div class="param-desc"><span class="param-type"><a href="#NamespaceDefinitionType">NamespaceDefinitionType</a></span> </div>
|
|
<div class="param">namespaceFormat (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. </div>
|
|
<div class="param">prefix (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Prefix that will be prepended to the name of each stream when it is written to the destination. </div>
|
|
<div class="param">sourceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">destinationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">operationIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">array[UUID]</a></span> format: uuid</div>
|
|
<div class="param">syncCatalog (optional)</div><div class="param-desc"><span class="param-type"><a href="#AirbyteCatalog">AirbyteCatalog</a></span> </div>
|
|
<div class="param">schedule (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionSchedule">ConnectionSchedule</a></span> </div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#ConnectionStatus">ConnectionStatus</a></span> </div>
|
|
<div class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ResourceRequirements">ResourceRequirements</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionIdRequestBody"><code>ConnectionIdRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connectionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionRead"><code>ConnectionRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connectionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">namespaceDefinition (optional)</div><div class="param-desc"><span class="param-type"><a href="#NamespaceDefinitionType">NamespaceDefinitionType</a></span> </div>
|
|
<div class="param">namespaceFormat (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. </div>
|
|
<div class="param">prefix (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Prefix that will be prepended to the name of each stream when it is written to the destination. </div>
|
|
<div class="param">sourceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">destinationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">operationIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">array[UUID]</a></span> format: uuid</div>
|
|
<div class="param">syncCatalog </div><div class="param-desc"><span class="param-type"><a href="#AirbyteCatalog">AirbyteCatalog</a></span> </div>
|
|
<div class="param">schedule (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionSchedule">ConnectionSchedule</a></span> </div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#ConnectionStatus">ConnectionStatus</a></span> </div>
|
|
<div class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ResourceRequirements">ResourceRequirements</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionReadList"><code>ConnectionReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connections </div><div class="param-desc"><span class="param-type"><a href="#ConnectionRead">array[ConnectionRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionSchedule"><code>ConnectionSchedule</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>if null, then no schedule is set.</div>
|
|
<div class="field-items">
|
|
<div class="param">units </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">timeUnit </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">minutes</div><div class="param-enum">hours</div><div class="param-enum">days</div><div class="param-enum">weeks</div><div class="param-enum">months</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionState"><code>ConnectionState</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connectionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">state (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionStateObject">ConnectionStateObject</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionStatus"><code>ConnectionStatus</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionUpdate"><code>ConnectionUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connectionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">namespaceDefinition (optional)</div><div class="param-desc"><span class="param-type"><a href="#NamespaceDefinitionType">NamespaceDefinitionType</a></span> </div>
|
|
<div class="param">namespaceFormat (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. </div>
|
|
<div class="param">prefix (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Prefix that will be prepended to the name of each stream when it is written to the destination. </div>
|
|
<div class="param">operationIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">array[UUID]</a></span> format: uuid</div>
|
|
<div class="param">syncCatalog </div><div class="param-desc"><span class="param-type"><a href="#AirbyteCatalog">AirbyteCatalog</a></span> </div>
|
|
<div class="param">schedule (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionSchedule">ConnectionSchedule</a></span> </div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#ConnectionStatus">ConnectionStatus</a></span> </div>
|
|
<div class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ResourceRequirements">ResourceRequirements</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DataType"><code>DataType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DbMigrationExecutionRead"><code>DbMigrationExecutionRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">initialVersion (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">targetVersion (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">executedMigrations (optional)</div><div class="param-desc"><span class="param-type"><a href="#DbMigrationRead">array[DbMigrationRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DbMigrationRead"><code>DbMigrationRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">migrationType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">migrationVersion </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">migrationDescription </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">migrationState (optional)</div><div class="param-desc"><span class="param-type"><a href="#DbMigrationState">DbMigrationState</a></span> </div>
|
|
<div class="param">migratedBy (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">migratedAt (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">migrationScript (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DbMigrationReadList"><code>DbMigrationReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">migrations (optional)</div><div class="param-desc"><span class="param-type"><a href="#DbMigrationRead">array[DbMigrationRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DbMigrationRequestBody"><code>DbMigrationRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">database </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DbMigrationState"><code>DbMigrationState</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationCoreConfig"><code>DestinationCoreConfig</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#DestinationConfiguration">DestinationConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationCreate"><code>DestinationCreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">destinationDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#DestinationConfiguration">DestinationConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationDefinitionCreate"><code>DestinationDefinitionCreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dockerRepository </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dockerImageTag </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">documentationUrl </div><div class="param-desc"><span class="param-type"><a href="#URI">URI</a></span> format: uri</div>
|
|
<div class="param">icon (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationDefinitionIdRequestBody"><code>DestinationDefinitionIdRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationDefinitionRead"><code>DestinationDefinitionRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dockerRepository </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dockerImageTag </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">documentationUrl </div><div class="param-desc"><span class="param-type"><a href="#URI">URI</a></span> format: uri</div>
|
|
<div class="param">icon (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationDefinitionReadList"><code>DestinationDefinitionReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitions </div><div class="param-desc"><span class="param-type"><a href="#DestinationDefinitionRead">array[DestinationDefinitionRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationDefinitionSpecificationRead"><code>DestinationDefinitionSpecificationRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">documentationUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">connectionSpecification (optional)</div><div class="param-desc"><span class="param-type"><a href="#DestinationDefinitionSpecification">DestinationDefinitionSpecification</a></span> </div>
|
|
<div class="param">jobInfo </div><div class="param-desc"><span class="param-type"><a href="#SynchronousJobRead">SynchronousJobRead</a></span> </div>
|
|
<div class="param">supportedDestinationSyncModes (optional)</div><div class="param-desc"><span class="param-type"><a href="#DestinationSyncMode">array[DestinationSyncMode]</a></span> </div>
|
|
<div class="param">supportsDbt (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">supportsNormalization (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationDefinitionUpdate"><code>DestinationDefinitionUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">dockerImageTag (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationIdRequestBody"><code>DestinationIdRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationRead"><code>DestinationRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">destinationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#DestinationConfiguration">DestinationConfiguration</a></span> </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">destinationName </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationReadList"><code>DestinationReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinations </div><div class="param-desc"><span class="param-type"><a href="#DestinationRead">array[DestinationRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationRecreate"><code>DestinationRecreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">destinationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#DestinationConfiguration">DestinationConfiguration</a></span> </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationSyncMode"><code>DestinationSyncMode</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="DestinationUpdate"><code>DestinationUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#DestinationConfiguration">DestinationConfiguration</a></span> </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="HealthCheckRead"><code>HealthCheckRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">db </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ImportRead"><code>ImportRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">succeeded</div><div class="param-enum">failed</div>
|
|
<div class="param">reason (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="InvalidInputExceptionInfo"><code>InvalidInputExceptionInfo</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">exceptionClassName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">exceptionStack (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
<div class="param">validationErrors </div><div class="param-desc"><span class="param-type"><a href="#InvalidInputProperty">array[InvalidInputProperty]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="InvalidInputProperty"><code>InvalidInputProperty</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">propertyPath </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">invalidValue (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobConfigType"><code>JobConfigType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobIdRequestBody"><code>JobIdRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobInfoRead"><code>JobInfoRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">job </div><div class="param-desc"><span class="param-type"><a href="#JobRead">JobRead</a></span> </div>
|
|
<div class="param">attempts </div><div class="param-desc"><span class="param-type"><a href="#AttemptInfoRead">array[AttemptInfoRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobListRequestBody"><code>JobListRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">configTypes </div><div class="param-desc"><span class="param-type"><a href="#JobConfigType">array[JobConfigType]</a></span> </div>
|
|
<div class="param">configId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">pagination (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Pagination</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobRead"><code>JobRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">configType </div><div class="param-desc"><span class="param-type"><a href="#JobConfigType">JobConfigType</a></span> </div>
|
|
<div class="param">configId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">createdAt </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">updatedAt </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#JobStatus">JobStatus</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobReadList"><code>JobReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">jobs </div><div class="param-desc"><span class="param-type"><a href="#JobWithAttemptsRead">array[JobWithAttemptsRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobStatus"><code>JobStatus</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobWithAttemptsRead"><code>JobWithAttemptsRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">job (optional)</div><div class="param-desc"><span class="param-type"><a href="#JobRead">JobRead</a></span> </div>
|
|
<div class="param">attempts (optional)</div><div class="param-desc"><span class="param-type"><a href="#AttemptRead">array[AttemptRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="KnownExceptionInfo"><code>KnownExceptionInfo</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">exceptionClassName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">exceptionStack (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
<div class="param">rootCauseExceptionClassName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">rootCauseExceptionStack (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="LogRead"><code>LogRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">logLines </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="LogType"><code>LogType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>type/source of logs produced</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="LogsRequestBody"><code>LogsRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">logType </div><div class="param-desc"><span class="param-type"><a href="#LogType">LogType</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="NamespaceDefinitionType"><code>NamespaceDefinitionType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Method used for computing final namespace in destination</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="NotFoundKnownExceptionInfo"><code>NotFoundKnownExceptionInfo</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">exceptionClassName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">exceptionStack (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
<div class="param">rootCauseExceptionClassName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">rootCauseExceptionStack (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Notification"><code>Notification</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">notificationType </div><div class="param-desc"><span class="param-type"><a href="#NotificationType">NotificationType</a></span> </div>
|
|
<div class="param">slackConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#SlackNotificationConfiguration">SlackNotificationConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="NotificationRead"><code>NotificationRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">succeeded</div><div class="param-enum">failed</div>
|
|
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="NotificationType"><code>NotificationType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperationCreate"><code>OperationCreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">operatorConfiguration </div><div class="param-desc"><span class="param-type"><a href="#OperatorConfiguration">OperatorConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperationIdRequestBody"><code>OperationIdRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">OperationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperationRead"><code>OperationRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">operationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">operatorConfiguration </div><div class="param-desc"><span class="param-type"><a href="#OperatorConfiguration">OperatorConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperationReadList"><code>OperationReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">operations </div><div class="param-desc"><span class="param-type"><a href="#OperationRead">array[OperationRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperationUpdate"><code>OperationUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">operationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">operatorConfiguration </div><div class="param-desc"><span class="param-type"><a href="#OperatorConfiguration">OperatorConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperatorConfiguration"><code>OperatorConfiguration</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">operatorType </div><div class="param-desc"><span class="param-type"><a href="#OperatorType">OperatorType</a></span> </div>
|
|
<div class="param">normalization (optional)</div><div class="param-desc"><span class="param-type"><a href="#OperatorNormalization">OperatorNormalization</a></span> </div>
|
|
<div class="param">dbt (optional)</div><div class="param-desc"><span class="param-type"><a href="#OperatorDbt">OperatorDbt</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperatorDbt"><code>OperatorDbt</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">gitRepoUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">gitRepoBranch (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dockerImage (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dbtArguments (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperatorNormalization"><code>OperatorNormalization</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">option (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">basic</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperatorType"><code>OperatorType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Pagination"><code>Pagination</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">pageSize (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
|
<div class="param">rowOffset (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ResourceRequirements"><code>ResourceRequirements</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>optional resource requirements to run workers (blank for unbounded allocations)</div>
|
|
<div class="field-items">
|
|
<div class="param">cpu_request (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">cpu_limit (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">memory_request (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">memory_limit (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SlackNotificationConfiguration"><code>SlackNotificationConfiguration</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">webhook </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SlugRequestBody"><code>SlugRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">slug </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceCoreConfig"><code>SourceCoreConfig</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#SourceConfiguration">SourceConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceCreate"><code>SourceCreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#SourceConfiguration">SourceConfiguration</a></span> </div>
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceDefinitionCreate"><code>SourceDefinitionCreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dockerRepository </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dockerImageTag </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">documentationUrl </div><div class="param-desc"><span class="param-type"><a href="#URI">URI</a></span> format: uri</div>
|
|
<div class="param">icon (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceDefinitionIdRequestBody"><code>SourceDefinitionIdRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceDefinitionRead"><code>SourceDefinitionRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dockerRepository </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">dockerImageTag </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">documentationUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#URI">URI</a></span> format: uri</div>
|
|
<div class="param">icon (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceDefinitionReadList"><code>SourceDefinitionReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitions </div><div class="param-desc"><span class="param-type"><a href="#SourceDefinitionRead">array[SourceDefinitionRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceDefinitionSpecificationRead"><code>SourceDefinitionSpecificationRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">documentationUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">connectionSpecification (optional)</div><div class="param-desc"><span class="param-type"><a href="#SourceDefinitionSpecification">SourceDefinitionSpecification</a></span> </div>
|
|
<div class="param">jobInfo </div><div class="param-desc"><span class="param-type"><a href="#SynchronousJobRead">SynchronousJobRead</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceDefinitionUpdate"><code>SourceDefinitionUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Update the SourceDefinition. Currently, the only allowed attribute to update is the default docker image version.</div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">dockerImageTag </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceDiscoverSchemaRead"><code>SourceDiscoverSchemaRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Returns the results of a discover catalog job. If the job was not successful, the catalog field will not be present. jobInfo will aways be present and its status be used to determine if the job was successful or not.</div>
|
|
<div class="field-items">
|
|
<div class="param">catalog (optional)</div><div class="param-desc"><span class="param-type"><a href="#AirbyteCatalog">AirbyteCatalog</a></span> </div>
|
|
<div class="param">jobInfo </div><div class="param-desc"><span class="param-type"><a href="#SynchronousJobRead">SynchronousJobRead</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceIdRequestBody"><code>SourceIdRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceRead"><code>SourceRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">sourceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#SourceConfiguration">SourceConfiguration</a></span> </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">sourceName </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceReadList"><code>SourceReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sources </div><div class="param-desc"><span class="param-type"><a href="#SourceRead">array[SourceRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceRecreate"><code>SourceRecreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">sourceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#SourceConfiguration">SourceConfiguration</a></span> </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceUpdate"><code>SourceUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration </div><div class="param-desc"><span class="param-type"><a href="#SourceConfiguration">SourceConfiguration</a></span> </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SyncMode"><code>SyncMode</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SynchronousJobRead"><code>SynchronousJobRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">configType </div><div class="param-desc"><span class="param-type"><a href="#JobConfigType">JobConfigType</a></span> </div>
|
|
<div class="param">configId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> only present if a config id was provided. </div>
|
|
<div class="param">createdAt </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">endedAt </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">succeeded </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">logs (optional)</div><div class="param-desc"><span class="param-type"><a href="#LogRead">LogRead</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebBackendConnectionCreate"><code>WebBackendConnectionCreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Optional name of the connection </div>
|
|
<div class="param">namespaceDefinition (optional)</div><div class="param-desc"><span class="param-type"><a href="#NamespaceDefinitionType">NamespaceDefinitionType</a></span> </div>
|
|
<div class="param">namespaceFormat (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. </div>
|
|
<div class="param">prefix (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Prefix that will be prepended to the name of each stream when it is written to the destination. </div>
|
|
<div class="param">sourceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">destinationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">operationIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">array[UUID]</a></span> format: uuid</div>
|
|
<div class="param">syncCatalog (optional)</div><div class="param-desc"><span class="param-type"><a href="#AirbyteCatalog">AirbyteCatalog</a></span> </div>
|
|
<div class="param">schedule (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionSchedule">ConnectionSchedule</a></span> </div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#ConnectionStatus">ConnectionStatus</a></span> </div>
|
|
<div class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ResourceRequirements">ResourceRequirements</a></span> </div>
|
|
<div class="param">operations (optional)</div><div class="param-desc"><span class="param-type"><a href="#OperationCreate">array[OperationCreate]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebBackendConnectionRead"><code>WebBackendConnectionRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connectionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">namespaceDefinition (optional)</div><div class="param-desc"><span class="param-type"><a href="#NamespaceDefinitionType">NamespaceDefinitionType</a></span> </div>
|
|
<div class="param">namespaceFormat (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. </div>
|
|
<div class="param">prefix (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Prefix that will be prepended to the name of each stream when it is written to the destination. </div>
|
|
<div class="param">sourceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">destinationId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">syncCatalog </div><div class="param-desc"><span class="param-type"><a href="#AirbyteCatalog">AirbyteCatalog</a></span> </div>
|
|
<div class="param">schedule (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionSchedule">ConnectionSchedule</a></span> </div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#ConnectionStatus">ConnectionStatus</a></span> </div>
|
|
<div class="param">operationIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">array[UUID]</a></span> format: uuid</div>
|
|
<div class="param">source </div><div class="param-desc"><span class="param-type"><a href="#SourceRead">SourceRead</a></span> </div>
|
|
<div class="param">destination </div><div class="param-desc"><span class="param-type"><a href="#DestinationRead">DestinationRead</a></span> </div>
|
|
<div class="param">operations (optional)</div><div class="param-desc"><span class="param-type"><a href="#OperationRead">array[OperationRead]</a></span> </div>
|
|
<div class="param">latestSyncJobCreatedAt (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> epoch time of the latest sync job. null if no sync job has taken place. format: int64</div>
|
|
<div class="param">latestSyncJobStatus (optional)</div><div class="param-desc"><span class="param-type"><a href="#JobStatus">JobStatus</a></span> </div>
|
|
<div class="param">isSyncing </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ResourceRequirements">ResourceRequirements</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebBackendConnectionReadList"><code>WebBackendConnectionReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connections </div><div class="param-desc"><span class="param-type"><a href="#WebBackendConnectionRead">array[WebBackendConnectionRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebBackendConnectionRequestBody"><code>WebBackendConnectionRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">withRefreshedCatalog (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">connectionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebBackendConnectionUpdate"><code>WebBackendConnectionUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connectionId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">namespaceDefinition (optional)</div><div class="param-desc"><span class="param-type"><a href="#NamespaceDefinitionType">NamespaceDefinitionType</a></span> </div>
|
|
<div class="param">namespaceFormat (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. </div>
|
|
<div class="param">prefix (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Prefix that will be prepended to the name of each stream when it is written to the destination. </div>
|
|
<div class="param">operationIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">array[UUID]</a></span> format: uuid</div>
|
|
<div class="param">syncCatalog </div><div class="param-desc"><span class="param-type"><a href="#AirbyteCatalog">AirbyteCatalog</a></span> </div>
|
|
<div class="param">schedule (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionSchedule">ConnectionSchedule</a></span> </div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#ConnectionStatus">ConnectionStatus</a></span> </div>
|
|
<div class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ResourceRequirements">ResourceRequirements</a></span> </div>
|
|
<div class="param">withRefreshedCatalog (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">operations (optional)</div><div class="param-desc"><span class="param-type"><a href="#WebBackendOperationCreateOrUpdate">array[WebBackendOperationCreateOrUpdate]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebBackendOperationCreateOrUpdate"><code>WebBackendOperationCreateOrUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">operationId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">operatorConfiguration </div><div class="param-desc"><span class="param-type"><a href="#OperatorConfiguration">OperatorConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WorkspaceCreate"><code>WorkspaceCreate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">email (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: email</div>
|
|
<div class="param">anonymousDataCollection (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">news (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">securityUpdates (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">notifications (optional)</div><div class="param-desc"><span class="param-type"><a href="#Notification">array[Notification]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WorkspaceIdRequestBody"><code>WorkspaceIdRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WorkspaceRead"><code>WorkspaceRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">customerId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">email (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: email</div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">slug </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">initialSetupComplete </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">displaySetupWizard (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">anonymousDataCollection (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">news (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">securityUpdates (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">notifications (optional)</div><div class="param-desc"><span class="param-type"><a href="#Notification">array[Notification]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WorkspaceReadList"><code>WorkspaceReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">workspaces </div><div class="param-desc"><span class="param-type"><a href="#WorkspaceRead">array[WorkspaceRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WorkspaceUpdate"><code>WorkspaceUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">email (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: email</div>
|
|
<div class="param">initialSetupComplete </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">displaySetupWizard (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">anonymousDataCollection </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">news </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">securityUpdates </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">notifications (optional)</div><div class="param-desc"><span class="param-type"><a href="#Notification">array[Notification]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
</body>
|
|
</html>
|