CData Connection API

The CData Cloud Connection API manages data source connections programmatically, allowing administrators to create, update, test, and delete connections to databases and SaaS applications.

Operations 38

POST /log/query/list List Query Log #
GET /log/query/get/{queryId} Get Query Log #
POST /log/audit/list List Audit Log #
GET /poweredby/account/list List Accounts #
GET /poweredby/account/{accountIdOrExternalId} Get Sub-Account #
POST /poweredby/account/create Create Account #
PUT /poweredby/account/update/{subAccountId} Update Sub-Account #
DELETE /poweredby/account/delete/{id} Delete Sub-Account #
POST /poweredby/connection/create Create Connection #
GET /poweredby/connection/list List Connections #
GET /poweredby/sources/list List Data Sources #
POST /poweredby/connection/edit/{connectionId} Edit Connection #
DELETE /poweredby/connection/delete/{id} Delete Connection #
DELETE /poweredby/{connectionId}/metadata Clear Connection Metadata #
POST /poweredby/dataExplorer Generate Data Explorer URL #
POST /poweredby/jobs Generate Jobs URL #
POST /job/cacheConnection Update Cache Connection #
POST /job/cacheConnection/formLink Generate Cache Connection URL #
GET /job/list List Jobs #
GET /job/{jobId} Get Job #
POST /job/create Create Job #
PUT /job/{jobId}/update Update Job #
DELETE /job/{jobId}/delete Delete Job #
POST /job/{jobId}/run Run Job #
POST /job/{jobId}/stop Stop Job #
GET /catalogs List Catalogs
GET /schemas List Schemas
GET /tables List Tables
GET /columns List Columns
GET /primaryKeys List Primary Keys
GET /importedKeys List Imported Keys
GET /exportedKeys List Exported Keys
GET /indexes List Indexes
GET /procedures List Procedures
GET /procedureParameters List Procedure Parameters
POST /query Execute Query
POST /batch Execute Batch Query
POST /exec Execute Procedure

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/connection-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cdata-rest-api-embedded-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: CData Connect AI REST API Embedded
  version: v1

servers:
  - url: https://cloud.cdata.com/api
    description: Production base URL

paths:
  /log/query/list:
    post:
      summary: List Query Log
      tags:
        - Log
      operationId: listQueryLog
      description: >
        Retrieves a list of query logs for an account.
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/QuerySearchCriteria"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/QuerySearchResult"
              example:
                queries:
                  - credential: "prat8897@gmail.com"
                    duration: 308
                    drivers: "PostgreSQL"
                    errorCode: "QUERY_FAILED"
                    errorMessage: "The stored procedure execution failed with the following error:\r\n[500] Could not execute the specified command: Unknown stored function/procedure transferdata\r\n<Query ID: e1af1260-4045-45e4-882b-96fe2575e37b>"
                    logFileKey: "x41GvdkvWlJsaEdQrzI2+t7M+TSbimW8iJIfQPv9mK1PqurO1/pzPW3D2ObewKfK6w51T7ui8yecrEYV3JpW9WmsAU+yVv4Vke1D2lB8EeKsv3ab6w2ZXrNZxPBAgaKAZLoRf8zbuHGWDGSQQ9gDJg=="
                    logVerbosity: 1
                    query: "PostgreSQL1.public.transferdata"
                    queryId: "e1af1260-4045-45e4-882b-96fe2575e37b"
                    queryType: 203
                    rowsAffected: -1
                    rowsInput: 1
                    rowsReturned: 0
                    timestamp: "2024-03-19T18:55:34.837Z"
                    userAgent: "PostmanRuntime/7.37.0"
  /log/query/get/{queryId}:
    get:
      summary: Get Query Log
      tags:
        - Log
      operationId: getQueryLog
      description: >
        Download a query log file for troubleshooting.
      parameters:
        - name: queryId
          in: path
          required: true
          description: The unique Id of the query for which to download the log file.
          schema:
            type: string
      responses:
        "200":
          description: OK and the zipped log file.
  /log/audit/list:
    post:
      summary: List Audit Log
      tags:
        - Log
      operationId: listAuditLog
      description: >
        Retrieves a list of audit logs for an account.
      parameters:
        - name: startTime
          in: query
          description: 'Timestamp in UTC (ISO 8601 format). Example: "2025-08-18T00:00:00Z"'
          schema:
            type: string
            format: date-time
        - name: endTime
          in: query
          description: 'Timestamp in UTC (ISO 8601 format). Example: "2025-08-18T23:59:59Z"'
          schema:
            type: string
            format: date-time
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuditSearchResult"
              example:
                events:
                  - eventType: 1003
                    timestamp: "2025-08-18T17:07:07.3673862Z"
                    targetId: "aaa96669-74c8-480f-a8c1-7956979cbee9"
                    targetName: "PostgreSQL1"
                    targetType: 1
                    userId: "6b8d5c25-cdc1-4b0c-b9f1-5b26647a8240"
                    userName: "User1"
                    userType: 0
                  - eventType: 1107
                    timestamp: "2025-08-13T21:20:08.4380865Z"
                    relatedId: "4780a367-2ba0-4b73-b086-b0d964323032"
                    relatedName: "Mcp"
                    relatedType: 4
                    targetId: "a41dd9b5-1ed6-54d9-b5e5-2754e4a29deb"
                    targetName: "test@cdata.com"
                    targetType: 2
                    userId: "a41dd9b5-1ed6-54d9-b5e5-2754e4a29deb"
                    userName: "User2"
                    userType: 0
  /poweredby/account/list:
    get:
      summary: List Accounts
      tags:
        - Account
      operationId: listAccounts
      description: >
        List Accounts lists the sub-accounts within the parent account.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccountListResult"
              example:
                accounts:
                  - id: "fee1ce9d-c40c-4ef6-8f8c-77461315713d"
                    externalId: "ExternalId"
                    accountName: "Acme Corporation"
                    created: "2023-07-13T20:42:56.317Z"
                  - id: "c6cc4c16-35c8-4657-90c6-f93d401b0ae9"
                    externalId: "GlobeInc"
                    accountName: "Globe Inc"
                    created: "2024-07-16T18:03:19.622Z"
  /poweredby/account/{accountIdOrExternalId}:
    get:
      summary: Get Sub-Account
      tags:
        - Account
      operationId: getAccount
      description: >
        Get Sub-Account returns a single sub-account within the parent account. You can look up the sub-account by either its internal Connect AI account Id or its external Id.
      parameters:
        - name: accountIdOrExternalId
          in: path
          required: true
          schema:
            type: string
          example: "fee1ce9d-c40c-4ef6-8f8c-77461315713d"
          description: The internal Connect AI account Id or the external Id of the sub-account.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccountInfo"
              example:
                id: "fee1ce9d-c40c-4ef6-8f8c-77461315713d"
                externalId: "ExternalId"
                accountName: "Acme Corporation"
                created: "2023-07-13T20:42:56.317Z"
  /poweredby/account/create:
    post:
      summary: Create Account
      tags:
        - Account
      operationId: createAccount
      description: >
        Create Account creates an account in the Connect AI Embed product.
        All request body fields are optional. If you send an empty body (`{}`), Create Account creates a sub-account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateAccountRequest"
            example:
              externalId: "MyExternalId"
              accountName: "Acme Corporation"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateAccountResult"
              example:
                accountId: "8744e71e-ee33-4d4e-916f-0a21eba65902"
                externalId: "MyExternalId"
                createdTime: "2024-07-10T19:10:52.139Z"
  /poweredby/account/update/{subAccountId}:
    put:
      summary: Update Sub-Account
      tags:
        - Account
      operationId: updateAccount
      description: >
        Update Sub-Account updates a sub-account within the parent account. Include only the fields you want to change in the request body.
      parameters:
        - name: subAccountId
          in: path
          required: true
          schema:
            type: string
          example: "fee1ce9d-c40c-4ef6-8f8c-77461315713d"
          description: The internal Connect AI account Id of the sub-account to update.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateAccountRequest"
            example:
              externalId: "MyExternalId"
              accountName: "Acme Corporation"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccountInfo"
              example:
                id: "fee1ce9d-c40c-4ef6-8f8c-77461315713d"
                externalId: "MyExternalId"
                accountName: "Acme Corporation"
                created: "2023-07-13T20:42:56.317Z"
  /poweredby/account/delete/{id}:
    delete:
      summary: Delete Sub-Account
      tags:
        - Account
      operationId: deleteAccount
      description: >
        Delete Sub-Account deletes a sub-account from the Connect AI Embed product.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          example: "fee1ce9d-c40c-4ef6-8f8c-77461315713d"
          description: The sub-account Id.
      responses:
        "200":
          description: OK
  /poweredby/connection/create:
    post:
      summary: Create Connection
      tags:
        - Connection
      operationId: createConnection
      description: >
        Create Connection requests the Connection Create Flow from the Connect AI Embed product. Create Connection validates the JWT and returns a string containing the URL to redirect the user to. If you include the parameter `dataSource`, the URL redirects the user to an **Add Connection** page for the data source. If you omit `dataSource`, the URL redirects the user to a general **Add Connection** page where the user can select a connection to add from the connections list.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateConnectionRequest"
            example:
              dataSource: "ExcelOnline"
              redirectURL: "https://www.google.com"
              name: "ExcelConnection"
              externalId: "acme-excel-001"
      responses:
        "200":
          description: A string containing the CData-hosted connection URL to redirect the user to. 
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RedirectURLResponse"
              example:
                redirectURL: "https://cloud.cdata.com/oem/user/connections/edit?token=eyJhbGciOiJSUzI1NiIs...truncated...&driver=ExcelOnline&redirectUrl=https%3A%2F%2Fwww.google.com"
  /poweredby/connection/list:
    get:
      summary: List Connections
      tags:
        - Connection
      operationId: listConnections
      description: >
        List Connections returns a list of connections for the sub-account. Use this endpoint for sub-account discovery scenarios. For example, you can reconcile connection mappings after a redirect failure, or look up the per-connection MCP URL for a known external identifier.
      parameters:
        - name: driver
          in: query
          required: false
          description: Filter to connections whose data source matches this value (case-insensitive).
          schema:
            type: string
            example: ExcelOnline
        - name: externalId
          in: query
          required: false
          description: Filter to connections with this externalId (case-sensitive).
          schema:
            type: string
            example: acme-excel-001
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConnectionListResult"
              example:
                connections:
                  - id: "880dc1a2-03c3-4288-9857-6f5c029d897c"
                    name: "ExcelOnline1"
                    dataSource: "ExcelOnline"
                    lastModified: "2024-08-02T21:30:55.154Z"
                    externalId: "acme-excel-001"
                    mcpUrl: "/mcp/connections/880dc1a2-03c3-4288-9857-6f5c029d897c"
                    status: "Authenticated"
                  - id: "eeef6211-5d6f-4347-b5bb-f99d574e75e5"
                    name: "MailChimp1"
                    dataSource: "MailChimp"
                    lastModified: "2023-10-11T20:43:33.28Z"
                    externalId: null
                    mcpUrl: "/mcp/connections/eeef6211-5d6f-4347-b5bb-f99d574e75e5"
                    status: "Conditional"
  /poweredby/sources/list:
    get:
      summary: List Data Sources
      tags:
        - Connection
      operationId: listDataSources
      description: >
        List Data Sources requests a list of data sources supported by Connect AI Embed.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataSourceListResult"
              example:
                dataSources:
                  - dataSource: "AmazonMarketplace"
                  - dataSource: "OracleSalesCloud"
                  - dataSource: "ZohoInventory"
                  - dataSource: "MariaDB"
                  - dataSource: "Monday"
                  - dataSource: "AlloyDB"
                  - dataSource: "GoogleContacts"
                  - dataSource: "ZohoCRM"
                  - dataSource: "SAPSuccessFactors"
                  - dataSource: "YahooAds"
                  - dataSource: "Salesforce"
                  - dataSource: "FreshDesk"
                  - dataSource: "ShipStation"
                  - dataSource: "Instagram"
                  - dataSource: "HubSpot"
                  - dataSource: "ConnectCache"
                  - dataSource: "SendGrid"
                  - dataSource: "PayPal"
                  - dataSource: "SAPByDesign"
                  - dataSource: "Sage200"
                  - dataSource: "BullhornCRM"
                  - dataSource: "Xero"
                  - dataSource: "Informix"
                  - dataSource: "WordPress"
                  - dataSource: "ADP"
                  - dataSource: "GoogleAds"
                  - dataSource: "Splunk"
                  - dataSource: "ActOn"
                  - dataSource: "Ebay"
                  - dataSource: "PostgreSQL"
                  - dataSource: "WooCommerce"
                  - dataSource: "Zuora"
                  - dataSource: "GoogleBigQuery"
                  - dataSource: "OracleSCM"
                  - dataSource: "ZohoBooks"
                  - dataSource: "MicrosoftProject"
                  - dataSource: "FacebookAds"
                  - dataSource: "YahooDS"
                  - dataSource: "TSheets"
                  - dataSource: "AdobeCommerce"
                  - dataSource: "SurveyMonkey"
                  - dataSource: "OracleERP"
                  - dataSource: "SAPHANA"
                  - dataSource: "GMOMakeShop"
                  - dataSource: "D365BusinessCentral"
                  - dataSource: "AzureAD"
                  - dataSource: "FinancialEdgeNXT"
                  - dataSource: "FreshBooks"
                  - dataSource: "OneNote"
                  - dataSource: "DocuSign"
                  - dataSource: "SageIntacct"
                  - dataSource: "Kintone"
                  - dataSource: "ServiceNow"
                  - dataSource: "OracleServiceCloud"
                  - dataSource: "QuickBase"
                  - dataSource: "ExactOnline"
                  - dataSource: "Dynamics365"
                  - dataSource: "YouTubeAnalytics"
                  - dataSource: "EpicorERP"
                  - dataSource: "Confluence"
                  - dataSource: "SparkSQL"
                  - dataSource: "Redis"
                  - dataSource: "GoogleSheets"
                  - dataSource: "MSTeams"
                  - dataSource: "Twitter"
                  - dataSource: "Presto"
                  - dataSource: "GoogleCalendar"
                  - dataSource: "MYOB"
                  - dataSource: "BingAds"
                  - dataSource: "Elasticsearch"
                  - dataSource: "OracleOci"
                  - dataSource: "SageBCAccounting"
                  - dataSource: "Databricks"
                  - dataSource: "SharePoint"
                  - dataSource: "TableauCRM"
                  - dataSource: "JIRA"
                  - dataSource: "Marketo"
                  - dataSource: "Workday"
                  - dataSource: "SQL"
                  - dataSource: "Outreach"
                  - dataSource: "ADLSSync"
                  - dataSource: "RaiserEdgeNXT"
                  - dataSource: "Smartsheet"
                  - dataSource: "Backlog"
                  - dataSource: "Domino"
                  - dataSource: "SAPHybrisC4C"
                  - dataSource: "Slack"
                  - dataSource: "PCASales"
                  - dataSource: "BigCommerce"
                  - dataSource: "Couchbase"
                  - dataSource: "NetSuite"
                  - dataSource: "ActiveDirectory"
                  - dataSource: "AzureSynapse"
                  - dataSource: "SalesforcePardot"
                  - dataSource: "ExcelOnline"
                  - dataSource: "AAS"
                  - dataSource: "Asana"
                  - dataSource: "ActCRM"
                  - dataSource: "ZohoCreator"
                  - dataSource: "SAPBusinessOne"
                  - dataSource: "TwitterAds"
                  - dataSource: "DynamicsCRM"
                  - dataSource: "GoogleCM"
                  - dataSource: "QuickBooksOnline"
                  - dataSource: "Twilio"
                  - dataSource: "MailChimp"
                  - dataSource: "FHIR"
                  - dataSource: "OracleEloqua"
                  - dataSource: "Exchange"
                  - dataSource: "Square"
                  - dataSource: "ZohoProjects"
                  - dataSource: "GoogleSpanner"
                  - dataSource: "MongoDB"
                  - dataSource: "GoogleAdsManager"
                  - dataSource: "Shopify"
                  - dataSource: "CosmosDB"
                  - dataSource: "PowerBIXMLA"
                  - dataSource: "LinkedInAds"
                  - dataSource: "AzureTables"
                  - dataSource: "Office365"
                  - dataSource: "Odoo"
                  - dataSource: "MicrosoftPlanner"
                  - dataSource: "Zendesk"
                  - dataSource: "Snowflake"
                  - dataSource: "GoogleAnalytics"
                  - dataSource: "VeevaVault"
                  - dataSource: "GraphQL"
                  - dataSource: "AdobeAnalytics"
                  - dataSource: "AzureDevOps"
                  - dataSource: "OracleHCM"
                  - dataSource: "MySQL"
                  - dataSource: "OData"
                  - dataSource: "AmazonAthena"
                  - dataSource: "LinkedIn"
                  - dataSource: "ActiveCampaign"
                  - dataSource: "AmazonDynamoDB"
                  - dataSource: "SAPConcur"
                  - dataSource: "Sansan"
                  - dataSource: "Trello"
                  - dataSource: "Greenplum"
                  - dataSource: "ApacheImpala"
                  - dataSource: "Smaregi"
                  - dataSource: "SugarCRM"
                  - dataSource: "Paylocity"
                  - dataSource: "Bing"
                  - dataSource: "XeroWorkflowMax"
                  - dataSource: "AmazonS3Sync"
                  - dataSource: "Redshift"
                  - dataSource: "MFExpense"
                  - dataSource: "CDS"
                  - dataSource: "Acumatica"
                  - dataSource: "GitHub"
                  - dataSource: "BCart"
                  - dataSource: "SFMarketingCloud"
                  - dataSource: "ApacheHive"
                  - dataSource: "CockroachDB"
                  - dataSource: "Airtable"
                  - dataSource: "SingleStore"
                  - dataSource: "SnapchatAds"
                  - dataSource: "Cloudant"
                  - dataSource: "Gmail"
                  - dataSource: "Stripe"
                  - dataSource: "GoogleSearch"
                  - dataSource: "Facebook"
                  - dataSource: "GoogleDirectory"
                  - dataSource: "JiraServiceDesk"
  /poweredby/connection/edit/{connectionId}:
    post:
      summary: Edit Connection
      tags:
        - Connection
      operationId: editConnection
      description: >
        Edit Connection edits a connection in the Connect AI Embed product. Returns a string containing the URL to redirect the user to.
      parameters:
        - name: connectionId
          in: path
          required: true
          schema:
            type: string
          description: The connection Id created in Create Connection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EditConnectionRequest"
            example:
              redirectURL: "https://www.google.com"
      responses:
        "200":
          description: A string containing the CData-hosted connection URL to redirect the user to.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RedirectURLResponse"
              example:
                redirectURL: "https://cloud.cdata.com/oem/user/connections/edit/eeef6211-5d6f-4347-b5bb-f99d574e75e5?driver=MailChimp&token=eyJhbGciOiJSUzI1NiIs...truncated...&redirectUrl=https%3A%2F%2Fwww.google.com"
  /poweredby/connection/delete/{id}:
    delete:
      summary: Delete Connection
      tags:
        - Connection
      operationId: deleteConnection
      description: >
        Delete Connection deletes a sub-account's connection from the Connect AI Embed product.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The connection Id to delete.
      responses:
        "200":
          description: OK
  /poweredby/{connectionId}/metadata:
    delete:
      summary: Clear Connection Metadata
      tags:
        - Connection
      operationId: clearConnectionMetadata
      description: >
        Clear Connection Metadata clears the metadata cache for the specified connection. In some situations, clearing the metadata cache can help fix loading or performance issues.
      parameters:
        - name: connectionId
          in: path
          required: true
          schema:
            type: string
          description: The connection Id of the connection in which to clear the metadata.
      responses:
        "200":
          description: OK
  /poweredby/dataExplorer:
    post:
      summary: Generate Data Explorer URL
      tags:
        - Data Explorer
      operationId: generateDataExplorerURL
      description: >
        Generate Data Explorer URL redirects you to the Data Explorer page of Connect AI.
      responses:
        "200":
          description: A string containing the URL to redirect the user to.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RedirectURLResponse"
              example:
                redirectURL: "https://cloud.cdata.com/oem/user/dataexplorer?token=eyJhbGciOiJSUzI1NiIs...truncated..."
  /poweredby/jobs:
    post:
      summary: Generate Jobs URL
      tags:
        - Jobs
      operationId: generateJobsURL
      description: >
        Generate Jobs URL redirects you to the Jobs page of Connect AI.
      responses:
        "200":
          description: A string containing the URL to redirect the user to.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RedirectURLResponse"
              example:
                redirectURL: "https://cloud.cdata.com/oem/user/jobs?token=eyJhbGciOiJSUzI1NiIs...truncated..."
  /job/cacheConnection:
    post:
      summary: Update Cache Connection
      tags:
        - Cache
      operationId: updateCacheConnection
      description: >
        Create/update the cache connection used by the other caching API calls.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CacheConnectionRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example:
                connection:
                  accountId: "fee1ce9d-c40c-4ef6-8f8c-77461315713d"
                  connectionString: "server=<Server URL>;port=5432;user=username;password=password;database=cachedb"
                  connectionType: 0
                  created: "2025-11-20T15:26:43.096Z"
                  driver: "PostgreSQL"
                  driverVersion: "24.0.9172.0"
                  id: "1c9b0ae6-3a6f-417a-8460-4ce5b5528540"
                  isTested: false
                  lastModified: "2025-11-20T15:52:32.8444712Z"
                  name: "CacheConnection"
                  walletFilePresent: false
                  isCannedConnection: false
      servers:
        - url: https://cloud.cdata.com/api
          description: Production base URL for job endpoints
  /job/cacheConnection/formLink:
    post:
      summary: Generate Cache Connection URL
      tags:
        - Cache
      operationId: generateCacheConnectionURL
      description: >
        Generates a URL for users to create or update their cache connection. Returns a string containing the URL to redirect the user to. Users can then add their PostgreSQL connection information to this page.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EditConnectionRequest"
      responses:
        "200":
          description: A string containing the URL to redirect the user to. Users can then add their PostgreSQL connection information to this page.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RedirectURLResponse"
              example:
                redirectURL: "https://cloud.cdata.com/oem/user/cacheConnection?token=eyJhbGciOiJSUzI1NiIs...truncated...&driver=PostgreSQL&redirectUrl=https%3A%2F%2Fwww.google.com&connectionName=OEMCacheConnection"
      servers:
        - url: https://cloud.cdata.com/api
          description: Production base URL for job endpoints
  /job/list:
    get:
      summary: List Jobs
      tags:
        - Job
      operationId: listJobs
      description: >
        Administrators, impersonating a service user, can request a list of jobs for a sub-account.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JobListResult"
              example:
                jobs:
                  - jobType: "Caching"
                    id: "string"
                    name: "string"
                    enabled: true
                    created: "2024-01-01T00:00:00Z"
                    lastModified: "2024-01-01T00:00:00Z"
                    nextRunTime: "2024-01-01T00:00:00Z"
                    intervalUnit: "Hour"
                    intervalValue: 1
                    logVerbosity: 1
                    lastRun:
                      dateTime: "0001-01-01T00:00:00Z"
                      duration: 63894847975
                      status: "JOB_QUEUED"
                      rowsAffected: 0
                      nextRunTime: "0001-01-01T00:00:00Z"
                    params:
                      timeCheckColumn: ""
                      autoTruncateStrings: "false"
                      sourceConnection: "f6f3cfe6-72e2-4edb-914f-4409c01c1418"
                      sourceConnectionName: "MailChimp1"
                      sourceName: "MailChimp"
                      sourceSchema: "MailChimp"
                      sourceTable: "Conversations"
      servers:
        - url: https://cloud.cdata.com/api
          description: Production base URL for job endpoints
  /job/{jobId}:
    get:
      summary: Get Job
      tags:
        - Job
      operationId: getJob
      description: >
        Retrieve the details for a specific job.
      parameters:
        - name: jobId
          in: path
          required: true
          schema:
            type: string
          description: The Id of the job you want to retrieve details from.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JobInfo"
              example:
                jobType: "Caching"
                id: "string"
                name: "string"
                enabled: true
                created: "2024-01-01T00:00:00Z"
                lastModified: "2024-01-01T00:00:00Z"
                nextRunTime: "2024-01-01T00:00:00Z"
                intervalUnit: "Hour"
                intervalValue: 1
                logVerbosity: 1
                lastRun:
                  dateTime: "0001-01-01T00:00:00Z"
                  duration: 63894847975
                  status: "JOB_QUEUED"
                  rowsAffected: 0
                  nextRunTime: "0001-01-01T00:00:00Z"
                params:
                  timeCheckColumn: ""
                  autoTruncateStrings: "false"
                  sourceConnection: "f6f3cfe6-72e2-4edb-914f-4409c01c1418"
                  sourceConnectionName: "MailChimp1"
                  sourceName: "MailChimp"
                  sourceSchema: "MailChimp"
                  sourceTable: "Conversations"
      servers:
        - url: https://cloud.cdata.com/api
          description: Production base URL for job endpoints
  /job/create:
    post:
      summary: Create Job
      tags:
        - Job
      operationId: createJob
      description: >
        Administrators, impersonating a service user, can use this call to create a new job.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateJobRequest"
            example:
              jobType: "Caching"
              intervalUnit: "Hour"
              intervalValue: "1"
              logVerbosity: "1"
              enabled: "true"
              params:
                timeCheckColumn: ""
                autoTruncateStrings: "false"
                sourceConnection: "36b2c04f-70f4-44a1-876a-29e42237ee63"
                sourceName: "OData1"
                sourceSchema: "OData"
                sourceTable: "Categories"
                mergeKeys:
                  - colName: "Id"
                    colType: "varchar"
                    isPrimaryKey: true
                  - colName: "WorkspaceId"
                    colType: "varchar"
                    isPrimaryKey: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JobInfo"
              example:
                jobType: "Caching"
                id: "string"
                name: "string"
                enabled: true
                created: "2024-01-01T00:00:00Z"
                lastModified: "2024-01-01T00:00:00Z"
                nextRunTime: "2024-01-01T00:00:00Z"
                intervalUnit: "Hour"
                intervalValue: 1
                logVerbosity: 1
                lastRun:
                  dateTime: "0001-01-01T00:00:00Z"
                  duration: 63894847975
                  status: "JOB_QUEUED"
                  rowsAffected: 0
                  nextRunTime: "0001-01-01T00:00:00Z"
                params:
                  timeCheckColumn: ""
                  autoTruncateStrings: "false"
                  sourceConnection: "f6f3cfe6-72e2-4edb-914f-4409c01c1418"
                  sourceConnectionName: "MailChimp1"
                  sourceName: "MailChimp"
                  sourceSchema: "MailChimp"
                  sourceTable: "Conversations"
      servers:
        - url: https://cloud.cdata.com/api
          description: Production base URL for job endpoints
  /job/{jobId}/update:
    put:
      summary: Update Job
      tags:
        - Job
      operationId: updateJob
      description: >
        Administrators, impersonating a service user, can use this call to update a specified job.
      parameters:
        - name: jobId
          in: path
          required: true
          schema:
            type: string
          description: The Id of the job you want to update.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateJobReque

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/openapi/cdata-rest-api-embedded-openapi.yml