List All Jobs - CData Sync Documentation

Error

A valid request URL is required to generate request examples

{
  "value": [
    {
      "JobName": "<string>",
      "JobId": "<string>",
      "WorkspaceId": "<string>",
      "Source": "<string>",
      "Destination": "<string>",
      "Scheduled": "<string>",
      "ScheduledCron": "<string>",
      "NotifyWindowsEvent": "<string>",
      "SendEmailNotification": "<string>",
      "NotifyEmailTo": "<string>",
      "NotifyEmailSubject": "<string>",
      "EmailErrorOnly": "<string>",
      "Verbosity": "<string>",
      "TableNamePrefix": "<string>",
      "UseGmtDateTime": "<string>",
      "TruncateTableData": "<string>",
      "DropTable": "<string>",
      "AutoTruncateStrings": "<string>",
      "ContinueOnError": "<string>",
      "AlterSchema": "<string>",
      "ReplicateInterval": "<string>",
      "ReplicateIntervalUnit": "<string>",
      "ReplicateStartDate": "<string>",
      "BatchSize": "<string>",
      "CommandTimeout": "<string>",
      "DeletionBehavior": "<string>",
      "OtherCacheOptions": "<string>",
      "CacheSchema": "<string>",
      "PreJob": "<string>",
      "PostJob": "<string>",
      "StatusConnection": "<string>",
      "Type": "<string>",
      "EnableParallelProcessing": "<string>",
      "AutomaticJobRetry": "<string>",
      "WorkerPool": "<string>",
      "RowVersion": 123,
      "LogicalReplicationSlot": "<string>",
      "HistoryMode": "<string>",
      "Label#": "<string>",
      "WithHistory": "<string>",
      "HistoryId": "<string>",
      "ResetStrategy": "<string>",
      "LicenseState": "<string>",
      "LicenseMessage": "<string>",
      "PublicationName": "<string>",
      "PluggableDatabase": "<string>",
      "AdditionalCDCEngineProperties": "<string>",
      "InsertMode": "<string>",
      "TableNameSuffix": "<string>",
      "LoadFolderFileNamePattern": "<string>",
      "SkipFormulaFields": true,
      "SourceSchema": "<string>",
      "JournalLibrary": "<string>",
      "JournalName": "<string>",
      "SnapshotSize": 123,
      "SkipSnapshot": true,
      "CDCEngineModeEnabled": true,
      "CanUpdate": "<string>",
      "CanRemove": "<string>",
      "CanExecute": "<string>"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

GET

jobs

Error

A valid request URL is required to generate request examples

{
  "value": [
    {
      "JobName": "<string>",
      "JobId": "<string>",
      "WorkspaceId": "<string>",
      "Source": "<string>",
      "Destination": "<string>",
      "Scheduled": "<string>",
      "ScheduledCron": "<string>",
      "NotifyWindowsEvent": "<string>",
      "SendEmailNotification": "<string>",
      "NotifyEmailTo": "<string>",
      "NotifyEmailSubject": "<string>",
      "EmailErrorOnly": "<string>",
      "Verbosity": "<string>",
      "TableNamePrefix": "<string>",
      "UseGmtDateTime": "<string>",
      "TruncateTableData": "<string>",
      "DropTable": "<string>",
      "AutoTruncateStrings": "<string>",
      "ContinueOnError": "<string>",
      "AlterSchema": "<string>",
      "ReplicateInterval": "<string>",
      "ReplicateIntervalUnit": "<string>",
      "ReplicateStartDate": "<string>",
      "BatchSize": "<string>",
      "CommandTimeout": "<string>",
      "DeletionBehavior": "<string>",
      "OtherCacheOptions": "<string>",
      "CacheSchema": "<string>",
      "PreJob": "<string>",
      "PostJob": "<string>",
      "StatusConnection": "<string>",
      "Type": "<string>",
      "EnableParallelProcessing": "<string>",
      "AutomaticJobRetry": "<string>",
      "WorkerPool": "<string>",
      "RowVersion": 123,
      "LogicalReplicationSlot": "<string>",
      "HistoryMode": "<string>",
      "Label#": "<string>",
      "WithHistory": "<string>",
      "HistoryId": "<string>",
      "ResetStrategy": "<string>",
      "LicenseState": "<string>",
      "LicenseMessage": "<string>",
      "PublicationName": "<string>",
      "PluggableDatabase": "<string>",
      "AdditionalCDCEngineProperties": "<string>",
      "InsertMode": "<string>",
      "TableNameSuffix": "<string>",
      "LoadFolderFileNamePattern": "<string>",
      "SkipFormulaFields": true,
      "SourceSchema": "<string>",
      "JournalLibrary": "<string>",
      "JournalName": "<string>",
      "SnapshotSize": 123,
      "SkipSnapshot": true,
      "CDCEngineModeEnabled": true,
      "CanUpdate": "<string>",
      "CanRemove": "<string>",
      "CanExecute": "<string>"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

$select

string

A comma-separated list of properties to include in the results. When this field is left empty, all properties will be returned.

$orderby

string

Order the results by this property in ascending or descending order. Example for ascending: 'Name ASC' Example for descending: 'Name DESC'

$top

integer

The number of results to return.

$skip

integer

This is the offset of results to skip when returning results.

$count

boolean

When set, the results will return a count of results and not the actual results.

$filter

string

Use this to filter the results by specific property values. For example, you can use the following filter to retrieve records with the name 'John': $filter=Name eq 'John'

Response

jobs response

value

object[]

Show child attributes

List all table columns Get job details

⌘I