Update a job - CData Sync Documentation

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "workspace_id": "<string>",
  "name": "<string>",
  "type": "Standard",
  "source_connection": {
    "id": "<string>",
    "name": "<string>",
    "connector": "<string>",
    "error": "<string>"
  },
  "destination_connection": {
    "id": "<string>",
    "name": "<string>",
    "connector": "<string>",
    "error": "<string>"
  },
  "schedule": {
    "enabled": true,
    "cron": "<string>",
    "next_run_at": "2023-11-07T05:31:56Z"
  },
  "replicate_options": {
    "use_gmt_datetime": true,
    "truncate_table_data": true,
    "truncate_table_mode": "Delete",
    "drop_table": true,
    "auto_truncate_strings": true,
    "continue_on_error": true,
    "alter_schema": true,
    "command_timeout": 123,
    "deletion_behavior": "<string>",
    "transfer_mode": "InsertMode",
    "insert_mode": "<string>",
    "history_mode": true,
    "include_replicated_column": false,
    "replicate_interval": 180,
    "replicate_interval_unit": "<string>",
    "replicate_start_date": "<string>",
    "snapshot_size": "<string>",
    "skip_snapshot": "<string>",
    "reset_strategy": "<string>",
    "load_folder_file_name_pattern": "<string>",
    "skip_formula_fields": true,
    "status_connection": "<string>",
    "table_name_prefix": "<string>",
    "table_name_suffix": "<string>",
    "cache_schema": "<string>",
    "additional_options": "<string>",
    "snapshot_mode": "<string>",
    "sync_id_source_column": "<string>",
    "kafka_topic_routing_mode": "<string>",
    "enable_kafka_partitioning": true
  },
  "alerts": {
    "send_email": true,
    "email_to": "<string>",
    "email_subject": "<string>",
    "email_error_only": true
  },
  "settings": {
    "enable_parallel_processing": true,
    "worker_pool": 2,
    "verbosity": "None",
    "destination_schema": "<string>",
    "automatic_job_retry": true,
    "schema_strategy": "<string>",
    "transfer_mode": "InsertMode",
    "kafka_default_topic": "<string>"
  },
  "pre_job_event": {
    "id": "<string>",
    "script": "<string>",
    "error": "<string>"
  },
  "post_job_event": {
    "id": "<string>",
    "script": "<string>",
    "error": "<string>"
  },
  "cdc_engine_settings": {
    "publication_name": "<string>",
    "logical_replication_slot": "<string>",
    "pluggable_database": "<string>",
    "journal_library": "<string>",
    "journal_name": "<string>",
    "source_schema": "<string>",
    "additional_options": "<string>"
  },
  "permissions": {
    "can_update": true,
    "can_delete": true,
    "can_execute": true,
    "can_remove": true
  },
  "labels": [
    "<string>"
  ],
  "license_state": "<string>",
  "license_message": "<string>",
  "pipeline_id": "<string>",
  "last_run": {
    "run_start_date": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "details": "<string>",
    "records_affected": 123,
    "job_history_id": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "message": "<string>",
  "error": "<string>",
  "error_code": "INVALID_REFERENCE",
  "provider_id": "<string>",
  "item_name": "<string>"
}

{
  "code": 123,
  "message": "<string>",
  "error": "<string>",
  "error_code": "INVALID_REFERENCE",
  "provider_id": "<string>",
  "item_name": "<string>"
}

{
  "code": 123,
  "message": "<string>",
  "error": "<string>",
  "error_code": "INVALID_REFERENCE",
  "provider_id": "<string>",
  "item_name": "<string>"
}

PUT

jobs

{job_id}

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "workspace_id": "<string>",
  "name": "<string>",
  "type": "Standard",
  "source_connection": {
    "id": "<string>",
    "name": "<string>",
    "connector": "<string>",
    "error": "<string>"
  },
  "destination_connection": {
    "id": "<string>",
    "name": "<string>",
    "connector": "<string>",
    "error": "<string>"
  },
  "schedule": {
    "enabled": true,
    "cron": "<string>",
    "next_run_at": "2023-11-07T05:31:56Z"
  },
  "replicate_options": {
    "use_gmt_datetime": true,
    "truncate_table_data": true,
    "truncate_table_mode": "Delete",
    "drop_table": true,
    "auto_truncate_strings": true,
    "continue_on_error": true,
    "alter_schema": true,
    "command_timeout": 123,
    "deletion_behavior": "<string>",
    "transfer_mode": "InsertMode",
    "insert_mode": "<string>",
    "history_mode": true,
    "include_replicated_column": false,
    "replicate_interval": 180,
    "replicate_interval_unit": "<string>",
    "replicate_start_date": "<string>",
    "snapshot_size": "<string>",
    "skip_snapshot": "<string>",
    "reset_strategy": "<string>",
    "load_folder_file_name_pattern": "<string>",
    "skip_formula_fields": true,
    "status_connection": "<string>",
    "table_name_prefix": "<string>",
    "table_name_suffix": "<string>",
    "cache_schema": "<string>",
    "additional_options": "<string>",
    "snapshot_mode": "<string>",
    "sync_id_source_column": "<string>",
    "kafka_topic_routing_mode": "<string>",
    "enable_kafka_partitioning": true
  },
  "alerts": {
    "send_email": true,
    "email_to": "<string>",
    "email_subject": "<string>",
    "email_error_only": true
  },
  "settings": {
    "enable_parallel_processing": true,
    "worker_pool": 2,
    "verbosity": "None",
    "destination_schema": "<string>",
    "automatic_job_retry": true,
    "schema_strategy": "<string>",
    "transfer_mode": "InsertMode",
    "kafka_default_topic": "<string>"
  },
  "pre_job_event": {
    "id": "<string>",
    "script": "<string>",
    "error": "<string>"
  },
  "post_job_event": {
    "id": "<string>",
    "script": "<string>",
    "error": "<string>"
  },
  "cdc_engine_settings": {
    "publication_name": "<string>",
    "logical_replication_slot": "<string>",
    "pluggable_database": "<string>",
    "journal_library": "<string>",
    "journal_name": "<string>",
    "source_schema": "<string>",
    "additional_options": "<string>"
  },
  "permissions": {
    "can_update": true,
    "can_delete": true,
    "can_execute": true,
    "can_remove": true
  },
  "labels": [
    "<string>"
  ],
  "license_state": "<string>",
  "license_message": "<string>",
  "pipeline_id": "<string>",
  "last_run": {
    "run_start_date": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "details": "<string>",
    "records_affected": 123,
    "job_history_id": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "message": "<string>",
  "error": "<string>",
  "error_code": "INVALID_REFERENCE",
  "provider_id": "<string>",
  "item_name": "<string>"
}

{
  "code": 123,
  "message": "<string>",
  "error": "<string>",
  "error_code": "INVALID_REFERENCE",
  "provider_id": "<string>",
  "item_name": "<string>"
}

{
  "code": 123,
  "message": "<string>",
  "error": "<string>",
  "error_code": "INVALID_REFERENCE",
  "provider_id": "<string>",
  "item_name": "<string>"
}

Authorizations

x-cdata-authtoken

string

header

required

A Sync user auth token. Generate one via POST /v2/users/generate-token.

Path Parameters

job_id

string

required

Job identifier.

Body

application/json

name

string

required

type

enum<string>

required

Job type (display name).

Available options:

Standard,

Sync All,

Load Folder,

Reverse ETL,

SQL Change Tracking,

Oracle Flashback,

Change Data Capture

source_connection

object

required

References a connection by id or name. One of id or name is required.

Show child attributes

destination_connection

object

required

References a connection by id or name. One of id or name is required.

Show child attributes

queries

string[]

Initial task queries. For a Load Folder job, provide a single complete Load Folder query whose destination identifies the target table or Kafka topic.

labels

string[]

pipeline_id

string

schedule

object

Show child attributes

settings

object

Show child attributes

replicate_options

object

Show child attributes

alerts

object

Show child attributes

resync_options

object

Show child attributes

cdc_engine_settings

object

Source CDC engine settings. Applicable fields depend on the source provider (PostgreSQL, Oracle, DB2 for i, etc.).

Show child attributes

pre_job_event

object

Show child attributes

post_job_event

object

Show child attributes

Response

The requested resource.

string

workspace_id

string

name

string

type

enum<string>

Available options:

Standard,

Sync All,

Load Folder,

Reverse ETL,

SQL Change Tracking,

Oracle Flashback,

Change Data Capture

source_connection

object

A lightweight reference to a related resource.

Show child attributes

destination_connection

object

A lightweight reference to a related resource.

Show child attributes

schedule

object

Show child attributes

replicate_options

object

Show child attributes

alerts

object

Show child attributes

settings

object

Show child attributes

pre_job_event

object | null

Show child attributes

post_job_event

object | null

Show child attributes

cdc_engine_settings

object

Source CDC engine settings. Applicable fields depend on the source provider (PostgreSQL, Oracle, DB2 for i, etc.).

Show child attributes

permissions

object

Show child attributes

labels

string[]

license_state

string

license_message

string

pipeline_id

string

last_run

object | null

Show child attributes

created_at

string<date-time>

updated_at

string<date-time>