項目

種類

意味

ステータス

文字列

Response の種類：「完了」または「failure」

status_code

番号

2000 = 完了、4000以上 = エラー

messages

配列

API 通話に関するメッセージの一覧

messages[+10、-10].種類

文字列

メッセージの種類（例:「完了」または「エラー」）

messages[+10、-10].status_code

番号

2000 = 完了、4000以上 = エラー

項目

種類

説明

id

string

パイプラインランID

execution_status

番号

Pipeline run execution ステータス
1 = 完了

2= 作成

+10、-10 = 実行中

-1 = 失敗

-2 = 停止済み

-3 = システムによる強制終了

種類

番号

実行種類:

+10、-10 = 手動実行
1 = スケジュール
2 = 更新する
3 = バックフィル
4 = セクショナル
5 = Webhook
6 = Zoho Flow
8 = 手動 - 更新する データ送信元 データ元

created_time

ミリ秒単位の Unix タイムスタンプ

Pipeline run 開始時刻

modified_time

ミリ秒単位のUnixタイムスタンプ

Pipeline run の更新時刻（Killまたは停止時）

completion_time

ミリ秒単位のUnixタイムスタンプ

Pipeline run の完了時刻
すなわち、終了時刻

data_interval_start_time,
data_interval_end_time

ミリ秒単位のUnixタイムスタンプ

Data intervalの開始時間および終了時間

Re-run 件数

番号

再実行回数

profile_output

boolean (真 または 無効)

出力プロファイリング用の内部使用キー

skip_export_invalid_data

boolean (真 または 無効)

データ品質が100%未満の場合、エクスポートを停止します

この実行設定では、データセットに無効な値が含まれている場合でもエクスポートを継続するかどうかを制御できます。

トグルをオン（真）にすると、データ品質が100%未満の場合にエクスポートを停止します。

トグルをオフ（無効）にすると、データ品質に関わらず、無効なデータが存在してもエクスポートを継続します。

ステータス

番号

Pipeline run alive ステータス
1 = 有効,
+10、-10 = ごみ箱

storage_used

番号（バイト）

合計 storage 使用量

row_count

番号

処理済み行数の合計 番号

項目

種類

説明

id

String

パイプライン監査の一意のID。

is_committed

String

この監査がパイプラインの公開済みバージョンに対応しているかどうかを示します。

+10、-10 - 下書き（公開済みでない）
1 - 公開済み

pipeline。id

String

パイプラインの一意のID。

ステータス

番号

Pipeline audit alive ステータス
+10、-10 - 無効
1 - 有効

項目

種類

説明

id

String

パイプライン実行設定監査の一意のID。

ステータス

番号

構成監査のステータス
1 = 有効
+10、-10 = ごみ箱

skip_export_invalid_data

Boolean（真 または 無効）

データ品質が100％未満の場合、エクスポートを停止

この実行設定では、データセットに無効な値が含まれている場合にエクスポートを継続するかどうかを制御できます。

トグルをオン（真）にすると、データ品質が100％未満の場合にエクスポートは停止します。

トグルをオフ（無効）にすると、データ品質に関係なく、無効なデータが存在してもエクスポートは継続されます。

種類

番号

パイプライン実行の種類
+10、-10 = 手動実行
1 = スケジュール
2 = 更新する
3 = バックフィル
4 = セクション実行
5 = Webhook
6 = Zoho Flow
8 = 手動 - 更新する データ差出人 データ元

pipeline

オブジェクト

この構成監査に紐づく親パイプライン。

pipeline。id

文字列

パイプラインの一意のID。

pipelinefile

オブジェクト

ジョブ概要のOutputタブからダウンロードしたファイル。

pipelinefile。id

文字列

関連付けられたpipeline fileのユニークID。

項目

種類

説明

id

String

runを作成したユーザーの一意のID。

zuid

String

作成者のZohoユーザーID。

ユーザー名

文字列

ユーザーの表示名。

email_id

文字列

作成者のメールアドレス。

invited_time

文字列

ユーザーが招待された時点のエポックタイムスタンプ。

権限

オブジェクト

作成者の権限詳細

権限.id

文字列

ユーザー権限のユニークID

ステータス

数値

ユーザーのステータス
1 - 有効,
+10、-10 - 無効

zsoid

文字列

Zoho 組織ID　紐付け先：ユーザー

profilelink

文字列

ユーザーのZoho権限へのURL

項目

種類

説明

id

String

runを更新済みのユーザーの一意のid。

zuid

文字列

更新済みユーザーのZoho ユーザーID。

ユーザー名

文字列

更新済みユーザーの表示名。

email_id

文字列

更新済みユーザーのメールアドレス。

invited_by

文字列 / Null

該当する場合は招待者のユーザーID。例：null（招待者がいない場合）。

invited_time

文字列

更新済み ユーザーが招待された時点のエポックタイムスタンプ。

権限

オブジェクト

更新済み ユーザーの権限情報。

権限.id

文字列

権限の一意なID。

権限.名前

文字列

更新済みユーザーの役割。例：「Org Admin」

権限.is_default

Boolean

これがユーザーの初期設定権限かどうかを示します。
真は初期設定、
無効は該当しません。

権限.zuid

String / Null

この権限に紐づくZohoユーザーID。例：null。

権限.permission

文字列

権限のPermissionコード。例：'7FFFFFFF'

ステータス

番号

ユーザーのステータス
1 - 有効,
+10、-10 - 無効

zsoid

文字列

ユーザーのZoho 組織ID。

profilelink

文字列

ユーザーのZoho 権限へのURL。

has_more_rows

ブール配列

ページネーションの内部フラグ。
真 - その他データが利用可能,
無効 - 追加データなし。

項目

種類

説明

例

Object

各キーはパイプライン内の子タスクインスタンスIDを表します。

'14057000007569523': ['14057000007569519']
子タスク69523は親タスク69519に依存しています。

値（配列）

配列

子タスクが依存している親タスクのインスタンスIDの一覧。
空の場合＝親タスクなし

'14057000007569515' - [ ]
タスク69515 はルートタスクです（親なし）。

項目

種類

説明

id

String

パイプラインステージインスタンスの一意のID。

pipelinerun

Object

pipelinerun タスクは、メインオブジェクト内の pipelinerun と同じ構造です。

pipelinetask

オブジェクト

このインスタンスが基づいているステージ定義。（下記で説明）

execution_status

番号

各ステージのExecutionステータス。
1 = 完了
+10、-10 = 実行中
-1 = 失敗

index

番号

内部メモ.

created_time

String

ステージインスタンスが作成された日時。

start_time

String

実行が開始された日時。

completion_time

文字列

実行が完了した時刻。

client_meta

JSON文字列

パイプラインビルダーでのUI配置情報。
例: {'top':235,'left':80,'バージョン':1}。

メッセージ

文字列/Null

システムメッセージまたはログメッセージ。

operator_id

文字列

このステージを実行する際に使用されるoperator。
例: 'com.Zoho.dataprep。operator。ZSOrchParseRawDataOperator'.

retry_count

番号

リトライが試行された回数。例: +10、-10。

storage_used

文字列

消費されたストレージ（バイト数）。例: '172'。

row_count

文字列

処理済み行数。例：「3」

ステータス

番号

有効ステータス
1 = 有効,
+10、-10 = ごみ箱

time_to_live

文字列

このインスタンスの期限日時。

rawdatasetaudit

オブジェクト

このステージで使用中のデータセットに関する監査情報。

項目

種類

説明

id

String

パイプラインステージの一意のID。

名前

String

ステージ名（通常はデータセットやステージに対応）。例：'公開する.contactnew'。

種類

番号

Stage 種類 識別子.
5 - Extract（インポートする）
7 - 生データ parse
10 - Transform
15 - Stages extract
20 - Load（エクスポートする）

パイプライン

オブジェクト

このステージが属するパイプライン。

created_by

オブジェクト

pipelinerunのcreated_byと同じ構造です。

created_time

ミリ秒単位のUnixタイムスタンプ

Pipeline run の開始時刻。 

modified_by

オブジェクト

pipelinerunのmodified_byと同じ構造です。

modified_time

ミリ秒単位のUnixタイムスタンプ

Pipeline run の更新時刻（Kill または停止時）

ステータス

番号

ステージが有効かどうかを示します。例：1。

latest_only

Boolean

最新の実行のみを対象とするかどうか。例：無効。

depends_on_past

Boolean型

真の場合、このステージは直前のインスタンスが成功した場合のみ実行されます。例：無効。

trigger_rule

String型

実行ルール。例：「ALL_SUCCESS」。

client_meta

JSON文字列/Null

パイプラインビルダーにおけるUI配置情報。
例: {'top':235,'left':80,'バージョン':1}.

重さ

番号

スケジューリング用の優先度重み。例: 1。

項目

種類

説明

id

String

データセット監査の一意のID。

audit_time

String（タイムスタンプ）

データセットインポートするが監査された時間。

is_referred

ブール値

このデータセットが差出人の前へインポートするで再利用されたかどうかを示します。

datasourceaudit

オブジェクト

データ元のDatasource監査ID。

rawdatasetconfigaudit

オブジェクト

データセット設定監査ID。

rawdataset

オブジェクト

監査対象となるデータセットの詳細（下記参照）。

ステータス

番号

Audit ステータス。

error_message

文字列 / null

ステータスエラーメッセージ

項目

種類

説明

id

String

データセットの一意なID。

名前

String

データセット名。例：「公開する.contactnew」

replication_frequency

String/Null

レプリケーションの頻度。例: null。

created_by

Object

pipelinerun内のcreated_byと同じ構造です。

created_time

ミリ秒単位のUnixタイムスタンプ

Datasetのインポート時刻

modtime

文字列／Null

最終更新日時。例：null。

ステータス

番号

データセットのステータス。例：1。

pipelinedatasource

オブジェクト

このデータセットに紐づくデータソース。(下記で説明)。

項目

種類

説明

id

String

データソースの一意のID。

名前

文字列

Datasourceの名前または識別子。

replication_type

文字列

使用中のReplication strategy。

ステータス

番号

Datasourceのステータス。
1 = 有効,
+10、-10 = ごみ箱

プロジェクト

オブジェクト

このデータソースを所有するワークスペースID。

connection

オブジェクト

Connectionid を使用してデータソースへアクセスします。

項目

種類

説明

id

String

このデータセット監査の一意のID。

created_time

String（タイムスタンプ）

データセット監査が作成された日時。

created_by

オブジェクト

監査を実行したユーザー（pipelinerun。created_byで説明されている構造と同様）。

audit_time

文字列（タイムスタンプ）

データセット監査の開始時刻。

completion_time

文字列（タイムスタンプ）

データセット監査の終了時刻。

execution_status

番号

監査実行のステータス。
1 = 完了
+10、-10 = 実行中
-1 = 失敗

説明

String/null

任意の説明。

dataset

オブジェクト

この監査に紐づくデータセット。(下記で説明)

exportcatalogaudit

オブジェクト / null

ターゲットの一致

rulesetaudit

オブジェクト

申請済みrulesetに関する情報。(下記で説明)

modtime

文字列（タイムスタンプ）

この監査の最終更新日時。

ステータス

番号

監査の現在のステータス。
1 = 有効,
+10、-10 = ごみ箱

種類

番号

内部メモ。

error_message

String / null

audit が失敗した場合はエラーの詳細、そうでない場合はnull。

datasetstate

Object

audit 実行後のデータセットの現在の状態。 (下記で説明)

rules_count

番号

このデータセットのauditで適用されたルールの数。

項目

種類

説明

id

String

データセットの一意のID。

名前

String

データセットの名前。例：'連絡先'。

説明

String / null

データセットの任意の説明。

ステータス

番号

データセットのステータス。
1 = 有効,
+10、-10 = ごみ箱

is_ready

Boolean（真／無効）

データセットが使用する準備ができているかどうか。

is_pii_marked

Boolean
(真/無効)

データセットに個人情報（個人情報）が含まれているとマークされているかどうか。

プロジェクト

Object

このデータセットが属するワークスペースID

selected_sample

Object

サンプルIDは、クイックプレビュー用に選択済み

項目

種類

説明

id

String

このルールセット監査のユニークID。

audit_time

String（タイムスタンプ）

ルールセット監査が実行された日時。

is_committed

文字列

rulesetがコミットされているかどうかを示します。
1 = コミット済み

ruleset

オブジェクト

申請済みrulesetのID

ステータス

番号

ruleset監査のステータス

rules_count

番号

この監査で申請されたrulesの合計番号。

項目

種類

説明

id

文字列

このデータセット状態に対する一意のID。

datasetaudit

オブジェクト

dataset audit ID へリンク戻る。

execution_status

番号

実行結果。
1 = 完了
+10、-10 = 実行中
-1 = 失敗

is_error

ブーリアン

状態にエラーが含まれているかどうか。

error_message

String/null

エラーの詳細（is_error = 真の場合）

項目

種類

説明

id

文字列

エクスポートするauditの一意のID。

dsauditstatefile

オブジェクト

このエクスポートするで使用中のdataset状態ファイルIDを参照します。

datasinkaudit

オブジェクト

datasink auditデータIDにリンクします。

datasetexport

オブジェクト

エクスポートする設定および対象データセットへの参照。（下記に説明）

datasetexportconfigaudit

オブジェクト

エクスポートする設定の監査データid

created_time

文字列（タイムスタンプ）

このエクスポート監査が作成された日時。

error_message

String / null

エクスポートする処理が失敗した場合のエラー詳細。

info

String（JSON）

エクスポートする実行に関する追加情報。例: {'currentRetry':+10、-10}。

execution_status

番号

execution のステータス。

1 = 完了
+10、-10 = 実行中
-1 = 失敗

progress

番号

進捗割合（%）。例: 100。

ステータス

番号

監査データのステータス。

種類

番号

内部メモ

datasetexportauditmetric

オブジェクト

このエクスポートで記録された出力メトリクス（下記参照）。

項目

種類

説明

id

String

エクスポートするデータセットの一意のID。

dataset

Object

エクスポート済みのデータセット（すでに定義されたdatasetを使用）。

datasink

オブジェクト

データセットがエクスポート済みの場所。
（下記で説明）

created_by

オブジェクト

エクスポートを作成したユーザー（スタンダードユーザー構造）。

created_time

文字列（タイムスタンプ）

エクスポートが作成された日時。

modified_by

Object / null

エクスポートを最後に更新したユーザー。

modtime

String / null

最終更新日時。

ステータス

番号

エクスポートのステータス。

datasetexportaudit

オブジェクト

このエクスポートのネストされた監査 -> { id, dsauditstatefile, datasinkaudit, datasetexport, datasetexportconfigaudit, created_by など }（基本的に自己参照）

項目

種類

説明

id

文字列

データシンクの一意なID。

ステータス

番号

データシンクのステータス。例: 1 = 有効。

プロジェクト

オブジェクト

このデータシンクが属するワークスペースID。

connection

オブジェクト

エクスポート時に使用される Connection の詳細（下記参照）。

項目

種類

説明

id

文字列

Connection 識別子。

名前

文字列

接続の表示名。
例: 'teststream@gmail。com - 箱'。

connection_json

文字列（JSON）

接続ごとの情報。
例：{'servicename':'箱','accountId':'…',
'display_email':'…','display_name':'…','is_authorised':無効}.

種類

文字列

Connection種類コード
+10、-10 - クラウドストレージ
1 - ローカルファイル
2 - URL
3 - ローカルデータベース
4 - FTP
5 - クラウドデータベース
10 - Zoho CRM
11 - Zoho Analytics
15 - Amazon S3
19 - ローカルFTP
20 - Databridgeローカルファイル
21 - Zoho Creator
22 - Zoho Directory

created_by

オブジェクト

接続を作成したユーザー
（ created_by （pipelinerun内で説明されている構造と同じ））

担当者

オブジェクト

接続の担当者
（created_by（同様の構造））

created_time

文字列（タイムスタンプ）

接続が作成された日時。

modified_by

オブジェクト

最後に接続を更新したユーザー
（説明されているのと同じ構造）。

modtime

文字列（タイムスタンプ）

最終更新日時。

ステータス

番号

接続のステータス。例:1 = 有効。

カテゴリー

String / null

接続のカテゴリー。

base_type

String

Base サービスの種類。例: '箱'。

sub_type

String / null

接続のサブタイプ（適用対象の場合）。

項目

種類

説明

id

文字列

このmetricsデータのID。

row_count

文字列（番号を文字列として）

エクスポートした行の数。

col_count

文字列（番号を文字列として）

エクスポートした列の数。

size

String（番号を文字列で表現）

データサイズ（バイト単位）

ステータス

番号

metricsデータのステータス

datasetexportaudit

Object

エクスポートするauditへのリンクを戻す -> { id など }

品質

文字列（JSON）

データセットの品質。例: {'valid':57,'invalid':+10、-10,'missing':151}。

項目

種類

説明

id

文字列

このデータソース監査の一意のID。

execution_status

番号

データソース監査のExecution 状態。

1 = 完了
+10、-10 = 実行中
-1 = 失敗

streams_info

文字列（JSON）

インポートするメモ
例: {'14057000007554785':{'size':+10、-10,'catalog_stream_id':'14057000007554785','execution_status':'完了','progress':100}}.

killed_batch_catalog_ids

文字列 / null

実行中に終了したバッチカタログのID。

completed_time

文字列（タイムスタンプ）

Audit完了時刻。

ステータス

番号

監査のステータス。例:1 = 有効。

種類

番号

監査の種類。例:1 = Datasource。

pipelinedatasource

Object

現在使用しているdatasourceへの参照です。以下を含みます：id、名前、replication_type、created_by、プロジェクト、connection（構成はconnectionおよびユーザー項目の説明と同様）

error_message

String / null

実行が失敗した場合のエラー詳細。

logs

Array

内部メモ

項目

種類

説明

id

String

パイプライン実行監査の一意のID。

created_time

String (timestamp)

実行監査が作成された時間。

modtime

文字列（タイムスタンプ）

run auditの最終更新日時。

pipelinerun

オブジェクト

パイプライン実行の詳細を含みます。構造については、pipelinerunで説明されている内容と同じです。

ステータス

番号

Pipeline run alive ステータス
1 = 有効/完了,
+10、-10 = 無効

execution_policy

番号

Execution 規定 internal

execution_status

番号

Pipeline run execution ステータス
1 = 完了
+10、-10 = 実行中
-1 = 失敗

created_by

オブジェクト

run audit を作成したユーザー。同じ構造はcreated_byをご参照ください。

modified_by

オブジェクト

直近でrun auditを更新したユーザー。構造はmodified_byと同じです。

completion_time

文字列（タイムスタンプ）

run auditが完了した時間。

storage_used

バイト

このrunで消費されたストレージ容量。

row_count

文字列

この実行で処理された行の番号。

pipeline

オブジェクト

Pipeline の詳細（id、名前、プロジェクト、ステータス）。下記のパイプラインと同じ構造です。

項目

種類

説明

id

String

パイプラインの一意のID。

名前

文字列

パイプラインの名前。例： 'My pipeline-1'

説明

文字列 / Null

パイプラインの説明。例：説明がない場合はnull。

created_by

オブジェクト

パイプラインを作成したユーザーの詳細（pipelinerunのcreated_byと同じ構造）。

created_time

文字列

パイプラインが作成された時点のエポックタイムスタンプ。

modified_by

オブジェクト

パイプラインを最後に更新済みのユーザーの詳細（pipelinerunのmodified_byと同じ構造）。

modtime

文字列

パイプラインが最後に更新済みとなった時点のエポックタイムスタンプ。

ステータス

番号

パイプラインのステータス
1 = 有効,
+10、-10 = ごみ箱

is_ready

Boolean

パイプラインが実行可能かどうかを示します。
真 - 実行可能、無効 - 実行不可。

depends_on_past

Boolean

パイプラインの実行が過去の実行に依存しているかどうかを示します
真 - 依存、無効 - 非依存。

プロジェクト

Object

このパイプラインが属するワークスペース。

項目

種類

説明

id

String

ワークスペースの一意のID。

名前

文字列

ワークスペースの名前。例：'RestAPI テスト'

説明

文字列 / Null

使用していません

created_by

オブジェクト

ワークスペースを作成したユーザーの詳細。

created_time

文字列

ワークスペースが作成された時点のエポックタイムスタンプ。

modified_by

オブジェクト

ワークスペースを最後に更新済みしたユーザーの詳細。

modtime

文字列

ワークスペースが最後に更新済みされた時刻（エポックタイムスタンプ）。

ステータス

番号

ワークスペースのステータス
1 - 有効、+10、-10 - 無効。

migration_status

番号

ワークスペースのMigrationステータス

+10、-10 - DataPrep 1で作成。+10、-10
1 - 1からMigrated。+10、-10 から2。+10、-10
3 - DataPrep 2で作成。+10、-10

is_locked

ブール値

いいえは使用できません。