Check an export target table name

Check whether the target database and table name in a OmniFabric connector can be used in an export configuration.

HTTP
POST $CLOUDSIGMA_API_BASE/connectors/mo/check_table_name

Before you call this API

Configure the regional API endpoint and authentication, and select the target workspace.

First get connector details and confirm the target OmniFabric connector.

The example uses:

  • $CONNECTOR_ID: the OmniFabric connector ID.

Request

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/connectors/mo/check_table_name" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d "{
    \"connector_id\": \"$CONNECTOR_ID\",
    \"database\": \"analytics\",
    \"table\": \"orders\"
  }"

Request body

Parameter

Type

Required

Description

connector_id

string

Yes

OmniFabric connector ID.

database

string

Yes

Target database name.

table

string

Yes

Target table name.

Successful response

A successful response returns the validation result. Use it to decide whether to create the export task or change the target table name.

Error response

If the connector, database, or table name is invalid, check the request body and submit it again.

Last updated on