12475 lines
540 KiB
HTML
12475 lines
540 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>Authentication (OSS):</p>
|
|
<ul>
|
|
<li>When authenticating to the Configuration API, you must use Basic Authentication by setting the Authentication Header to Basic and base64 encoding the username and password (which are <code>airbyte</code> and <code>password</code> by default - so base64 encoding <code>airbyte:password</code> results in <code>YWlyYnl0ZTpwYXNzd29yZA==</code>). So the full header reads <code>'Authorization': "Basic YWlyYnl0ZTpwYXNzd29yZA=="</code></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="#Attempt">Attempt</a></h4>
|
|
<ul>
|
|
<li><a href="#saveStats"><code><span class="http-method">post</span> /v1/attempt/save_stats</code></a></li>
|
|
<li><a href="#saveSyncConfig"><code><span class="http-method">post</span> /v1/attempt/save_sync_config</code></a></li>
|
|
<li><a href="#setWorkflowInAttempt"><code><span class="http-method">post</span> /v1/attempt/set_workflow_in_attempt</code></a></li>
|
|
</ul>
|
|
<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="#listAllConnectionsForWorkspace"><code><span class="http-method">post</span> /v1/connections/list_all</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="#searchConnections"><code><span class="http-method">post</span> /v1/connections/search</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="#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="#cloneDestination"><code><span class="http-method">post</span> /v1/destinations/clone</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="#searchDestinations"><code><span class="http-method">post</span> /v1/destinations/search</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="#createCustomDestinationDefinition"><code><span class="http-method">post</span> /v1/destination_definitions/create_custom</code></a></li>
|
|
<li><a href="#deleteDestinationDefinition"><code><span class="http-method">post</span> /v1/destination_definitions/delete</code></a></li>
|
|
<li><a href="#getDestinationDefinition"><code><span class="http-method">post</span> /v1/destination_definitions/get</code></a></li>
|
|
<li><a href="#getDestinationDefinitionForWorkspace"><code><span class="http-method">post</span> /v1/destination_definitions/get_for_workspace</code></a></li>
|
|
<li><a href="#grantDestinationDefinitionToWorkspace"><code><span class="http-method">post</span> /v1/destination_definitions/grant_definition</code></a></li>
|
|
<li><a href="#listDestinationDefinitions"><code><span class="http-method">post</span> /v1/destination_definitions/list</code></a></li>
|
|
<li><a href="#listDestinationDefinitionsForWorkspace"><code><span class="http-method">post</span> /v1/destination_definitions/list_for_workspace</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="#listPrivateDestinationDefinitions"><code><span class="http-method">post</span> /v1/destination_definitions/list_private</code></a></li>
|
|
<li><a href="#revokeDestinationDefinitionFromWorkspace"><code><span class="http-method">post</span> /v1/destination_definitions/revoke_definition</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="#DestinationOauth">DestinationOauth</a></h4>
|
|
<ul>
|
|
<li><a href="#completeDestinationOAuth"><code><span class="http-method">post</span> /v1/destination_oauths/complete_oauth</code></a></li>
|
|
<li><a href="#getDestinationOAuthConsent"><code><span class="http-method">post</span> /v1/destination_oauths/get_consent_url</code></a></li>
|
|
<li><a href="#setInstancewideDestinationOauthParams"><code><span class="http-method">post</span> /v1/destination_oauths/oauth_params/create</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="#Internal">Internal</a></h4>
|
|
<ul>
|
|
<li><a href="#createOrUpdateState"><code><span class="http-method">post</span> /v1/state/create_or_update</code></a></li>
|
|
<li><a href="#getAttemptNormalizationStatusesForJob"><code><span class="http-method">post</span> /v1/jobs/get_normalization_status</code></a></li>
|
|
<li><a href="#saveStats"><code><span class="http-method">post</span> /v1/attempt/save_stats</code></a></li>
|
|
<li><a href="#saveSyncConfig"><code><span class="http-method">post</span> /v1/attempt/save_sync_config</code></a></li>
|
|
<li><a href="#setWorkflowInAttempt"><code><span class="http-method">post</span> /v1/attempt/set_workflow_in_attempt</code></a></li>
|
|
<li><a href="#writeDiscoverCatalogResult"><code><span class="http-method">post</span> /v1/sources/write_discover_catalog_result</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="#getAttemptNormalizationStatusesForJob"><code><span class="http-method">post</span> /v1/jobs/get_normalization_status</code></a></li>
|
|
<li><a href="#getJobDebugInfo"><code><span class="http-method">post</span> /v1/jobs/get_debug_info</code></a></li>
|
|
<li><a href="#getJobInfo"><code><span class="http-method">post</span> /v1/jobs/get</code></a></li>
|
|
<li><a href="#getJobInfoLight"><code><span class="http-method">post</span> /v1/jobs/get_light</code></a></li>
|
|
<li><a href="#getLastReplicationJob"><code><span class="http-method">post</span> /v1/jobs/get_last_replication_job</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="#cloneSource"><code><span class="http-method">post</span> /v1/sources/clone</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="#getMostRecentSourceActorCatalog"><code><span class="http-method">post</span> /v1/sources/most_recent_source_actor_catalog</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="#searchSources"><code><span class="http-method">post</span> /v1/sources/search</code></a></li>
|
|
<li><a href="#updateSource"><code><span class="http-method">post</span> /v1/sources/update</code></a></li>
|
|
<li><a href="#writeDiscoverCatalogResult"><code><span class="http-method">post</span> /v1/sources/write_discover_catalog_result</code></a></li>
|
|
</ul>
|
|
<h4><a href="#SourceDefinition">SourceDefinition</a></h4>
|
|
<ul>
|
|
<li><a href="#createCustomSourceDefinition"><code><span class="http-method">post</span> /v1/source_definitions/create_custom</code></a></li>
|
|
<li><a href="#deleteSourceDefinition"><code><span class="http-method">post</span> /v1/source_definitions/delete</code></a></li>
|
|
<li><a href="#getSourceDefinition"><code><span class="http-method">post</span> /v1/source_definitions/get</code></a></li>
|
|
<li><a href="#getSourceDefinitionForWorkspace"><code><span class="http-method">post</span> /v1/source_definitions/get_for_workspace</code></a></li>
|
|
<li><a href="#grantSourceDefinitionToWorkspace"><code><span class="http-method">post</span> /v1/source_definitions/grant_definition</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="#listPrivateSourceDefinitions"><code><span class="http-method">post</span> /v1/source_definitions/list_private</code></a></li>
|
|
<li><a href="#listSourceDefinitions"><code><span class="http-method">post</span> /v1/source_definitions/list</code></a></li>
|
|
<li><a href="#listSourceDefinitionsForWorkspace"><code><span class="http-method">post</span> /v1/source_definitions/list_for_workspace</code></a></li>
|
|
<li><a href="#revokeSourceDefinitionFromWorkspace"><code><span class="http-method">post</span> /v1/source_definitions/revoke_definition</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="#SourceOauth">SourceOauth</a></h4>
|
|
<ul>
|
|
<li><a href="#completeSourceOAuth"><code><span class="http-method">post</span> /v1/source_oauths/complete_oauth</code></a></li>
|
|
<li><a href="#getSourceOAuthConsent"><code><span class="http-method">post</span> /v1/source_oauths/get_consent_url</code></a></li>
|
|
<li><a href="#setInstancewideSourceOauthParams"><code><span class="http-method">post</span> /v1/source_oauths/oauth_params/create</code></a></li>
|
|
</ul>
|
|
<h4><a href="#State">State</a></h4>
|
|
<ul>
|
|
<li><a href="#createOrUpdateState"><code><span class="http-method">post</span> /v1/state/create_or_update</code></a></li>
|
|
<li><a href="#getState"><code><span class="http-method">post</span> /v1/state/get</code></a></li>
|
|
</ul>
|
|
<h4><a href="#WebBackend">WebBackend</a></h4>
|
|
<ul>
|
|
<li><a href="#getStateType"><code><span class="http-method">post</span> /v1/web_backend/state/get_type</code></a></li>
|
|
<li><a href="#webBackendCheckUpdates"><code><span class="http-method">post</span> /v1/web_backend/check_updates</code></a></li>
|
|
<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="#webBackendGetWorkspaceState"><code><span class="http-method">post</span> /v1/web_backend/workspace/state</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="#webBackendListGeographies"><code><span class="http-method">post</span> /v1/web_backend/geographies/list</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="#getWorkspaceByConnectionId"><code><span class="http-method">post</span> /v1/workspaces/get_by_connection_id</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>
|
|
<li><a href="#updateWorkspaceFeedback"><code><span class="http-method">post</span> /v1/workspaces/tag_feedback_status_as_done</code></a></li>
|
|
<li><a href="#updateWorkspaceName"><code><span class="http-method">post</span> /v1/workspaces/update_name</code></a></li>
|
|
</ul>
|
|
|
|
<h1><a name="Attempt">Attempt</a></h1>
|
|
<div class="method"><a name="saveStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/attempt/save_stats</code></pre></div>
|
|
<div class="method-summary">For worker to set sync stats of a running attempt. (<span class="nickname">saveStats</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">SaveStatsRequestBody <a href="#SaveStatsRequestBody">SaveStatsRequestBody</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="#InternalOperationResult">InternalOperationResult</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>{
|
|
"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="#InternalOperationResult">InternalOperationResult</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="saveSyncConfig"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/attempt/save_sync_config</code></pre></div>
|
|
<div class="method-summary">For worker to save the AttemptSyncConfig for an attempt. (<span class="nickname">saveSyncConfig</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">SaveAttemptSyncConfigRequestBody <a href="#SaveAttemptSyncConfigRequestBody">SaveAttemptSyncConfigRequestBody</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="#InternalOperationResult">InternalOperationResult</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>{
|
|
"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="#InternalOperationResult">InternalOperationResult</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setWorkflowInAttempt"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/attempt/set_workflow_in_attempt</code></pre></div>
|
|
<div class="method-summary">For worker to register the workflow id in attempt. (<span class="nickname">setWorkflowInAttempt</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">SetWorkflowInAttemptRequestBody <a href="#SetWorkflowInAttemptRequestBody">SetWorkflowInAttemptRequestBody</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="#InternalOperationResult">InternalOperationResult</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>{
|
|
"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="#InternalOperationResult">InternalOperationResult</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<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",
|
|
"sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"prefix" : "prefix",
|
|
"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"
|
|
},
|
|
"breakingChange" : true,
|
|
"notifySchemaChanges" : true,
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
}</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",
|
|
"sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"prefix" : "prefix",
|
|
"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"
|
|
},
|
|
"breakingChange" : true,
|
|
"notifySchemaChanges" : true,
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
}</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="listAllConnectionsForWorkspace"/>
|
|
<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_all</code></pre></div>
|
|
<div class="method-summary">Returns all connections for a workspace, including deleted connections. (<span class="nickname">listAllConnectionsForWorkspace</span>)</div>
|
|
<div class="method-notes">List connections for workspace, including 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",
|
|
"sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"prefix" : "prefix",
|
|
"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"
|
|
},
|
|
"breakingChange" : true,
|
|
"notifySchemaChanges" : true,
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
}, {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"prefix" : "prefix",
|
|
"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"
|
|
},
|
|
"breakingChange" : true,
|
|
"notifySchemaChanges" : true,
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
} ]
|
|
}</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="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",
|
|
"sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"prefix" : "prefix",
|
|
"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"
|
|
},
|
|
"breakingChange" : true,
|
|
"notifySchemaChanges" : true,
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
}, {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"prefix" : "prefix",
|
|
"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"
|
|
},
|
|
"breakingChange" : true,
|
|
"notifySchemaChanges" : true,
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
} ]
|
|
}</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",
|
|
"startedAt" : 5,
|
|
"id" : 0,
|
|
"resetConfig" : {
|
|
"streamsToReset" : [ {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}, {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
} ]
|
|
},
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
}, {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"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="searchConnections"/>
|
|
<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/search</code></pre></div>
|
|
<div class="method-summary">Search connections (<span class="nickname">searchConnections</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">ConnectionSearch <a href="#ConnectionSearch">ConnectionSearch</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",
|
|
"sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"prefix" : "prefix",
|
|
"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"
|
|
},
|
|
"breakingChange" : true,
|
|
"notifySchemaChanges" : true,
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
}, {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"prefix" : "prefix",
|
|
"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"
|
|
},
|
|
"breakingChange" : true,
|
|
"notifySchemaChanges" : true,
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
} ]
|
|
}</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">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",
|
|
"startedAt" : 5,
|
|
"id" : 0,
|
|
"resetConfig" : {
|
|
"streamsToReset" : [ {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}, {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
} ]
|
|
},
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
}, {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"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">Apply a patch-style update to a connection. Only fields present on the update request body will be updated.
|
|
Note that if a catalog is present in the request body, the connection's entire catalog will be replaced
|
|
with the catalog from the request. This means that to modify a single stream, the entire new catalog
|
|
containing the updated stream needs to be sent.</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",
|
|
"sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"prefix" : "prefix",
|
|
"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"
|
|
},
|
|
"breakingChange" : true,
|
|
"notifySchemaChanges" : true,
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"operationIds" : [ null, null ],
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
}</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="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,
|
|
"connectorConfigurationUpdated" : false,
|
|
"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,
|
|
"connectorConfigurationUpdated" : false,
|
|
"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="cloneDestination"/>
|
|
<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/clone</code></pre></div>
|
|
<div class="method-summary">Clone destination (<span class="nickname">cloneDestination</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">DestinationCloneRequestBody <a href="#DestinationCloneRequestBody">DestinationCloneRequestBody</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",
|
|
"icon" : "icon",
|
|
"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="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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"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="searchDestinations"/>
|
|
<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/search</code></pre></div>
|
|
<div class="method-summary">Search destinations (<span class="nickname">searchDestinations</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">DestinationSearch <a href="#DestinationSearch">DestinationSearch</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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"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">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",
|
|
"icon" : "icon",
|
|
"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="createCustomDestinationDefinition"/>
|
|
<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_custom</code></pre></div>
|
|
<div class="method-summary">Creates a custom destinationDefinition for the given workspace (<span class="nickname">createCustomDestinationDefinition</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">CustomDestinationDefinitionCreate <a href="#CustomDestinationDefinitionCreate">CustomDestinationDefinitionCreate</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>{
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="deleteDestinationDefinition"/>
|
|
<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/delete</code></pre></div>
|
|
<div class="method-summary">Delete a destination definition (<span class="nickname">deleteDestinationDefinition</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 -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--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="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>{
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="getDestinationDefinitionForWorkspace"/>
|
|
<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_for_workspace</code></pre></div>
|
|
<div class="method-summary">Get a destinationDefinition that is configured for the given workspace (<span class="nickname">getDestinationDefinitionForWorkspace</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">DestinationDefinitionIdWithWorkspaceId <a href="#DestinationDefinitionIdWithWorkspaceId">DestinationDefinitionIdWithWorkspaceId</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>{
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="grantDestinationDefinitionToWorkspace"/>
|
|
<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/grant_definition</code></pre></div>
|
|
<div class="method-summary">grant a private, non-custom destinationDefinition to a given workspace (<span class="nickname">grantDestinationDefinitionToWorkspace</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">DestinationDefinitionIdWithWorkspaceId <a href="#DestinationDefinitionIdWithWorkspaceId">DestinationDefinitionIdWithWorkspaceId</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="#PrivateDestinationDefinitionRead">PrivateDestinationDefinitionRead</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>{
|
|
"destinationDefinition" : {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"granted" : 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="#PrivateDestinationDefinitionRead">PrivateDestinationDefinitionRead</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" : [ {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="listDestinationDefinitionsForWorkspace"/>
|
|
<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_for_workspace</code></pre></div>
|
|
<div class="method-summary">List all the destinationDefinitions the given workspace is configured to use (<span class="nickname">listDestinationDefinitionsForWorkspace</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> (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="#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" : [ {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"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" : [ {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="listPrivateDestinationDefinitions"/>
|
|
<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_private</code></pre></div>
|
|
<div class="method-summary">List all private, non-custom destinationDefinitions, and for each indicate whether the given workspace has a grant for using the definition. Used by admins to view and modify a given workspace's grants. (<span class="nickname">listPrivateDestinationDefinitions</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> (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="#PrivateDestinationDefinitionReadList">PrivateDestinationDefinitionReadList</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" : [ {
|
|
"destinationDefinition" : {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"granted" : true
|
|
}, {
|
|
"destinationDefinition" : {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"granted" : 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="#PrivateDestinationDefinitionReadList">PrivateDestinationDefinitionReadList</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="revokeDestinationDefinitionFromWorkspace"/>
|
|
<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/revoke_definition</code></pre></div>
|
|
<div class="method-summary">revoke a grant to a private, non-custom destinationDefinition from a given workspace (<span class="nickname">revokeDestinationDefinitionFromWorkspace</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">DestinationDefinitionIdWithWorkspaceId <a href="#DestinationDefinitionIdWithWorkspaceId">DestinationDefinitionIdWithWorkspaceId</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="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>{
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"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">DestinationDefinitionIdWithWorkspaceId <a href="#DestinationDefinitionIdWithWorkspaceId">DestinationDefinitionIdWithWorkspaceId</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",
|
|
"connectionSpecification" : {
|
|
"user" : {
|
|
"type" : "string"
|
|
}
|
|
},
|
|
"supportedDestinationSyncModes" : [ null, null ],
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"advancedAuth" : {
|
|
"predicateValue" : "predicateValue",
|
|
"oauthConfigSpecification" : { },
|
|
"predicateKey" : [ "predicateKey", "predicateKey" ],
|
|
"authFlowType" : "oauth2.0"
|
|
},
|
|
"authSpecification" : {
|
|
"auth_type" : "oauth2.0",
|
|
"oauth2Specification" : {
|
|
"oauthFlowOutputParameters" : [ [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ], [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ] ],
|
|
"rootObject" : [ "path", 1 ],
|
|
"oauthFlowInitParameters" : [ [ "oauthFlowInitParameters", "oauthFlowInitParameters" ], [ "oauthFlowInitParameters", "oauthFlowInitParameters" ] ]
|
|
}
|
|
},
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"connectorConfigurationUpdated" : false,
|
|
"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="DestinationOauth">DestinationOauth</a></h1>
|
|
<div class="method"><a name="completeDestinationOAuth"/>
|
|
<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_oauths/complete_oauth</code></pre></div>
|
|
<div class="method-summary">Given a destination def ID generate an access/refresh token etc. (<span class="nickname">completeDestinationOAuth</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">CompleteDestinationOAuthRequest <a href="#CompleteDestinationOAuthRequest">CompleteDestinationOAuthRequest</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">
|
|
|
|
map[String, oas_any_type_not_mapped]
|
|
</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/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
|
|
<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="getDestinationOAuthConsent"/>
|
|
<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_oauths/get_consent_url</code></pre></div>
|
|
<div class="method-summary">Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to. (<span class="nickname">getDestinationOAuthConsent</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">DestinationOauthConsentRequest <a href="#DestinationOauthConsentRequest">DestinationOauthConsentRequest</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="#OAuthConsentRead">OAuthConsentRead</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>{
|
|
"consentUrl" : "consentUrl"
|
|
}</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="#OAuthConsentRead">OAuthConsentRead</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="setInstancewideDestinationOauthParams"/>
|
|
<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_oauths/oauth_params/create</code></pre></div>
|
|
<div class="method-summary">Sets instancewide variables to be used for the oauth flow when creating this destination. When set, these variables will be injected into a connector's configuration before any interaction with the connector image itself. This enables running oauth flows with consistent variables e.g: the company's Google Ads developer_token, client_id, and client_secret without the user having to know about these variables. (<span class="nickname">setInstancewideDestinationOauthParams</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">SetInstancewideDestinationOauthParamsRequestBody <a href="#SetInstancewideDestinationOauthParamsRequestBody">SetInstancewideDestinationOauthParamsRequestBody</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">200</h4>
|
|
Successful
|
|
<a href="#"></a>
|
|
<h4 class="field-label">400</h4>
|
|
Exception occurred; see message for details.
|
|
<a href="#KnownExceptionInfo">KnownExceptionInfo</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</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>{
|
|
"available" : 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="Internal">Internal</a></h1>
|
|
<div class="method"><a name="createOrUpdateState"/>
|
|
<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/create_or_update</code></pre></div>
|
|
<div class="method-summary">Create or update the state for a connection. (<span class="nickname">createOrUpdateState</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">ConnectionStateCreateOrUpdate <a href="#ConnectionStateCreateOrUpdate">ConnectionStateCreateOrUpdate</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>{
|
|
"globalState" : {
|
|
"streamStates" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"streamState" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
} ]
|
|
}</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="getAttemptNormalizationStatusesForJob"/>
|
|
<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_normalization_status</code></pre></div>
|
|
<div class="method-summary">Get normalization status to determine if we can bypass normalization phase (<span class="nickname">getAttemptNormalizationStatusesForJob</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> (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="#AttemptNormalizationStatusReadList">AttemptNormalizationStatusReadList</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>{
|
|
"attemptNormalizationStatuses" : [ {
|
|
"attemptNumber" : 0,
|
|
"recordsCommitted" : 6,
|
|
"hasRecordsCommitted" : true,
|
|
"hasNormalizationFailed" : true
|
|
}, {
|
|
"attemptNumber" : 0,
|
|
"recordsCommitted" : 6,
|
|
"hasRecordsCommitted" : true,
|
|
"hasNormalizationFailed" : 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="#AttemptNormalizationStatusReadList">AttemptNormalizationStatusReadList</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="saveStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/attempt/save_stats</code></pre></div>
|
|
<div class="method-summary">For worker to set sync stats of a running attempt. (<span class="nickname">saveStats</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">SaveStatsRequestBody <a href="#SaveStatsRequestBody">SaveStatsRequestBody</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="#InternalOperationResult">InternalOperationResult</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>{
|
|
"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="#InternalOperationResult">InternalOperationResult</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="saveSyncConfig"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/attempt/save_sync_config</code></pre></div>
|
|
<div class="method-summary">For worker to save the AttemptSyncConfig for an attempt. (<span class="nickname">saveSyncConfig</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">SaveAttemptSyncConfigRequestBody <a href="#SaveAttemptSyncConfigRequestBody">SaveAttemptSyncConfigRequestBody</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="#InternalOperationResult">InternalOperationResult</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>{
|
|
"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="#InternalOperationResult">InternalOperationResult</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setWorkflowInAttempt"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/attempt/set_workflow_in_attempt</code></pre></div>
|
|
<div class="method-summary">For worker to register the workflow id in attempt. (<span class="nickname">setWorkflowInAttempt</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">SetWorkflowInAttemptRequestBody <a href="#SetWorkflowInAttemptRequestBody">SetWorkflowInAttemptRequestBody</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="#InternalOperationResult">InternalOperationResult</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>{
|
|
"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="#InternalOperationResult">InternalOperationResult</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="writeDiscoverCatalogResult"/>
|
|
<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/write_discover_catalog_result</code></pre></div>
|
|
<div class="method-summary">Should only called from worker, to write result from discover activity back to DB. (<span class="nickname">writeDiscoverCatalogResult</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">SourceDiscoverSchemaWriteRequestBody <a href="#SourceDiscoverSchemaWriteRequestBody">SourceDiscoverSchemaWriteRequestBody</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="#DiscoverCatalogResult">DiscoverCatalogResult</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>{
|
|
"catalogId" : "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="#DiscoverCatalogResult">DiscoverCatalogResult</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",
|
|
"startedAt" : 5,
|
|
"id" : 0,
|
|
"resetConfig" : {
|
|
"streamsToReset" : [ {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}, {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
} ]
|
|
},
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
}, {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"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="getAttemptNormalizationStatusesForJob"/>
|
|
<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_normalization_status</code></pre></div>
|
|
<div class="method-summary">Get normalization status to determine if we can bypass normalization phase (<span class="nickname">getAttemptNormalizationStatusesForJob</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> (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="#AttemptNormalizationStatusReadList">AttemptNormalizationStatusReadList</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>{
|
|
"attemptNormalizationStatuses" : [ {
|
|
"attemptNumber" : 0,
|
|
"recordsCommitted" : 6,
|
|
"hasRecordsCommitted" : true,
|
|
"hasNormalizationFailed" : true
|
|
}, {
|
|
"attemptNumber" : 0,
|
|
"recordsCommitted" : 6,
|
|
"hasRecordsCommitted" : true,
|
|
"hasNormalizationFailed" : 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="#AttemptNormalizationStatusReadList">AttemptNormalizationStatusReadList</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getJobDebugInfo"/>
|
|
<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_debug_info</code></pre></div>
|
|
<div class="method-summary">Gets all information needed to debug this job (<span class="nickname">getJobDebugInfo</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="#JobDebugInfoRead">JobDebugInfoRead</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>{
|
|
"workflowState" : {
|
|
"running" : true
|
|
},
|
|
"job" : {
|
|
"configId" : "configId",
|
|
"sourceDefinition" : {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"airbyteVersion" : "airbyteVersion",
|
|
"id" : 0,
|
|
"destinationDefinition" : {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"dockerRepository" : "dockerRepository",
|
|
"supportsDbt" : true,
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"normalizationConfig" : {
|
|
"normalizationIntegrationType" : "normalizationIntegrationType",
|
|
"normalizationRepository" : "normalizationRepository",
|
|
"normalizationTag" : "normalizationTag",
|
|
"supported" : false
|
|
},
|
|
"protocolVersion" : "protocolVersion",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}
|
|
},
|
|
"attempts" : [ {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
}, {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"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="#JobDebugInfoRead">JobDebugInfoRead</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",
|
|
"startedAt" : 5,
|
|
"id" : 0,
|
|
"resetConfig" : {
|
|
"streamsToReset" : [ {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}, {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
} ]
|
|
},
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
}
|
|
}, {
|
|
"attempt" : {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
},
|
|
"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="getJobInfoLight"/>
|
|
<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_light</code></pre></div>
|
|
<div class="method-summary">Get information about a job excluding attempt info and logs (<span class="nickname">getJobInfoLight</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="#JobInfoLightRead">JobInfoLightRead</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",
|
|
"startedAt" : 5,
|
|
"id" : 0,
|
|
"resetConfig" : {
|
|
"streamsToReset" : [ {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}, {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
} ]
|
|
},
|
|
"updatedAt" : 1
|
|
}
|
|
}</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="#JobInfoLightRead">JobInfoLightRead</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="getLastReplicationJob"/>
|
|
<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_last_replication_job</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">getLastReplicationJob</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="#JobOptionalRead">JobOptionalRead</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",
|
|
"startedAt" : 5,
|
|
"id" : 0,
|
|
"resetConfig" : {
|
|
"streamsToReset" : [ {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}, {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
} ]
|
|
},
|
|
"updatedAt" : 1
|
|
}
|
|
}</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="#JobOptionalRead">JobOptionalRead</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>{
|
|
"totalJobCount" : 0,
|
|
"jobs" : [ {
|
|
"job" : {
|
|
"createdAt" : 6,
|
|
"configId" : "configId",
|
|
"startedAt" : 5,
|
|
"id" : 0,
|
|
"resetConfig" : {
|
|
"streamsToReset" : [ {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}, {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
} ]
|
|
},
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
}, {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
} ]
|
|
}, {
|
|
"job" : {
|
|
"createdAt" : 6,
|
|
"configId" : "configId",
|
|
"startedAt" : 5,
|
|
"id" : 0,
|
|
"resetConfig" : {
|
|
"streamsToReset" : [ {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}, {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
} ]
|
|
},
|
|
"updatedAt" : 1
|
|
},
|
|
"attempts" : [ {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
}, {
|
|
"totalStats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"failureSummary" : {
|
|
"failures" : [ {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
}, {
|
|
"retryable" : true,
|
|
"stacktrace" : "stacktrace",
|
|
"internalMessage" : "internalMessage",
|
|
"externalMessage" : "externalMessage",
|
|
"timestamp" : 7
|
|
} ],
|
|
"partialSuccess" : true
|
|
},
|
|
"createdAt" : 2,
|
|
"bytesSynced" : 3,
|
|
"endedAt" : 9,
|
|
"streamStats" : [ {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
}, {
|
|
"stats" : {
|
|
"stateMessagesEmitted" : 1,
|
|
"recordsCommitted" : 1,
|
|
"bytesEmitted" : 7,
|
|
"estimatedBytes" : 6,
|
|
"estimatedRecords" : 1,
|
|
"recordsEmitted" : 4
|
|
},
|
|
"streamNamespace" : "streamNamespace",
|
|
"streamName" : "streamName"
|
|
} ],
|
|
"id" : 5,
|
|
"recordsSynced" : 2,
|
|
"updatedAt" : 7
|
|
} ]
|
|
} ]
|
|
}</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" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"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" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"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" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"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" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"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" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"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,
|
|
"connectorConfigurationUpdated" : false,
|
|
"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,
|
|
"connectorConfigurationUpdated" : false,
|
|
"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>{
|
|
"catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"breakingChange" : true,
|
|
"catalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"connectorConfigurationUpdated" : false,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
},
|
|
"catalogDiff" : {
|
|
"transforms" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
} ]
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : 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,
|
|
"connectorConfigurationUpdated" : false,
|
|
"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,
|
|
"connectorConfigurationUpdated" : false,
|
|
"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="cloneSource"/>
|
|
<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/clone</code></pre></div>
|
|
<div class="method-summary">Clone source (<span class="nickname">cloneSource</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">SourceCloneRequestBody <a href="#SourceCloneRequestBody">SourceCloneRequestBody</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",
|
|
"icon" : "icon",
|
|
"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="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",
|
|
"icon" : "icon",
|
|
"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">SourceDiscoverSchemaRequestBody <a href="#SourceDiscoverSchemaRequestBody">SourceDiscoverSchemaRequestBody</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>{
|
|
"catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"breakingChange" : true,
|
|
"catalog" : {
|
|
"streams" : [ {
|
|
"stream" : {
|
|
"sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
|
|
"supportedSyncModes" : [ null, null ],
|
|
"sourceDefinedCursor" : true,
|
|
"name" : "name",
|
|
"namespace" : "namespace",
|
|
"defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
|
|
},
|
|
"config" : {
|
|
"aliasName" : "aliasName",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"connectorConfigurationUpdated" : false,
|
|
"configId" : "configId",
|
|
"endedAt" : 6,
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"logs" : {
|
|
"logLines" : [ "logLines", "logLines" ]
|
|
},
|
|
"succeeded" : true
|
|
},
|
|
"catalogDiff" : {
|
|
"transforms" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
} ]
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : 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="getMostRecentSourceActorCatalog"/>
|
|
<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/most_recent_source_actor_catalog</code></pre></div>
|
|
<div class="method-summary">Get most recent ActorCatalog for source (<span class="nickname">getMostRecentSourceActorCatalog</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="#ActorCatalogWithUpdatedAt">ActorCatalogWithUpdatedAt</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" : "{}",
|
|
"updatedAt" : 0
|
|
}</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="#ActorCatalogWithUpdatedAt">ActorCatalogWithUpdatedAt</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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"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="searchSources"/>
|
|
<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/search</code></pre></div>
|
|
<div class="method-summary">Search sources (<span class="nickname">searchSources</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">SourceSearch <a href="#SourceSearch">SourceSearch</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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"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">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",
|
|
"icon" : "icon",
|
|
"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="writeDiscoverCatalogResult"/>
|
|
<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/write_discover_catalog_result</code></pre></div>
|
|
<div class="method-summary">Should only called from worker, to write result from discover activity back to DB. (<span class="nickname">writeDiscoverCatalogResult</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">SourceDiscoverSchemaWriteRequestBody <a href="#SourceDiscoverSchemaWriteRequestBody">SourceDiscoverSchemaWriteRequestBody</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="#DiscoverCatalogResult">DiscoverCatalogResult</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>{
|
|
"catalogId" : "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="#DiscoverCatalogResult">DiscoverCatalogResult</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="SourceDefinition">SourceDefinition</a></h1>
|
|
<div class="method"><a name="createCustomSourceDefinition"/>
|
|
<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_custom</code></pre></div>
|
|
<div class="method-summary">Creates a custom sourceDefinition for the given workspace (<span class="nickname">createCustomSourceDefinition</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">CustomSourceDefinitionCreate <a href="#CustomSourceDefinitionCreate">CustomSourceDefinitionCreate</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>{
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="deleteSourceDefinition"/>
|
|
<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/delete</code></pre></div>
|
|
<div class="method-summary">Delete a source definition (<span class="nickname">deleteSourceDefinition</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 -->
|
|
|
|
|
|
|
|
|
|
|
|
<!--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="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>{
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="getSourceDefinitionForWorkspace"/>
|
|
<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_for_workspace</code></pre></div>
|
|
<div class="method-summary">Get a sourceDefinition that is configured for the given workspace (<span class="nickname">getSourceDefinitionForWorkspace</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">SourceDefinitionIdWithWorkspaceId <a href="#SourceDefinitionIdWithWorkspaceId">SourceDefinitionIdWithWorkspaceId</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>{
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="grantSourceDefinitionToWorkspace"/>
|
|
<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/grant_definition</code></pre></div>
|
|
<div class="method-summary">grant a private, non-custom sourceDefinition to a given workspace (<span class="nickname">grantSourceDefinitionToWorkspace</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">SourceDefinitionIdWithWorkspaceId <a href="#SourceDefinitionIdWithWorkspaceId">SourceDefinitionIdWithWorkspaceId</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="#PrivateSourceDefinitionRead">PrivateSourceDefinitionRead</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>{
|
|
"sourceDefinition" : {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"granted" : 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="#PrivateSourceDefinitionRead">PrivateSourceDefinitionRead</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" : [ {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="listPrivateSourceDefinitions"/>
|
|
<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_private</code></pre></div>
|
|
<div class="method-summary">List all private, non-custom sourceDefinitions, and for each indicate whether the given workspace has a grant for using the definition. Used by admins to view and modify a given workspace's grants. (<span class="nickname">listPrivateSourceDefinitions</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> (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="#PrivateSourceDefinitionReadList">PrivateSourceDefinitionReadList</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" : [ {
|
|
"sourceDefinition" : {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"granted" : true
|
|
}, {
|
|
"sourceDefinition" : {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"granted" : 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="#PrivateSourceDefinitionReadList">PrivateSourceDefinitionReadList</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" : [ {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="listSourceDefinitionsForWorkspace"/>
|
|
<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_for_workspace</code></pre></div>
|
|
<div class="method-summary">List all the sourceDefinitions the given workspace is configured to use (<span class="nickname">listSourceDefinitionsForWorkspace</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> (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="#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" : [ {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"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="revokeSourceDefinitionFromWorkspace"/>
|
|
<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/revoke_definition</code></pre></div>
|
|
<div class="method-summary">revoke a grant to a private, non-custom sourceDefinition from a given workspace (<span class="nickname">revokeSourceDefinitionFromWorkspace</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">SourceDefinitionIdWithWorkspaceId <a href="#SourceDefinitionIdWithWorkspaceId">SourceDefinitionIdWithWorkspaceId</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="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>{
|
|
"resourceRequirements" : {
|
|
"default" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"jobSpecific" : [ {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
}, {
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
}
|
|
} ]
|
|
},
|
|
"documentationUrl" : "https://openapi-generator.tech",
|
|
"dockerImageTag" : "dockerImageTag",
|
|
"releaseDate" : "2000-01-23",
|
|
"sourceType" : "api",
|
|
"dockerRepository" : "dockerRepository",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"protocolVersion" : "protocolVersion",
|
|
"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">SourceDefinitionIdWithWorkspaceId <a href="#SourceDefinitionIdWithWorkspaceId">SourceDefinitionIdWithWorkspaceId</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",
|
|
"advancedAuth" : {
|
|
"predicateValue" : "predicateValue",
|
|
"oauthConfigSpecification" : { },
|
|
"predicateKey" : [ "predicateKey", "predicateKey" ],
|
|
"authFlowType" : "oauth2.0"
|
|
},
|
|
"authSpecification" : {
|
|
"auth_type" : "oauth2.0",
|
|
"oauth2Specification" : {
|
|
"oauthFlowOutputParameters" : [ [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ], [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ] ],
|
|
"rootObject" : [ "path", 1 ],
|
|
"oauthFlowInitParameters" : [ [ "oauthFlowInitParameters", "oauthFlowInitParameters" ], [ "oauthFlowInitParameters", "oauthFlowInitParameters" ] ]
|
|
}
|
|
},
|
|
"jobInfo" : {
|
|
"createdAt" : 0,
|
|
"connectorConfigurationUpdated" : false,
|
|
"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="SourceOauth">SourceOauth</a></h1>
|
|
<div class="method"><a name="completeSourceOAuth"/>
|
|
<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_oauths/complete_oauth</code></pre></div>
|
|
<div class="method-summary">Given a source def ID generate an access/refresh token etc. (<span class="nickname">completeSourceOAuth</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">CompleteSourceOauthRequest <a href="#CompleteSourceOauthRequest">CompleteSourceOauthRequest</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">
|
|
|
|
map[String, oas_any_type_not_mapped]
|
|
</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/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful operation
|
|
|
|
<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="getSourceOAuthConsent"/>
|
|
<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_oauths/get_consent_url</code></pre></div>
|
|
<div class="method-summary">Given a source connector definition ID, return the URL to the consent screen where to redirect the user to. (<span class="nickname">getSourceOAuthConsent</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">SourceOauthConsentRequest <a href="#SourceOauthConsentRequest">SourceOauthConsentRequest</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="#OAuthConsentRead">OAuthConsentRead</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>{
|
|
"consentUrl" : "consentUrl"
|
|
}</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="#OAuthConsentRead">OAuthConsentRead</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="setInstancewideSourceOauthParams"/>
|
|
<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_oauths/oauth_params/create</code></pre></div>
|
|
<div class="method-summary">Sets instancewide variables to be used for the oauth flow when creating this source. When set, these variables will be injected into a connector's configuration before any interaction with the connector image itself. This enables running oauth flows with consistent variables e.g: the company's Google Ads developer_token, client_id, and client_secret without the user having to know about these variables. (<span class="nickname">setInstancewideSourceOauthParams</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">SetInstancewideSourceOauthParamsRequestBody <a href="#SetInstancewideSourceOauthParamsRequestBody">SetInstancewideSourceOauthParamsRequestBody</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">200</h4>
|
|
Successful
|
|
<a href="#"></a>
|
|
<h4 class="field-label">400</h4>
|
|
Exception occurred; see message for details.
|
|
<a href="#KnownExceptionInfo">KnownExceptionInfo</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="State">State</a></h1>
|
|
<div class="method"><a name="createOrUpdateState"/>
|
|
<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/create_or_update</code></pre></div>
|
|
<div class="method-summary">Create or update the state for a connection. (<span class="nickname">createOrUpdateState</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">ConnectionStateCreateOrUpdate <a href="#ConnectionStateCreateOrUpdate">ConnectionStateCreateOrUpdate</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>{
|
|
"globalState" : {
|
|
"streamStates" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"streamState" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
} ]
|
|
}</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="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>{
|
|
"globalState" : {
|
|
"streamStates" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"streamState" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
}
|
|
} ]
|
|
}</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/>
|
|
<h1><a name="WebBackend">WebBackend</a></h1>
|
|
<div class="method"><a name="getStateType"/>
|
|
<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/state/get_type</code></pre></div>
|
|
<div class="method-summary">Fetch the current state type for a connection. (<span class="nickname">getStateType</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="#ConnectionStateType">ConnectionStateType</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>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="#ConnectionStateType">ConnectionStateType</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="webBackendCheckUpdates"/>
|
|
<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/check_updates</code></pre></div>
|
|
<div class="method-summary">Returns a summary of source and destination definitions that could be updated. (<span class="nickname">webBackendCheckUpdates</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WebBackendCheckUpdatesRead">WebBackendCheckUpdatesRead</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" : 0,
|
|
"sourceDefinitions" : 6
|
|
}</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="#WebBackendCheckUpdatesRead">WebBackendCheckUpdatesRead</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"catalogDiff" : {
|
|
"transforms" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
} ]
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
} ]
|
|
} ]
|
|
},
|
|
"operations" : [ {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"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" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"notifySchemaChanges" : true,
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
},
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"catalogDiff" : {
|
|
"transforms" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
} ]
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
} ]
|
|
} ]
|
|
},
|
|
"operations" : [ {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"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" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"notifySchemaChanges" : true,
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
},
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"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="webBackendGetWorkspaceState"/>
|
|
<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/workspace/state</code></pre></div>
|
|
<div class="method-summary">Returns the current state of a workspace (<span class="nickname">webBackendGetWorkspaceState</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">WebBackendWorkspaceState <a href="#WebBackendWorkspaceState">WebBackendWorkspaceState</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="#WebBackendWorkspaceStateResult">WebBackendWorkspaceStateResult</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>{
|
|
"hasDestinations" : true,
|
|
"hasConnections" : true,
|
|
"hasSources" : 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="#WebBackendWorkspaceStateResult">WebBackendWorkspaceStateResult</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 non-deleted 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">WebBackendConnectionListRequestBody <a href="#WebBackendConnectionListRequestBody">WebBackendConnectionListRequestBody</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" : [ {
|
|
"latestSyncJobCreatedAt" : 0,
|
|
"name" : "name",
|
|
"destination" : {
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"isSyncing" : true,
|
|
"source" : {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName"
|
|
},
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
}, {
|
|
"latestSyncJobCreatedAt" : 0,
|
|
"name" : "name",
|
|
"destination" : {
|
|
"destinationName" : "destinationName",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"isSyncing" : true,
|
|
"source" : {
|
|
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName"
|
|
},
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
}
|
|
} ]
|
|
}</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="webBackendListGeographies"/>
|
|
<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/geographies/list</code></pre></div>
|
|
<div class="method-summary">Returns available geographies can be selected to run data syncs in a particular geography.
|
|
The 'auto' entry indicates that the sync will be automatically assigned to a geography according
|
|
to the platform default behavior. Entries other than 'auto' are two-letter country codes that
|
|
follow the ISO 3166-1 alpha-2 standard. (<span class="nickname">webBackendListGeographies</span>)</div>
|
|
<div class="method-notes">Returns all available geographies in which a data sync can run.</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#WebBackendGeographiesListResult">WebBackendGeographiesListResult</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>{
|
|
"geographies" : [ 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="#WebBackendGeographiesListResult">WebBackendGeographiesListResult</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">Apply a patch-style update to a connection. Only fields present on the update request body will be updated.
|
|
Any operations that lack an ID will be created. Then, the newly created operationId will be applied to the
|
|
connection along with the rest of the operationIds in the request body.
|
|
Apply a patch-style update to a connection. Only fields present on the update request body will be updated.
|
|
Note that if a catalog is present in the request body, the connection's entire catalog will be replaced
|
|
with the catalog from the request. This means that to modify a single stream, the entire new catalog
|
|
containing the updated stream needs to be sent.</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",
|
|
"icon" : "icon",
|
|
"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",
|
|
"icon" : "icon",
|
|
"sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"sourceName" : "sourceName",
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
},
|
|
"destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"catalogDiff" : {
|
|
"transforms" : [ {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
} ]
|
|
}, {
|
|
"streamDescriptor" : {
|
|
"name" : "name",
|
|
"namespace" : "namespace"
|
|
},
|
|
"transformType" : "add_stream",
|
|
"updateStream" : [ {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
}, {
|
|
"updateFieldSchema" : { },
|
|
"fieldName" : [ "fieldName", "fieldName" ],
|
|
"addField" : { },
|
|
"transformType" : "add_field",
|
|
"removeField" : { },
|
|
"breaking" : true
|
|
} ]
|
|
} ]
|
|
},
|
|
"operations" : [ {
|
|
"name" : "name",
|
|
"operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"operatorConfiguration" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"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" : {
|
|
"webhook" : {
|
|
"webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"dbtCloud" : {
|
|
"accountId" : 0,
|
|
"jobId" : 6
|
|
},
|
|
"executionUrl" : "executionUrl",
|
|
"executionBody" : "executionBody",
|
|
"webhookType" : "dbtCloud"
|
|
},
|
|
"normalization" : {
|
|
"option" : "basic"
|
|
},
|
|
"dbt" : {
|
|
"gitRepoBranch" : "gitRepoBranch",
|
|
"dockerImage" : "dockerImage",
|
|
"dbtArguments" : "dbtArguments",
|
|
"gitRepoUrl" : "gitRepoUrl"
|
|
}
|
|
},
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"notifySchemaChanges" : true,
|
|
"namespaceFormat" : "${SOURCE_NAMESPACE}",
|
|
"scheduleData" : {
|
|
"cron" : {
|
|
"cronExpression" : "cronExpression",
|
|
"cronTimeZone" : "cronTimeZone"
|
|
},
|
|
"basicSchedule" : {
|
|
"units" : 6,
|
|
"timeUnit" : "minutes"
|
|
}
|
|
},
|
|
"resourceRequirements" : {
|
|
"cpu_limit" : "cpu_limit",
|
|
"memory_request" : "memory_request",
|
|
"memory_limit" : "memory_limit",
|
|
"cpu_request" : "cpu_request"
|
|
},
|
|
"schedule" : {
|
|
"units" : 0,
|
|
"timeUnit" : "minutes"
|
|
},
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"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",
|
|
"suggested" : true,
|
|
"fieldSelectionEnabled" : true,
|
|
"selectedFields" : [ {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
}, {
|
|
"fieldPath" : [ "fieldPath", "fieldPath" ]
|
|
} ],
|
|
"cursorField" : [ "cursorField", "cursorField" ],
|
|
"selected" : true,
|
|
"primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
|
|
}
|
|
} ]
|
|
},
|
|
"connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"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>{
|
|
"news" : true,
|
|
"webhookConfigs" : [ {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"displaySetupWizard" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"firstCompletedSync" : true,
|
|
"feedbackDone" : true,
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
} ],
|
|
"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>{
|
|
"news" : true,
|
|
"webhookConfigs" : [ {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"displaySetupWizard" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"firstCompletedSync" : true,
|
|
"feedbackDone" : true,
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
} ],
|
|
"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="getWorkspaceByConnectionId"/>
|
|
<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_connection_id</code></pre></div>
|
|
<div class="method-summary">Find workspace by connection id (<span class="nickname">getWorkspaceByConnectionId</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="#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>{
|
|
"news" : true,
|
|
"webhookConfigs" : [ {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"displaySetupWizard" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"firstCompletedSync" : true,
|
|
"feedbackDone" : true,
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
} ],
|
|
"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>{
|
|
"news" : true,
|
|
"webhookConfigs" : [ {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"displaySetupWizard" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"firstCompletedSync" : true,
|
|
"feedbackDone" : true,
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
} ],
|
|
"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" : [ {
|
|
"news" : true,
|
|
"webhookConfigs" : [ {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"displaySetupWizard" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"firstCompletedSync" : true,
|
|
"feedbackDone" : true,
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
} ],
|
|
"workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"news" : true,
|
|
"webhookConfigs" : [ {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"displaySetupWizard" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"firstCompletedSync" : true,
|
|
"feedbackDone" : true,
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
} ],
|
|
"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>{
|
|
"news" : true,
|
|
"webhookConfigs" : [ {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"displaySetupWizard" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"firstCompletedSync" : true,
|
|
"feedbackDone" : true,
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
} ],
|
|
"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="updateWorkspaceFeedback"/>
|
|
<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/tag_feedback_status_as_done</code></pre></div>
|
|
<div class="method-summary">Update workspace feedback state (<span class="nickname">updateWorkspaceFeedback</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">WorkspaceGiveFeedback <a href="#WorkspaceGiveFeedback">WorkspaceGiveFeedback</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 feedback state has been properly updated
|
|
<a href="#"></a>
|
|
<h4 class="field-label">404</h4>
|
|
Object with given id was not found.
|
|
<a href="#NotFoundKnownExceptionInfo">NotFoundKnownExceptionInfo</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateWorkspaceName"/>
|
|
<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_name</code></pre></div>
|
|
<div class="method-summary">Update workspace name (<span class="nickname">updateWorkspaceName</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">WorkspaceUpdateName <a href="#WorkspaceUpdateName">WorkspaceUpdateName</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>{
|
|
"news" : true,
|
|
"webhookConfigs" : [ {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
}, {
|
|
"name" : "name",
|
|
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
|
|
} ],
|
|
"displaySetupWizard" : true,
|
|
"initialSetupComplete" : true,
|
|
"anonymousDataCollection" : true,
|
|
"customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"name" : "name",
|
|
"firstCompletedSync" : true,
|
|
"feedbackDone" : true,
|
|
"email" : "email",
|
|
"slug" : "slug",
|
|
"securityUpdates" : true,
|
|
"notifications" : [ {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
}, {
|
|
"slackConfiguration" : {
|
|
"webhook" : "webhook"
|
|
},
|
|
"sendOnSuccess" : false,
|
|
"sendOnFailure" : true,
|
|
"customerioConfiguration" : "{}"
|
|
} ],
|
|
"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="#ActorCatalogWithUpdatedAt"><code>ActorCatalogWithUpdatedAt</code> - </a></li>
|
|
<li><a href="#ActorDefinitionResourceRequirements"><code>ActorDefinitionResourceRequirements</code> - </a></li>
|
|
<li><a href="#AdvancedAuth"><code>AdvancedAuth</code> - </a></li>
|
|
<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="#AttemptFailureOrigin"><code>AttemptFailureOrigin</code> - </a></li>
|
|
<li><a href="#AttemptFailureReason"><code>AttemptFailureReason</code> - </a></li>
|
|
<li><a href="#AttemptFailureSummary"><code>AttemptFailureSummary</code> - </a></li>
|
|
<li><a href="#AttemptFailureType"><code>AttemptFailureType</code> - </a></li>
|
|
<li><a href="#AttemptInfoRead"><code>AttemptInfoRead</code> - </a></li>
|
|
<li><a href="#AttemptNormalizationStatusRead"><code>AttemptNormalizationStatusRead</code> - </a></li>
|
|
<li><a href="#AttemptNormalizationStatusReadList"><code>AttemptNormalizationStatusReadList</code> - </a></li>
|
|
<li><a href="#AttemptRead"><code>AttemptRead</code> - </a></li>
|
|
<li><a href="#AttemptStats"><code>AttemptStats</code> - </a></li>
|
|
<li><a href="#AttemptStatus"><code>AttemptStatus</code> - </a></li>
|
|
<li><a href="#AttemptStreamStats"><code>AttemptStreamStats</code> - </a></li>
|
|
<li><a href="#AttemptSyncConfig"><code>AttemptSyncConfig</code> - </a></li>
|
|
<li><a href="#AuthSpecification"><code>AuthSpecification</code> - </a></li>
|
|
<li><a href="#CatalogDiff"><code>CatalogDiff</code> - </a></li>
|
|
<li><a href="#CheckConnectionRead"><code>CheckConnectionRead</code> - </a></li>
|
|
<li><a href="#CheckOperationRead"><code>CheckOperationRead</code> - </a></li>
|
|
<li><a href="#CompleteDestinationOAuthRequest"><code>CompleteDestinationOAuthRequest</code> - </a></li>
|
|
<li><a href="#CompleteSourceOauthRequest"><code>CompleteSourceOauthRequest</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="#ConnectionScheduleData"><code>ConnectionScheduleData</code> - </a></li>
|
|
<li><a href="#ConnectionScheduleData_basicSchedule"><code>ConnectionScheduleData_basicSchedule</code> - </a></li>
|
|
<li><a href="#ConnectionScheduleData_cron"><code>ConnectionScheduleData_cron</code> - </a></li>
|
|
<li><a href="#ConnectionScheduleType"><code>ConnectionScheduleType</code> - </a></li>
|
|
<li><a href="#ConnectionSearch"><code>ConnectionSearch</code> - </a></li>
|
|
<li><a href="#ConnectionState"><code>ConnectionState</code> - </a></li>
|
|
<li><a href="#ConnectionStateCreateOrUpdate"><code>ConnectionStateCreateOrUpdate</code> - </a></li>
|
|
<li><a href="#ConnectionStateType"><code>ConnectionStateType</code> - </a></li>
|
|
<li><a href="#ConnectionStatus"><code>ConnectionStatus</code> - </a></li>
|
|
<li><a href="#ConnectionUpdate"><code>ConnectionUpdate</code> - </a></li>
|
|
<li><a href="#CustomDestinationDefinitionCreate"><code>CustomDestinationDefinitionCreate</code> - </a></li>
|
|
<li><a href="#CustomSourceDefinitionCreate"><code>CustomSourceDefinitionCreate</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="#DestinationCloneConfiguration"><code>DestinationCloneConfiguration</code> - </a></li>
|
|
<li><a href="#DestinationCloneRequestBody"><code>DestinationCloneRequestBody</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="#DestinationDefinitionIdWithWorkspaceId"><code>DestinationDefinitionIdWithWorkspaceId</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="#DestinationOauthConsentRequest"><code>DestinationOauthConsentRequest</code> - </a></li>
|
|
<li><a href="#DestinationRead"><code>DestinationRead</code> - </a></li>
|
|
<li><a href="#DestinationReadList"><code>DestinationReadList</code> - </a></li>
|
|
<li><a href="#DestinationSearch"><code>DestinationSearch</code> - </a></li>
|
|
<li><a href="#DestinationSnippetRead"><code>DestinationSnippetRead</code> - </a></li>
|
|
<li><a href="#DestinationSyncMode"><code>DestinationSyncMode</code> - </a></li>
|
|
<li><a href="#DestinationUpdate"><code>DestinationUpdate</code> - </a></li>
|
|
<li><a href="#DiscoverCatalogResult"><code>DiscoverCatalogResult</code> - </a></li>
|
|
<li><a href="#FieldAdd"><code>FieldAdd</code> - </a></li>
|
|
<li><a href="#FieldRemove"><code>FieldRemove</code> - </a></li>
|
|
<li><a href="#FieldSchemaUpdate"><code>FieldSchemaUpdate</code> - </a></li>
|
|
<li><a href="#FieldTransform"><code>FieldTransform</code> - </a></li>
|
|
<li><a href="#Geography"><code>Geography</code> - </a></li>
|
|
<li><a href="#GlobalState"><code>GlobalState</code> - </a></li>
|
|
<li><a href="#HealthCheckRead"><code>HealthCheckRead</code> - </a></li>
|
|
<li><a href="#ImportRead"><code>ImportRead</code> - </a></li>
|
|
<li><a href="#ImportRequestBody"><code>ImportRequestBody</code> - </a></li>
|
|
<li><a href="#InternalOperationResult"><code>InternalOperationResult</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="#JobDebugInfoRead"><code>JobDebugInfoRead</code> - </a></li>
|
|
<li><a href="#JobDebugRead"><code>JobDebugRead</code> - </a></li>
|
|
<li><a href="#JobIdRequestBody"><code>JobIdRequestBody</code> - </a></li>
|
|
<li><a href="#JobInfoLightRead"><code>JobInfoLightRead</code> - </a></li>
|
|
<li><a href="#JobInfoRead"><code>JobInfoRead</code> - </a></li>
|
|
<li><a href="#JobListRequestBody"><code>JobListRequestBody</code> - </a></li>
|
|
<li><a href="#JobOptionalRead"><code>JobOptionalRead</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="#JobType"><code>JobType</code> - </a></li>
|
|
<li><a href="#JobTypeResourceLimit"><code>JobTypeResourceLimit</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="#NonBreakingChangesPreference"><code>NonBreakingChangesPreference</code> - </a></li>
|
|
<li><a href="#NormalizationDestinationDefinitionConfig"><code>NormalizationDestinationDefinitionConfig</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="#OAuth2Specification"><code>OAuth2Specification</code> - </a></li>
|
|
<li><a href="#OAuthConfigSpecification"><code>OAuthConfigSpecification</code> - </a></li>
|
|
<li><a href="#OAuthConsentRead"><code>OAuthConsentRead</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="#OperatorWebhook"><code>OperatorWebhook</code> - </a></li>
|
|
<li><a href="#OperatorWebhook_dbtCloud"><code>OperatorWebhook_dbtCloud</code> - </a></li>
|
|
<li><a href="#Pagination"><code>Pagination</code> - </a></li>
|
|
<li><a href="#PrivateDestinationDefinitionRead"><code>PrivateDestinationDefinitionRead</code> - </a></li>
|
|
<li><a href="#PrivateDestinationDefinitionReadList"><code>PrivateDestinationDefinitionReadList</code> - </a></li>
|
|
<li><a href="#PrivateSourceDefinitionRead"><code>PrivateSourceDefinitionRead</code> - </a></li>
|
|
<li><a href="#PrivateSourceDefinitionReadList"><code>PrivateSourceDefinitionReadList</code> - </a></li>
|
|
<li><a href="#ReleaseStage"><code>ReleaseStage</code> - </a></li>
|
|
<li><a href="#ResetConfig"><code>ResetConfig</code> - </a></li>
|
|
<li><a href="#ResourceRequirements"><code>ResourceRequirements</code> - </a></li>
|
|
<li><a href="#SaveAttemptSyncConfigRequestBody"><code>SaveAttemptSyncConfigRequestBody</code> - </a></li>
|
|
<li><a href="#SaveStatsRequestBody"><code>SaveStatsRequestBody</code> - </a></li>
|
|
<li><a href="#SchemaChange"><code>SchemaChange</code> - </a></li>
|
|
<li><a href="#SelectedFieldInfo"><code>SelectedFieldInfo</code> - </a></li>
|
|
<li><a href="#SetInstancewideDestinationOauthParamsRequestBody"><code>SetInstancewideDestinationOauthParamsRequestBody</code> - </a></li>
|
|
<li><a href="#SetInstancewideSourceOauthParamsRequestBody"><code>SetInstancewideSourceOauthParamsRequestBody</code> - </a></li>
|
|
<li><a href="#SetWorkflowInAttemptRequestBody"><code>SetWorkflowInAttemptRequestBody</code> - </a></li>
|
|
<li><a href="#SlackNotificationConfiguration"><code>SlackNotificationConfiguration</code> - </a></li>
|
|
<li><a href="#SlugRequestBody"><code>SlugRequestBody</code> - </a></li>
|
|
<li><a href="#SourceCloneConfiguration"><code>SourceCloneConfiguration</code> - </a></li>
|
|
<li><a href="#SourceCloneRequestBody"><code>SourceCloneRequestBody</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="#SourceDefinitionIdWithWorkspaceId"><code>SourceDefinitionIdWithWorkspaceId</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="#SourceDiscoverSchemaRequestBody"><code>SourceDiscoverSchemaRequestBody</code> - </a></li>
|
|
<li><a href="#SourceDiscoverSchemaWriteRequestBody"><code>SourceDiscoverSchemaWriteRequestBody</code> - </a></li>
|
|
<li><a href="#SourceIdRequestBody"><code>SourceIdRequestBody</code> - </a></li>
|
|
<li><a href="#SourceOauthConsentRequest"><code>SourceOauthConsentRequest</code> - </a></li>
|
|
<li><a href="#SourceRead"><code>SourceRead</code> - </a></li>
|
|
<li><a href="#SourceReadList"><code>SourceReadList</code> - </a></li>
|
|
<li><a href="#SourceSearch"><code>SourceSearch</code> - </a></li>
|
|
<li><a href="#SourceSnippetRead"><code>SourceSnippetRead</code> - </a></li>
|
|
<li><a href="#SourceUpdate"><code>SourceUpdate</code> - </a></li>
|
|
<li><a href="#StreamDescriptor"><code>StreamDescriptor</code> - </a></li>
|
|
<li><a href="#StreamState"><code>StreamState</code> - </a></li>
|
|
<li><a href="#StreamTransform"><code>StreamTransform</code> - </a></li>
|
|
<li><a href="#SyncMode"><code>SyncMode</code> - </a></li>
|
|
<li><a href="#SynchronousJobRead"><code>SynchronousJobRead</code> - </a></li>
|
|
<li><a href="#UploadRead"><code>UploadRead</code> - </a></li>
|
|
<li><a href="#WebBackendCheckUpdatesRead"><code>WebBackendCheckUpdatesRead</code> - </a></li>
|
|
<li><a href="#WebBackendConnectionCreate"><code>WebBackendConnectionCreate</code> - </a></li>
|
|
<li><a href="#WebBackendConnectionListItem"><code>WebBackendConnectionListItem</code> - </a></li>
|
|
<li><a href="#WebBackendConnectionListRequestBody"><code>WebBackendConnectionListRequestBody</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="#WebBackendGeographiesListResult"><code>WebBackendGeographiesListResult</code> - </a></li>
|
|
<li><a href="#WebBackendOperationCreateOrUpdate"><code>WebBackendOperationCreateOrUpdate</code> - </a></li>
|
|
<li><a href="#WebBackendWorkspaceState"><code>WebBackendWorkspaceState</code> - </a></li>
|
|
<li><a href="#WebBackendWorkspaceStateResult"><code>WebBackendWorkspaceStateResult</code> - </a></li>
|
|
<li><a href="#WebhookConfigRead"><code>WebhookConfigRead</code> - </a></li>
|
|
<li><a href="#WebhookConfigWrite"><code>WebhookConfigWrite</code> - </a></li>
|
|
<li><a href="#WorkflowStateRead"><code>WorkflowStateRead</code> - </a></li>
|
|
<li><a href="#WorkspaceCreate"><code>WorkspaceCreate</code> - </a></li>
|
|
<li><a href="#WorkspaceGiveFeedback"><code>WorkspaceGiveFeedback</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>
|
|
<li><a href="#WorkspaceUpdateName"><code>WorkspaceUpdateName</code> - </a></li>
|
|
</ol>
|
|
|
|
<div class="model">
|
|
<h3><a name="ActorCatalogWithUpdatedAt"><code>ActorCatalogWithUpdatedAt</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>A source actor catalog with the timestamp it was mostly recently updated</div>
|
|
<div class="field-items">
|
|
<div class="param">updatedAt (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">catalog (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ActorDefinitionResourceRequirements"><code>ActorDefinitionResourceRequirements</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.</div>
|
|
<div class="field-items">
|
|
<div class="param">default (optional)</div><div class="param-desc"><span class="param-type"><a href="#ResourceRequirements">ResourceRequirements</a></span> </div>
|
|
<div class="param">jobSpecific (optional)</div><div class="param-desc"><span class="param-type"><a href="#JobTypeResourceLimit">array[JobTypeResourceLimit]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AdvancedAuth"><code>AdvancedAuth</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">authFlowType (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">oauth2.0</div><div class="param-enum">oauth1.0</div>
|
|
<div class="param">predicateKey (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> Json Path to a field in the connectorSpecification that should exist for the advanced auth to be applicable. </div>
|
|
<div class="param">predicateValue (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Value of the predicate_key fields for the advanced auth to be applicable. </div>
|
|
<div class="param">oauthConfigSpecification (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuthConfigSpecification">OAuthConfigSpecification</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<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> If this is true, the stream is selected with all of its properties. For new connections, this considers if the stream is suggested or not </div>
|
|
<div class="param">suggested (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Does the connector suggest that this stream be enabled by default? </div>
|
|
<div class="param">fieldSelectionEnabled (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Whether field selection should be enabled. If this is true, only the properties in <code>selectedFields</code> will be included. </div>
|
|
<div class="param">selectedFields (optional)</div><div class="param-desc"><span class="param-type"><a href="#SelectedFieldInfo">array[SelectedFieldInfo]</a></span> Paths to the fields that will be included in the configured catalog. This must be set if <code>fieldSelectedEnabled</code> is set. An empty list indicates that no properties will be included. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AttemptFailureOrigin"><code>AttemptFailureOrigin</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Indicates where the error originated. If not set, the origin of error is not well known.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AttemptFailureReason"><code>AttemptFailureReason</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">failureOrigin (optional)</div><div class="param-desc"><span class="param-type"><a href="#AttemptFailureOrigin">AttemptFailureOrigin</a></span> </div>
|
|
<div class="param">failureType (optional)</div><div class="param-desc"><span class="param-type"><a href="#AttemptFailureType">AttemptFailureType</a></span> </div>
|
|
<div class="param">externalMessage (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">internalMessage (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">stacktrace (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">retryable (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> True if it is known that retrying may succeed, e.g. for a transient failure. False if it is known that a retry will not succeed, e.g. for a configuration issue. If not set, retryable status is not well known. </div>
|
|
<div class="param">timestamp </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="AttemptFailureSummary"><code>AttemptFailureSummary</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">failures </div><div class="param-desc"><span class="param-type"><a href="#AttemptFailureReason">array[AttemptFailureReason]</a></span> </div>
|
|
<div class="param">partialSuccess (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> True if the number of committed records for this attempt was greater than 0. False if 0 records were committed. If not set, the number of committed records is unknown. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AttemptFailureType"><code>AttemptFailureType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Categorizes well known errors into types for programmatic handling. If not set, the type of error is not well known.</div>
|
|
<div class="field-items">
|
|
</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="AttemptNormalizationStatusRead"><code>AttemptNormalizationStatusRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">attemptNumber (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">hasRecordsCommitted (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">recordsCommitted (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">hasNormalizationFailed (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="AttemptNormalizationStatusReadList"><code>AttemptNormalizationStatusReadList</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">attemptNormalizationStatuses (optional)</div><div class="param-desc"><span class="param-type"><a href="#AttemptNormalizationStatusRead">array[AttemptNormalizationStatusRead]</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 class="param">totalStats (optional)</div><div class="param-desc"><span class="param-type"><a href="#AttemptStats">AttemptStats</a></span> </div>
|
|
<div class="param">streamStats (optional)</div><div class="param-desc"><span class="param-type"><a href="#AttemptStreamStats">array[AttemptStreamStats]</a></span> </div>
|
|
<div class="param">failureSummary (optional)</div><div class="param-desc"><span class="param-type"><a href="#AttemptFailureSummary">AttemptFailureSummary</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AttemptStats"><code>AttemptStats</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">recordsEmitted (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">bytesEmitted (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">stateMessagesEmitted (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">recordsCommitted (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">estimatedRecords (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">estimatedBytes (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="AttemptStreamStats"><code>AttemptStreamStats</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">streamName </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">streamNamespace (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">stats </div><div class="param-desc"><span class="param-type"><a href="#AttemptStats">AttemptStats</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AttemptSyncConfig"><code>AttemptSyncConfig</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceConfiguration </div><div class="param-desc"><span class="param-type"><a href="#SourceConfiguration">SourceConfiguration</a></span> </div>
|
|
<div class="param">destinationConfiguration </div><div class="param-desc"><span class="param-type"><a href="#DestinationConfiguration">DestinationConfiguration</a></span> </div>
|
|
<div class="param">state (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionState">ConnectionState</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="AuthSpecification"><code>AuthSpecification</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">auth_type (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">oauth2.0</div>
|
|
<div class="param">oauth2Specification (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuth2Specification">OAuth2Specification</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="CatalogDiff"><code>CatalogDiff</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Describes the difference between two Airbyte catalogs.</div>
|
|
<div class="field-items">
|
|
<div class="param">transforms </div><div class="param-desc"><span class="param-type"><a href="#StreamTransform">array[StreamTransform]</a></span> list of stream transformations. order does not matter. </div>
|
|
</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="CompleteDestinationOAuthRequest"><code>CompleteDestinationOAuthRequest</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">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">redirectUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> When completing OAuth flow to gain an access token, some API sometimes requires to verify that the app re-send the redirectUrl that was used when consent was given. </div>
|
|
<div class="param">queryParams (optional)</div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> The query parameters present in the redirect URL after a user granted consent e.g auth code </div>
|
|
<div class="param">oAuthInputConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuthConfiguration">OAuthConfiguration</a></span> </div>
|
|
<div class="param">destinationId (optional)</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="CompleteSourceOauthRequest"><code>CompleteSourceOauthRequest</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">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">redirectUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> When completing OAuth flow to gain an access token, some API sometimes requires to verify that the app re-send the redirectUrl that was used when consent was given. </div>
|
|
<div class="param">queryParams (optional)</div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> The query parameters present in the redirect URL after a user granted consent e.g auth code </div>
|
|
<div class="param">oAuthInputConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuthConfiguration">OAuthConfiguration</a></span> </div>
|
|
<div class="param">sourceId (optional)</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="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">scheduleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleType">ConnectionScheduleType</a></span> </div>
|
|
<div class="param">scheduleData (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData">ConnectionScheduleData</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">sourceCatalogId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">geography (optional)</div><div class="param-desc"><span class="param-type"><a href="#Geography">Geography</a></span> </div>
|
|
<div class="param">notifySchemaChanges (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">nonBreakingChangesPreference (optional)</div><div class="param-desc"><span class="param-type"><a href="#NonBreakingChangesPreference">NonBreakingChangesPreference</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">scheduleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleType">ConnectionScheduleType</a></span> </div>
|
|
<div class="param">scheduleData (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData">ConnectionScheduleData</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">sourceCatalogId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">geography (optional)</div><div class="param-desc"><span class="param-type"><a href="#Geography">Geography</a></span> </div>
|
|
<div class="param">breakingChange </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">notifySchemaChanges (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">nonBreakingChangesPreference (optional)</div><div class="param-desc"><span class="param-type"><a href="#NonBreakingChangesPreference">NonBreakingChangesPreference</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="ConnectionScheduleData"><code>ConnectionScheduleData</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>schedule for when the the connection should run, per the schedule type</div>
|
|
<div class="field-items">
|
|
<div class="param">basicSchedule (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData_basicSchedule">ConnectionScheduleData_basicSchedule</a></span> </div>
|
|
<div class="param">cron (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData_cron">ConnectionScheduleData_cron</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionScheduleData_basicSchedule"><code>ConnectionScheduleData_basicSchedule</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<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 class="param">units </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="ConnectionScheduleData_cron"><code>ConnectionScheduleData_cron</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">cronExpression </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">cronTimeZone </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="ConnectionScheduleType"><code>ConnectionScheduleType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>determine how the schedule data should be interpreted</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionSearch"><code>ConnectionSearch</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connectionId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">name (optional)</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 (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">destinationId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</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">scheduleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleType">ConnectionScheduleType</a></span> </div>
|
|
<div class="param">scheduleData (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData">ConnectionScheduleData</a></span> </div>
|
|
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionStatus">ConnectionStatus</a></span> </div>
|
|
<div class="param">source (optional)</div><div class="param-desc"><span class="param-type"><a href="#SourceSearch">SourceSearch</a></span> </div>
|
|
<div class="param">destination (optional)</div><div class="param-desc"><span class="param-type"><a href="#DestinationSearch">DestinationSearch</a></span> </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'>Contains the state for a connection. The stateType field identifies what type of state it is. Only the field corresponding to that type will be set, the rest will be null. If stateType=not_set, then none of the fields will be set.</div>
|
|
<div class="field-items">
|
|
<div class="param">stateType </div><div class="param-desc"><span class="param-type"><a href="#ConnectionStateType">ConnectionStateType</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 class="param">state (optional)</div><div class="param-desc"><span class="param-type"><a href="#StateBlob">StateBlob</a></span> </div>
|
|
<div class="param">streamState (optional)</div><div class="param-desc"><span class="param-type"><a href="#StreamState">array[StreamState]</a></span> </div>
|
|
<div class="param">globalState (optional)</div><div class="param-desc"><span class="param-type"><a href="#GlobalState">GlobalState</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionStateCreateOrUpdate"><code>ConnectionStateCreateOrUpdate</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">connectionState </div><div class="param-desc"><span class="param-type"><a href="#ConnectionState">ConnectionState</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ConnectionStateType"><code>ConnectionStateType</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="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'>Used to apply a patch-style update to a connection, which means that null properties remain unchanged</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">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Name that will be set to this connection </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 (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">scheduleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleType">ConnectionScheduleType</a></span> </div>
|
|
<div class="param">scheduleData (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData">ConnectionScheduleData</a></span> </div>
|
|
<div class="param">status (optional)</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">sourceCatalogId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">geography (optional)</div><div class="param-desc"><span class="param-type"><a href="#Geography">Geography</a></span> </div>
|
|
<div class="param">notifySchemaChanges (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">nonBreakingChangesPreference (optional)</div><div class="param-desc"><span class="param-type"><a href="#NonBreakingChangesPreference">NonBreakingChangesPreference</a></span> </div>
|
|
<div class="param">breakingChange (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="CustomDestinationDefinitionCreate"><code>CustomDestinationDefinitionCreate</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">destinationDefinition </div><div class="param-desc"><span class="param-type"><a href="#DestinationDefinitionCreate">DestinationDefinitionCreate</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="CustomSourceDefinitionCreate"><code>CustomSourceDefinitionCreate</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">sourceDefinition </div><div class="param-desc"><span class="param-type"><a href="#SourceDefinitionCreate">SourceDefinitionCreate</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="DestinationCloneConfiguration"><code>DestinationCloneConfiguration</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connectionConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#DestinationConfiguration">DestinationConfiguration</a></span> </div>
|
|
<div class="param">name (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="DestinationCloneRequestBody"><code>DestinationCloneRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The values required to configure the destination. The schema for this should have an id of the existing destination along with the configuration you want to change in case.</div>
|
|
<div class="field-items">
|
|
<div class="param">destinationCloneId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">destinationConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#DestinationCloneConfiguration">DestinationCloneConfiguration</a></span> </div>
|
|
</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">destinationId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</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 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="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 class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ActorDefinitionResourceRequirements">ActorDefinitionResourceRequirements</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="DestinationDefinitionIdWithWorkspaceId"><code>DestinationDefinitionIdWithWorkspaceId</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">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="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 class="param">protocolVersion (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Airbyte Protocol version supported by the connector </div>
|
|
<div class="param">releaseStage (optional)</div><div class="param-desc"><span class="param-type"><a href="#ReleaseStage">ReleaseStage</a></span> </div>
|
|
<div class="param">releaseDate (optional)</div><div class="param-desc"><span class="param-type"><a href="#date">date</a></span> The date when this connector was first released, in yyyy-mm-dd format. format: date</div>
|
|
<div class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ActorDefinitionResourceRequirements">ActorDefinitionResourceRequirements</a></span> </div>
|
|
<div class="param">supportsDbt </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> an optional flag indicating whether DBT is used in the normalization. If the flag value is NULL - DBT is not used. </div>
|
|
<div class="param">normalizationConfig </div><div class="param-desc"><span class="param-type"><a href="#NormalizationDestinationDefinitionConfig">NormalizationDestinationDefinitionConfig</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">authSpecification (optional)</div><div class="param-desc"><span class="param-type"><a href="#AuthSpecification">AuthSpecification</a></span> </div>
|
|
<div class="param">advancedAuth (optional)</div><div class="param-desc"><span class="param-type"><a href="#AdvancedAuth">AdvancedAuth</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> <!-- 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 class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ActorDefinitionResourceRequirements">ActorDefinitionResourceRequirements</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="DestinationOauthConsentRequest"><code>DestinationOauthConsentRequest</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">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">redirectUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The url to redirect to after getting the user consent </div>
|
|
<div class="param">oAuthInputConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuthConfiguration">OAuthConfiguration</a></span> </div>
|
|
<div class="param">destinationId (optional)</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 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="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="DestinationSearch"><code>DestinationSearch</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitionId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">destinationId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">workspaceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#DestinationConfiguration">DestinationConfiguration</a></span> </div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">destinationName (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="DestinationSnippetRead"><code>DestinationSnippetRead</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">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">destinationName </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </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="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="DiscoverCatalogResult"><code>DiscoverCatalogResult</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">catalogId </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="FieldAdd"><code>FieldAdd</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">schema (optional)</div><div class="param-desc"><span class="param-type"><a href="#FieldSchema">FieldSchema</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="FieldRemove"><code>FieldRemove</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">schema (optional)</div><div class="param-desc"><span class="param-type"><a href="#FieldSchema">FieldSchema</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="FieldSchemaUpdate"><code>FieldSchemaUpdate</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">oldSchema </div><div class="param-desc"><span class="param-type"><a href="#FieldSchema">FieldSchema</a></span> </div>
|
|
<div class="param">newSchema </div><div class="param-desc"><span class="param-type"><a href="#FieldSchema">FieldSchema</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="FieldTransform"><code>FieldTransform</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Describes the difference between two Streams.</div>
|
|
<div class="field-items">
|
|
<div class="param">transformType </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">add_field</div><div class="param-enum">remove_field</div><div class="param-enum">update_field_schema</div>
|
|
<div class="param">fieldName </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> A field name is a list of strings that form the path to the field. </div>
|
|
<div class="param">breaking </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">addField (optional)</div><div class="param-desc"><span class="param-type"><a href="#FieldAdd">FieldAdd</a></span> </div>
|
|
<div class="param">removeField (optional)</div><div class="param-desc"><span class="param-type"><a href="#FieldRemove">FieldRemove</a></span> </div>
|
|
<div class="param">updateFieldSchema (optional)</div><div class="param-desc"><span class="param-type"><a href="#FieldSchemaUpdate">FieldSchemaUpdate</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Geography"><code>Geography</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="GlobalState"><code>GlobalState</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">shared_state (optional)</div><div class="param-desc"><span class="param-type"><a href="#StateBlob">StateBlob</a></span> </div>
|
|
<div class="param">streamStates </div><div class="param-desc"><span class="param-type"><a href="#StreamState">array[StreamState]</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">available </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="ImportRequestBody"><code>ImportRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">resourceId </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> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="InternalOperationResult"><code>InternalOperationResult</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">succeeded </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="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="JobDebugInfoRead"><code>JobDebugInfoRead</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="#JobDebugRead">JobDebugRead</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 class="param">workflowState (optional)</div><div class="param-desc"><span class="param-type"><a href="#WorkflowStateRead">WorkflowStateRead</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobDebugRead"><code>JobDebugRead</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">status </div><div class="param-desc"><span class="param-type"><a href="#JobStatus">JobStatus</a></span> </div>
|
|
<div class="param">airbyteVersion </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">sourceDefinition </div><div class="param-desc"><span class="param-type"><a href="#SourceDefinitionRead">SourceDefinitionRead</a></span> </div>
|
|
<div class="param">destinationDefinition </div><div class="param-desc"><span class="param-type"><a href="#DestinationDefinitionRead">DestinationDefinitionRead</a></span> </div>
|
|
</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="JobInfoLightRead"><code>JobInfoLightRead</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> <!-- 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">includingJobId (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">pagination (optional)</div><div class="param-desc"><span class="param-type"><a href="#Pagination">Pagination</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobOptionalRead"><code>JobOptionalRead</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> <!-- 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">startedAt (optional)</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 class="param">resetConfig (optional)</div><div class="param-desc"><span class="param-type"><a href="#ResetConfig">ResetConfig</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 class="param">totalJobCount </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> the total count of jobs for the specified connection format: int64</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="JobType"><code>JobType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>enum that describes the different types of jobs that the platform runs.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="JobTypeResourceLimit"><code>JobTypeResourceLimit</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>sets resource requirements for a specific job type for an actor definition. these values override the default, if both are set.</div>
|
|
<div class="field-items">
|
|
<div class="param">jobType </div><div class="param-desc"><span class="param-type"><a href="#JobType">JobType</a></span> </div>
|
|
<div class="param">resourceRequirements </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="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="NonBreakingChangesPreference"><code>NonBreakingChangesPreference</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="NormalizationDestinationDefinitionConfig"><code>NormalizationDestinationDefinitionConfig</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>describes a normalization config for destination definition</div>
|
|
<div class="field-items">
|
|
<div class="param">supported </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> whether the destination definition supports normalization. </div>
|
|
<div class="param">normalizationRepository (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> a field indicating the name of the repository to be used for normalization. If the value of the flag is NULL - normalization is not used. </div>
|
|
<div class="param">normalizationTag (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> a field indicating the tag of the docker repository to be used for normalization. </div>
|
|
<div class="param">normalizationIntegrationType (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> a field indicating the type of integration dialect to use for normalization. </div>
|
|
</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">sendOnSuccess </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">sendOnFailure </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</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 class="param">customerioConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</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="OAuth2Specification"><code>OAuth2Specification</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>An object containing any metadata needed to describe this connector's Oauth flow</div>
|
|
<div class="field-items">
|
|
<div class="param">rootObject </div><div class="param-desc"><span class="param-type"><a href="#AnyType">array[oas_any_type_not_mapped]</a></span> A list of strings representing a pointer to the root object which contains any oauth parameters in the ConnectorSpecification.
|
|
Examples:
|
|
if oauth parameters were contained inside the top level, rootObject=[] If they were nested inside another object {'credentials': {'app_id' etc...}, rootObject=['credentials'] If they were inside a oneOf {'switch': {oneOf: [{client_id...}, {non_oauth_param]}}, rootObject=['switch', 0] </div>
|
|
<div class="param">oauthFlowInitParameters </div><div class="param-desc"><span class="param-type"><a href="#array">array[array[String]]</a></span> Pointers to the fields in the rootObject needed to obtain the initial refresh/access tokens for the OAuth flow. Each inner array represents the path in the rootObject of the referenced field. For example. Assume the rootObject contains params 'app_secret', 'app_id' which are needed to get the initial refresh token. If they are not nested in the rootObject, then the array would look like this [['app_secret'], ['app_id']] If they are nested inside an object called 'auth_params' then this array would be [['auth_params', 'app_secret'], ['auth_params', 'app_id']] </div>
|
|
<div class="param">oauthFlowOutputParameters </div><div class="param-desc"><span class="param-type"><a href="#array">array[array[String]]</a></span> Pointers to the fields in the rootObject which can be populated from successfully completing the oauth flow using the init parameters. This is typically a refresh/access token. Each inner array represents the path in the rootObject of the referenced field. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OAuthConfigSpecification"><code>OAuthConfigSpecification</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">oauthUserInputFromConnectorConfigSpecification (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuthConfiguration">OAuthConfiguration</a></span> </div>
|
|
<div class="param">completeOAuthOutputSpecification (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuthConfiguration">OAuthConfiguration</a></span> </div>
|
|
<div class="param">completeOAuthServerInputSpecification (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuthConfiguration">OAuthConfiguration</a></span> </div>
|
|
<div class="param">completeOAuthServerOutputSpecification (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuthConfiguration">OAuthConfiguration</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OAuthConsentRead"><code>OAuthConsentRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">consentUrl </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="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 class="param">webhook (optional)</div><div class="param-desc"><span class="param-type"><a href="#OperatorWebhook">OperatorWebhook</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="OperatorWebhook"><code>OperatorWebhook</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">webhookConfigId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> The id of the webhook configs to use from the workspace. format: uuid</div>
|
|
<div class="param">webhookType (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">dbtCloud</div>
|
|
<div class="param">dbtCloud (optional)</div><div class="param-desc"><span class="param-type"><a href="#OperatorWebhook_dbtCloud">OperatorWebhook_dbtCloud</a></span> </div>
|
|
<div class="param">executionUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> DEPRECATED. Populate dbtCloud instead. </div>
|
|
<div class="param">executionBody (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> DEPRECATED. Populate dbtCloud instead. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="OperatorWebhook_dbtCloud"><code>OperatorWebhook_dbtCloud</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">accountId </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> The account id associated with the job </div>
|
|
<div class="param">jobId </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> The job id associated with the job </div>
|
|
</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="PrivateDestinationDefinitionRead"><code>PrivateDestinationDefinitionRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinition </div><div class="param-desc"><span class="param-type"><a href="#DestinationDefinitionRead">DestinationDefinitionRead</a></span> </div>
|
|
<div class="param">granted </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="PrivateDestinationDefinitionReadList"><code>PrivateDestinationDefinitionReadList</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="#PrivateDestinationDefinitionRead">array[PrivateDestinationDefinitionRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="PrivateSourceDefinitionRead"><code>PrivateSourceDefinitionRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinition </div><div class="param-desc"><span class="param-type"><a href="#SourceDefinitionRead">SourceDefinitionRead</a></span> </div>
|
|
<div class="param">granted </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="PrivateSourceDefinitionReadList"><code>PrivateSourceDefinitionReadList</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="#PrivateSourceDefinitionRead">array[PrivateSourceDefinitionRead]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="ReleaseStage"><code>ReleaseStage</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="ResetConfig"><code>ResetConfig</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>contains information about how a reset was configured. only populated if the job was a reset.</div>
|
|
<div class="field-items">
|
|
<div class="param">streamsToReset (optional)</div><div class="param-desc"><span class="param-type"><a href="#StreamDescriptor">array[StreamDescriptor]</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="SaveAttemptSyncConfigRequestBody"><code>SaveAttemptSyncConfigRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">jobId </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">attemptNumber </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">syncConfig </div><div class="param-desc"><span class="param-type"><a href="#AttemptSyncConfig">AttemptSyncConfig</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SaveStatsRequestBody"><code>SaveStatsRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">jobId </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">attemptNumber </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">stats </div><div class="param-desc"><span class="param-type"><a href="#AttemptStats">AttemptStats</a></span> </div>
|
|
<div class="param">streamStats (optional)</div><div class="param-desc"><span class="param-type"><a href="#AttemptStreamStats">array[AttemptStreamStats]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SchemaChange"><code>SchemaChange</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="SelectedFieldInfo"><code>SelectedFieldInfo</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Path to a field/column/property in a stream to be selected. For example, if the field to be selected is a database column called "foo", this will be ["foo"]. Use multiple path elements for nested schemas.</div>
|
|
<div class="field-items">
|
|
<div class="param">fieldPath (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="SetInstancewideDestinationOauthParamsRequestBody"><code>SetInstancewideDestinationOauthParamsRequestBody</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">params </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SetInstancewideSourceOauthParamsRequestBody"><code>SetInstancewideSourceOauthParamsRequestBody</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">params </div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SetWorkflowInAttemptRequestBody"><code>SetWorkflowInAttemptRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">jobId </div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> format: int64</div>
|
|
<div class="param">attemptNumber </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">workflowId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">processingTaskQueue (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="SourceCloneConfiguration"><code>SourceCloneConfiguration</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connectionConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#SourceConfiguration">SourceConfiguration</a></span> </div>
|
|
<div class="param">name (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="SourceCloneRequestBody"><code>SourceCloneRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The values required to configure the source. The schema for this should have an id of the existing source along with the configuration you want to change in case.</div>
|
|
<div class="field-items">
|
|
<div class="param">sourceCloneId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">sourceConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#SourceCloneConfiguration">SourceCloneConfiguration</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">sourceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<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> <!-- 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 class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ActorDefinitionResourceRequirements">ActorDefinitionResourceRequirements</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="SourceDefinitionIdWithWorkspaceId"><code>SourceDefinitionIdWithWorkspaceId</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">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="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 class="param">protocolVersion (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Airbyte Protocol version supported by the connector </div>
|
|
<div class="param">releaseStage (optional)</div><div class="param-desc"><span class="param-type"><a href="#ReleaseStage">ReleaseStage</a></span> </div>
|
|
<div class="param">releaseDate (optional)</div><div class="param-desc"><span class="param-type"><a href="#date">date</a></span> The date when this connector was first released, in yyyy-mm-dd format. format: date</div>
|
|
<div class="param">sourceType (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">api</div><div class="param-enum">file</div><div class="param-enum">database</div><div class="param-enum">custom</div>
|
|
<div class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ActorDefinitionResourceRequirements">ActorDefinitionResourceRequirements</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">authSpecification (optional)</div><div class="param-desc"><span class="param-type"><a href="#AuthSpecification">AuthSpecification</a></span> </div>
|
|
<div class="param">advancedAuth (optional)</div><div class="param-desc"><span class="param-type"><a href="#AdvancedAuth">AdvancedAuth</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 class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ActorDefinitionResourceRequirements">ActorDefinitionResourceRequirements</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 class="param">catalogId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">catalogDiff (optional)</div><div class="param-desc"><span class="param-type"><a href="#CatalogDiff">CatalogDiff</a></span> </div>
|
|
<div class="param">breakingChange (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">connectionStatus (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionStatus">ConnectionStatus</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="SourceDiscoverSchemaRequestBody"><code>SourceDiscoverSchemaRequestBody</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">connectionId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">disable_cache (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">notifySchemaChange (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="SourceDiscoverSchemaWriteRequestBody"><code>SourceDiscoverSchemaWriteRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>to write this requested object to database.</div>
|
|
<div class="field-items">
|
|
<div class="param">catalog </div><div class="param-desc"><span class="param-type"><a href="#AirbyteCatalog">AirbyteCatalog</a></span> </div>
|
|
<div class="param">sourceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectorVersion (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">configurationHash (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="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="SourceOauthConsentRequest"><code>SourceOauthConsentRequest</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">workspaceId </div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">redirectUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The url to redirect to after getting the user consent </div>
|
|
<div class="param">oAuthInputConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#OAuthConfiguration">OAuthConfiguration</a></span> </div>
|
|
<div class="param">sourceId (optional)</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 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="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="SourceSearch"><code>SourceSearch</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">sourceDefinitionId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">sourceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">workspaceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">connectionConfiguration (optional)</div><div class="param-desc"><span class="param-type"><a href="#SourceConfiguration">SourceConfiguration</a></span> </div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">sourceName (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="SourceSnippetRead"><code>SourceSnippetRead</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">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<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">sourceName </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </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="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="StreamDescriptor"><code>StreamDescriptor</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">namespace (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="StreamState"><code>StreamState</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">streamDescriptor </div><div class="param-desc"><span class="param-type"><a href="#StreamDescriptor">StreamDescriptor</a></span> </div>
|
|
<div class="param">streamState (optional)</div><div class="param-desc"><span class="param-type"><a href="#StateBlob">StateBlob</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="StreamTransform"><code>StreamTransform</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">transformType </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">add_stream</div><div class="param-enum">remove_stream</div><div class="param-enum">update_stream</div>
|
|
<div class="param">streamDescriptor </div><div class="param-desc"><span class="param-type"><a href="#StreamDescriptor">StreamDescriptor</a></span> </div>
|
|
<div class="param">updateStream (optional)</div><div class="param-desc"><span class="param-type"><a href="#FieldTransform">array[FieldTransform]</a></span> list of field transformations. order does not matter. </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">connectorConfigurationUpdated (optional)</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="UploadRead"><code>UploadRead</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">resourceId (optional)</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="WebBackendCheckUpdatesRead"><code>WebBackendCheckUpdatesRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Summary of source and destination definitions that could be updated</div>
|
|
<div class="field-items">
|
|
<div class="param">destinationDefinitions </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
|
<div class="param">sourceDefinitions </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="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">scheduleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleType">ConnectionScheduleType</a></span> </div>
|
|
<div class="param">scheduleData (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData">ConnectionScheduleData</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 class="param">sourceCatalogId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">geography (optional)</div><div class="param-desc"><span class="param-type"><a href="#Geography">Geography</a></span> </div>
|
|
<div class="param">nonBreakingChangesPreference (optional)</div><div class="param-desc"><span class="param-type"><a href="#NonBreakingChangesPreference">NonBreakingChangesPreference</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebBackendConnectionListItem"><code>WebBackendConnectionListItem</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Information about a connection that shows up in the connection list view.</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">scheduleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleType">ConnectionScheduleType</a></span> </div>
|
|
<div class="param">scheduleData (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData">ConnectionScheduleData</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">source </div><div class="param-desc"><span class="param-type"><a href="#SourceSnippetRead">SourceSnippetRead</a></span> </div>
|
|
<div class="param">destination </div><div class="param-desc"><span class="param-type"><a href="#DestinationSnippetRead">DestinationSnippetRead</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">schemaChange </div><div class="param-desc"><span class="param-type"><a href="#SchemaChange">SchemaChange</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebBackendConnectionListRequestBody"><code>WebBackendConnectionListRequestBody</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">sourceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">array[UUID]</a></span> format: uuid</div>
|
|
<div class="param">destinationId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">array[UUID]</a></span> format: uuid</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">scheduleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleType">ConnectionScheduleType</a></span> </div>
|
|
<div class="param">scheduleData (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData">ConnectionScheduleData</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 class="param">catalogId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">catalogDiff (optional)</div><div class="param-desc"><span class="param-type"><a href="#CatalogDiff">CatalogDiff</a></span> </div>
|
|
<div class="param">geography (optional)</div><div class="param-desc"><span class="param-type"><a href="#Geography">Geography</a></span> </div>
|
|
<div class="param">schemaChange </div><div class="param-desc"><span class="param-type"><a href="#SchemaChange">SchemaChange</a></span> </div>
|
|
<div class="param">notifySchemaChanges </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">nonBreakingChangesPreference </div><div class="param-desc"><span class="param-type"><a href="#NonBreakingChangesPreference">NonBreakingChangesPreference</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="#WebBackendConnectionListItem">array[WebBackendConnectionListItem]</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'>Used to apply a patch-style update to a connection, which means that null properties remain unchanged</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> Name that will be set to the connection </div>
|
|
<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">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">scheduleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleType">ConnectionScheduleType</a></span> </div>
|
|
<div class="param">scheduleData (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConnectionScheduleData">ConnectionScheduleData</a></span> </div>
|
|
<div class="param">status (optional)</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">skipReset (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 class="param">sourceCatalogId (optional)</div><div class="param-desc"><span class="param-type"><a href="#UUID">UUID</a></span> format: uuid</div>
|
|
<div class="param">geography (optional)</div><div class="param-desc"><span class="param-type"><a href="#Geography">Geography</a></span> </div>
|
|
<div class="param">notifySchemaChanges (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">nonBreakingChangesPreference (optional)</div><div class="param-desc"><span class="param-type"><a href="#NonBreakingChangesPreference">NonBreakingChangesPreference</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebBackendGeographiesListResult"><code>WebBackendGeographiesListResult</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">geographies </div><div class="param-desc"><span class="param-type"><a href="#Geography">array[Geography]</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="WebBackendWorkspaceState"><code>WebBackendWorkspaceState</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="WebBackendWorkspaceStateResult"><code>WebBackendWorkspaceStateResult</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">hasConnections </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">hasSources </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">hasDestinations </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="WebhookConfigRead"><code>WebhookConfigRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>the readable info for a webhook config; omits sensitive info e.g. auth token</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">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> human-readable name e.g. for display in UI </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WebhookConfigWrite"><code>WebhookConfigWrite</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> human readable name for this webhook e.g. for UI display. </div>
|
|
<div class="param">authToken (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> an auth token, to be passed as the value for an HTTP Authorization header. </div>
|
|
<div class="param">validationUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> if supplied, the webhook config will be validated by checking that this URL returns a 2xx response. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WorkflowStateRead"><code>WorkflowStateRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">running </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="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 class="param">displaySetupWizard (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">defaultGeography (optional)</div><div class="param-desc"><span class="param-type"><a href="#Geography">Geography</a></span> </div>
|
|
<div class="param">webhookConfigs (optional)</div><div class="param-desc"><span class="param-type"><a href="#WebhookConfigWrite">array[WebhookConfigWrite]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WorkspaceGiveFeedback"><code>WorkspaceGiveFeedback</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="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 class="param">firstCompletedSync (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">feedbackDone (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">defaultGeography (optional)</div><div class="param-desc"><span class="param-type"><a href="#Geography">Geography</a></span> </div>
|
|
<div class="param">webhookConfigs (optional)</div><div class="param-desc"><span class="param-type"><a href="#WebhookConfigRead">array[WebhookConfigRead]</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'>Used to apply a patch-style update to a workspace, which means that null properties remain unchanged</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 (optional)</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 class="param">defaultGeography (optional)</div><div class="param-desc"><span class="param-type"><a href="#Geography">Geography</a></span> </div>
|
|
<div class="param">webhookConfigs (optional)</div><div class="param-desc"><span class="param-type"><a href="#WebhookConfigWrite">array[WebhookConfigWrite]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="WorkspaceUpdateName"><code>WorkspaceUpdateName</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> <!-- field-items -->
|
|
</div>
|
|
</body>
|
|
</html>
|