ジョブ管理API


ジョブ管理API


ジョブの管理

REST API は、次のジョブ管理アクションをサポートしました。

すべてのジョブをリスト

Sync アプリケーション内のすべてのジョブのリストを返します。

GET http://mydomain.com:8019/api.rsc/jobs(jobname)

クエリパラメータ

名前 説明
JobName 取得するジョブの名前。

ジョブを作成

Sync アプリケーションで実行する新しいジョブを作成します。

POST http://mydomain.com:8019/api.rsc/jobs

ボディパラメータ

名前 説明
JobName ジョブ名。
Source ソースの接続名。
Destination 同期先の接続名。
Scheduled 特定のスケジューラーに従ってジョブを実行できるようにするには、これをtrue に設定します。
ScheduledCron スケジューラーのcron 文字列。
NotifyWindowsEvent エラーメッセージをWindows アプリケーション イベントログに書き込むには、これをtrue に設定します。
SendEmailNotification ジョブの完了後にE メール通知を送信するには、これをtrue に設定します。
NotifyEmailTo 通知E メールの送信先アドレス。
NotifyEmailSubject 通知E メールの件名。
EmailErrorOnly エラー時にのみメールを送信します。
Verbosity ジョブのログのverbosity レベル。
TableNamePrefix レプリケートされたすべてのテーブルのプレフィックス。
UseGmtDateTime 現地時間ではなくGMT タイムゾーンで時刻を同期するには、これをtrue に設定します。
TruncateTableData 各更新の前にすべての行を削除するには、これをtrue に設定します。
DropTable 各更新の前にテーブルを削除するには、これをtrue に設定します。
AutoTruncateStrings カラムサイズに対して大きすぎる文字列を自動的に切り捨てるには、これをtrue に設定します。
ContinueOnError 前のテーブルがエラーをスローしたときに次のテーブルに進むには、これをtrue に設定します。
AlterSchema これをtrue に設定すると、同期元テーブルと同期先テーブルのメタデータに不一致があった場合は、カラムを追加してデータ型を変更します。
ReplicateInterval ReplicateIntervalUnit とペアで設定すると、ReplicateInterval はレプリケート時にデータを分割するタイムフレームを制御します。
ReplicateIntervalUnit ReplicateInterval とペアで設定すると、ReplicateIntervalUnit はレプリケート時にデータを分割するタイムフレームを制御します。値は、minutes、hours、days、weeks、months、years です。
ReplicateStartDate このオプションは、データの複製を開始する最小の日付(yyyy-MM-dd)を設定します。
BatchSize バッチのサイズを設定します。
CommandTimeout 同期先の接続のタイムアウトを制御します。
SkipDeleted 同期元から削除されたレコードの取得をスキップするかどうか。
OtherCacheOptions 含める追加オプションのカンマ区切りのリスト。
CacheSchema 同期先データベースの特定のスキーマを割り当てます。
PreJob Pre-Job イベントのコード。
PostJob Post-Job イベントのコード。
Query# ジョブに含めるSQL ステートメントの配列。
{ 
  "JobName": "MyNewJob", 
  "Source": "SourceConnection",
  "Destination": "DestinationConnection",
  "Query#1":"REPLICATE [Accounts]",
  "Query#2": "REPLICATE [Invoices]"
}

ジョブを編集

既存のジョブを編集します。実行中のジョブを編集することはできません。

PUT http://mydomain.com:8019/api.rsc/jobs(jobname)

クエリパラメータ

名前 説明
JobName(必須) 編集するジョブの名前。

ボディパラメータ

名前 説明
Scheduled 特定のスケジューラーに従ってジョブを実行できるようにするには、これをtrue に設定します。
ScheduledCron スケジューラーのcron 文字列。
NotifyWindowsEvent エラーメッセージをWindows アプリケーション イベントログに書き込むには、これをtrue に設定します。
SendEmailNotification ジョブの完了後にE メール通知を送信するには、これをtrue に設定します。
NotifyEmailTo 通知E メールの送信先アドレス。
NotifyEmailSubject 通知E メールの件名。
EmailErrorOnly エラー時にのみメールを送信します。
Verbosity ジョブのログのverbosity レベル。値は1,2,3,5 です。
TableNamePrefix レプリケートされたすべてのテーブルのプレフィックス。
UseGmtDateTime 現地時間ではなくGMT タイムゾーンで時刻を同期するには、これをtrue に設定します。
TruncateTableData 各更新の前にすべての行を削除するには、これをtrue に設定します。
DropTable 各更新の前にテーブルを削除するには、これをtrue に設定します。
AutoTruncateStrings カラムサイズに対して大きすぎる文字列を自動的に切り捨てるには、これをtrue に設定します。
ContinueOnError 前のテーブルがエラーをスローしたときに次のテーブルに進むには、これをtrue に設定します。
AlterSchema これをtrue に設定すると、同期元テーブルと同期先テーブルのメタデータに不一致があった場合は、カラムを追加してデータ型を変更します。
ReplicateInterval ReplicateIntervalUnit とペアで設定すると、ReplicateInterval はレプリケート時にデータを分割するタイムフレームを制御します。
ReplicateIntervalUnit ReplicateInterval とペアで設定すると、ReplicateIntervalUnit はレプリケート時にデータを分割するタイムフレームを制御します。値は、minutes、hours、days、weeks、months、years です。
ReplicateStartDate このオプションは、データの複製を開始する最小の日付(yyyy-MM-dd)を設定します。
BatchSize バッチのサイズを設定します。
CommandTimeout 同期先の接続のタイムアウトを制御します。
SkipDeleted 同期元から削除されたレコードの取得をスキップするかどうか。
OtherCacheOptions 含める追加オプションのカンマ区切りのリスト。
CacheSchema 同期先データベースの特定のスキーマを割り当てます。
PreJob Pre-Job イベントのコード。
PostJob Post-Job イベントのコード。
{ 
  "Scheduled": "true",
  "ScheduledCron": "0-30/5 * * * *"
}

ジョブを削除

Sync アプリケーションからジョブを削除します。実行中のジョブを削除することはできません。

DELETE http://mydomain.com:8019/api.rsc/jobs(jobname)

クエリパラメータ

名前 説明
JobName 削除するジョブの名前。

すべての変換をリスト

Returns a list of all Transformations within the Sync application.

GET http://mydomain.com:8019/api.rsc/transformations(transformationname)

クエリパラメータ

名前 説明
TransformationName Name of the Transformation to retrieve.

変換を作成

Create a new Job to run in the Sync application.

POST http://mydomain.com:8019/api.rsc/transformations

ボディパラメータ

名前 説明
TransformationName The name of the transformation.
Connection The name of the Destination connection.
TransformationTriggerMode Whether to run the transformation on a schedule or after a job. Defaults to None. Values are None, Scheduled, AfterJob
TriggerAfterJob The specified job the transformation will run after.
TriggerTasks A comma separated list of Task Ids.
ScheduledCron The scheduler cron string.
SendEmailNotification Set this to true to send email notifications after transformations are completed.
NotifyEmailTo The email address where notifications will be sent to.
NotifyEmailSubject The email subject for notifications.
EmailErrorOnly Only send an email on error.
Verbosity The log verbosity level of the transformation.
Query# An array of SQL statements to include in the Transformation.
{ 
  "TransformationName": "MyNewTransformation", 
  "Connection": "DestinationConnection",
  "Query#1":"CREATE OR REPLACE TABLE dbo.Accounts_Deduplicated as (SELECT *, row_number() over (partition by id order by modified desc) as duplicate_rank FROM dbo.Accounts);",
  "Query#2": "DELETE FROM dbo.Accounts_Deduplicated	WHERE duplicate_rank > 1;"
}

変換を編集

Modifies an Existing Transformation. You are unable to modify a Transformation that is currently running.

PUT http://mydomain.com:8019/api.rsc/transformations(transformationname)

クエリパラメータ

名前 説明
TransformationName(必須) Name of the Transformation to modify.

ボディパラメータ

名前 説明
TransformationTriggerMode Whether to run the transformation on a schedule or after a job. Defaults to None. Values are None, Scheduled, AfterJob
TriggerAfterJob The specified job the transformation will run after.
TriggerTasks A comma separated list of Task Ids.
ScheduledCron The scheduler cron string.
SendEmailNotification Set this to true to send email notifications after transformations are completed.
NotifyEmailTo The email address where notifications will be sent to.
NotifyEmailSubject The email subject for notifications.
EmailErrorOnly Only send an email on error.
Verbosity The log verbosity level of the transformation.
{ 
  "TransformationTriggerMode": "Scheduled",
  "ScheduledCron": "0-30/5 * * * *"
}

変換を削除

Remove a Transformation from the Sync application. You are unable to delete a Transformation that is currently running.

DELETE http://mydomain.com:8019/api.rsc/transformations(transformationname)

クエリパラメータ

名前 説明
TransformationName(必須) Name of the Transformation to Delete.

ジョブを実行

指定されたジョブまたは変換の実行を開始します。

POST http://mydomain.com:8019/api.rsc/executeJob

ボディパラメータ

名前 説明
JobName(必須) 実行するジョブの名前。
WaitForResults Whether to wait until the Job ends to return results. Defaults to true.
Timeout How long to wait in seconds for the previous Job execution to complete.
{
  "JobName": "MyJob"
  "WaitForResults" : true,
  "Timeout": 30
}

ジョブでクエリを実行

ジョブ内で特定のクエリの実行を開始します。クエリはすでにジョブの一部である必要があります。

POST http://mydomain.com:8019/api.rsc/executeQuery

ボディパラメータ

名前 説明
JobName(必須) 実行するジョブの名前。
Query#(必須) 実行するQuery ステートメントの配列。Query#1、Query#2 などの構文で複数のクエリを指定。
WaitForResults Whether to wait until the Job ends to return results. Defaults to true.
{
  "JobName": "MyJob",
  "Query#1": "REPLICATE [Accounts]",
  "Query#2": "REPLICATE [Contacts]"
}

ジョブをキャンセル

実行中のジョブをキャンセルします。ジョブはすでに実行中である必要があります。

POST http://mydomain.com:8019/api.rsc/cancelJob

ボディパラメータ

名前 説明
JobName(必須) キャンセルするジョブの名前。
{
  "JobName": "MyJob"
}

ジョブステータスを取得

ジョブのステータスを取得します。

POST http://mydomain.com:8019/api.rsc/getJobStatus

ボディパラメータ

名前 説明
JobName ステータスを取得するジョブの名前。指定した場合、応答には、ジョブ内の各クエリの詳細が含まれます。
{
  "JobName":"MyJob"
}

ジョブの履歴を取得

ジョブの以前の実行の履歴を取得します。

GET http://mydomain.com:8019/api.rsc/history

クエリパラメータ

名前 説明
JobName 履歴を取得するジョブの名前。

ジョブのログをダウンロード

ジョブのログファイルのBase64 エンコードされたコンテンツをダウンロードします。

POST http://mydomain.com:8019/api.rsc/getLogs

ボディパラメータ

名前 説明
JobName(必須) ログを取得するジョブの名前。
Days(必須) 含めるログファイルの日数。

タスクをリスト

Retrieve a list of tasks associated with a Job or Transformation

GET http://mydomain.com:8019/api.rsc/tasks(jobname)

クエリパラメータ

名前 説明
JobName(必須) ジョブの名前。

タスクを追加

Add a task to an existing Job or Transformation. Either Query or Table is required.

POST http://mydomain.com:8019/api.rsc/tasks

ボディパラメータ

名前 説明
JobName(必須) Name of the Job.
Query The query to set as the Task
Table The source table to Replicate. Sync will create a Replicate Query from this input.

タスクを編集

Update a task in an existing Job or Transformation.

PUT http://mydomain.com:8019/api.rsc/tasks

ボディパラメータ

名前 説明
JobName(必須) Name of the Job.
TaskId(必須) The task to update.
Query The query to set as the Task
Table The source table to Replicate. Sync will create a Replicate Query from this input.

タスクを削除

Delete a task from an existing Job or Transformation.

DELETE http://mydomain.com:8019/api.rsc/tasks

クエリパラメータ

名前 説明
JobName(必須) Name of the Job.
TaskId(必須) The task to delete.