Schedule Cloud Upload

Before executing APIs to schedule uploads, grant read access to the Google Cloud Storage bucket or Google BigQuery table (if using either). 
Tenant Id can be retrieved from the UI as listed here​
Source Id can be retrieved from the UI or using the APIs​
get
https://demo.api.telm.ai
/{tenant}/configuration/sources/{source}/scheduled_uploads
Get all scheduled uploads for this tenant and source
post
https://demo.api.telm.ai
/{tenant}/configuration/sources/{source}/scheduled_uploads
Schedule an upload
put
https://demo.api.telm.ai
/{tenant}/configuration/sources/{source}/scheduled_uploads
Update a scheduled upload
delete
https://demo.api.telm.ai
/{tenant}/configuration/sources/{source}/scheduled_uploads
Delete a scheduled upload
Request Body for POST and PUT
Some examples of the request body parameters are described below
Depending on the type of input source, the "upload" section will be any one of the request body described in Upload Data Apis section. ​
Example 1: If input file is located in Azure
{
  "delta_only": true,
  "enabled": true,
  "sample_fraction": 0,
  "schedule": "string",
  "skip_investigator": true,
  "source": "string",
  "timestamp_attribute": "string",
  "idAttribute": "string",
  "upload": {
    "type": "AZURE"
    "payload": {
      "bucket": "string",
      "path": "string",
      "read_options": {
        "separator": "string"
      },
      "security": {
        "sas_key": "string",
        "storage_account": "string"
      }
    }
  }
}
​
Example 2: If input file is located in BIGQUERY:
{
  "delta_only": true,
  "enabled": true,
  "sample_fraction": 0,
  "schedule": "string",
  "skip_investigator": true,
  "source": "string",
  "timestamp_attribute": "string",
  "idAttribute": "string",
  "upload": {
    "type": "BIGQUERY"
    "payload": {
      "dataset": "string",
      "method": "EXPORT",
      "project": "string",
      "table": "string"
    }
  }
}
​
Example 3: If input file is located in S3:
{
  "delta_only": true,
  "enabled": true,
  "sample_fraction": 0,
  "schedule": "string",
  "skip_investigator": true,
  "source": "string",
  "timestamp_attribute": "string",
  "idAttribute": "string",
  "upload": {
    "type": "S3"
    "payload": {
      "bucket": "string",
      "path": "string",
      "read_options": {
        "separator": "string"
      },
      "security": {
        "aws_key": "string",
        "aws_secret": "string",
        "region": "string"
      }
    }
  }
}

Upload Data APIs - Previous

Track Upload Job

Next - Alerts

Alert Channel

Last modified 4mo ago

Copy link

On this page

get

Get all scheduled uploads for this tenant and source

post

Schedule an upload

put

Update a scheduled upload

delete

Delete a scheduled upload