エクスポート¶

指定されたマスタのエクスポートジョブを実行します。

ジョブパラメータで指定したパスにマスタデータをエクスポートします。

エクスポートジョブの実行結果はジョブネットモニタから確認してください。

HTTPリクエスト
リクエストボディ
レスポンスデータ

HTTPリクエスト ¶

POST /kaiden/v2/api/generic/master/exportJob

リクエストボディ ¶

リクエストボディ情報の説明です。

プロパティ名論理名型設定デフォルト値説明

masterId マスタID string マスタIDを保持するマスタの場合、必須なし MasterBuilderのマスタIDを指定します。

extensionId マスタ拡張ID string 任意なし MasterBuilderをカスタマイズして、マスタ拡張IDを設定している場合、指定します。

gadgetClass ガジェットクラス string ガジェットクラスを保持するマスタの場合、必須なし GadgetBuilderのガジェットクラス「master」を指定します。

gadgetVariation ガジェットバリエーション string ガジェットバリエーションを保持するマスタの場合、必須なし GadgetBuilderのガジェットバリエーションを指定します。

json JSON object 任意なしエクスポートジョブのジョブパラメータをJSON形式で指定します。

json/jobParameter ジョブパラメータ object 任意「エクスポートジョブで指定可能なパラメータ」を参照

「”キー”:”値”,”キー”:”値”…」の形式で指定します。

指定可能なジョブパラメータは「エクスポートジョブで指定可能なパラメータ」および各マスタのガイドを参照してください。

リクエストボディのjsonの設定例
{
    "jobParameter":{
        "error_skip":"false",
        "lock_wait":"10",
        "company_group_set_cd":"XXX",
        "company_group_cd":"XXX",
        "company_cd":"XXX",
        "conductor":"XXX",
        "export_mode":"1",
        "target_date":"2022/01/01",
        "shift_date":"0",
        "file_path":"XXX",
        "file_mode":"1",
        "archive_path":"XXX",
        "character":"UTF-8",
        "delimiter":",",
        "enclosing":"\"",
        "header_row":"false"
    }
}

レスポンスデータ ¶

レスポンスデータはJSON情報を返却します。

処理結果が正常の場合、エクスポートジョブの起動が実行されます。

エクスポートジョブの実行結果はジョブネットモニタから確認してください。

レスポンスデータ例
{
    "statusCode":"200",
    "error":"false",
    "message":"XXX",
    "errorMessage":"XXX"
}
解説

プロパティ名論理名型説明

statusCode 処理ステータス string

200：正常終了

500：エラー終了

error 処理結果 boolean

true：エラー終了

false：正常終了

message メッセージ string 処理結果が正常終了の場合、エクスポートジョブの起動メッセージが設定されます。

errorMessage エラーメッセージ string 処理結果がエラー終了の場合、設定されます。

目次

エクスポート¶

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶

目次

プロパティ名	論理名	型	設定	デフォルト値	説明
masterId	マスタID	string	マスタIDを保持するマスタの場合、必須	なし	MasterBuilderのマスタIDを指定します。
extensionId	マスタ拡張ID	string	任意	なし	MasterBuilderをカスタマイズして、マスタ拡張IDを設定している場合、指定します。
gadgetClass	ガジェットクラス	string	ガジェットクラスを保持するマスタの場合、必須	なし	GadgetBuilderのガジェットクラス「master」を指定します。
gadgetVariation	ガジェットバリエーション	string	ガジェットバリエーションを保持するマスタの場合、必須	なし	GadgetBuilderのガジェットバリエーションを指定します。
json	JSON	object	任意	なし	エクスポートジョブのジョブパラメータをJSON形式で指定します。
json/jobParameter	ジョブパラメータ	object	任意	「エクスポートジョブで指定可能なパラメータ」を参照	「”キー”:”値”,”キー”:”値”…」の形式で指定します。指定可能なジョブパラメータは「エクスポートジョブで指定可能なパラメータ」および各マスタのガイドを参照してください。

プロパティ名	論理名	型	説明
statusCode	処理ステータス	string	200：正常終了 500：エラー終了
error	処理結果	boolean	true：エラー終了 false：正常終了
message	メッセージ	string	処理結果が正常終了の場合、エクスポートジョブの起動メッセージが設定されます。
errorMessage	エラーメッセージ	string	処理結果がエラー終了の場合、設定されます。

目次

エクスポート¶

HTTPリクエスト¶

リクエストボディ¶

レスポンスデータ¶

目次

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶