REST APIリファレンス

前へ次へ

activityLog

このリソースを使用して、モニタサービスから完了したジョブのログ情報を要求します。また、エラーログやセッションログを要求することもできます。実行中のジョブのログ情報を要求するには、activityMonitorリソースを使用します。

GET要求

すべてのログの情報を要求するか、ログの応答をフィルタできます。ログからの情報を要求するには、次のURIを使用します。

/api/v2/activity/activityLog

特定のログIDに関する情報を要求するには、次のURIを使用します。

/api/v2/activity/activityLog/<id>

特定の実行IDに関する情報を要求するには、次のURIを使用します。

/api/v2/activity/activityLog?runId=<runId>

特定のタスクに関する情報を要求するには、タスクIDを次のURIに含めます。

/api/v2/activity/activityLog?taskId=<taskId>

スキップする行数を指定するには、次のURIを使用します。

/api/v2/activity/activityLog?offset=<offset>

行制限を指定するには、次のURIを使用します。

/api/v2/activity/activityLog?rowLimit=<rowLimit>

上記のオプションは組み合わせて使用することができます。例えば、次のようなURIを使用できます。

/api/v2/activity/activityLog?offset=<offset>&rowLimit=<rowLimit>&taskId=<taskId>&runId=<runId>

activityLogリソースを使用して、セッションログを取得することもできます。セッションログを取得するには、次のURIを使用します。

/api/v2/activity/activityLog/<id>/sessionLog

activityLogのGET URIには、オプションで次の属性を使用できます。

フィールド	説明
id	ログのエントリID。特定のIDに関する情報を受け取る場合は、この属性を追加します。
runId	ログのエントリIDに関連付けられたジョブID。
taskId	ログのエントリIDに関連付けられたタスクID。taskIdが指定されていない場合、すべてのタスクのactivityLogエントリがすべて返されます。
offset	スキップする行数。例えば、最初の3行をスキップする場合に使用します。
rowLimit	返す最大行数。指定可能な最大数値は1000です。この属性を省略すると、activityLogは使用可能な行をすべて返します（最大200行）。

GET応答

ログ内の各行に対するactivityLogEntryオブジェクト、または特定のIDに対するactivityLogEntryオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。

ログの各行に関する情報を要求する場合、activityLogEntryオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
id	String	ログのエントリID。
type	String	タスクのタイプ。データ統合では、次のいずれかのコードを返します。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 DSS。同期タスク。 MTT。マッピングタスク。 PCS。PowerCenterタスク。 WORKFLOW。リニアタスクフロー。
objectId	String	タスクID。
objectName	String	タスクの名前。
runId	Long	タスクの実行に必要なID。
agentId	String	タスクを実行するエージェント。
runtimeEnvironmentId	String	タスクを実行するランタイム環境。
startTime	Date/Time	タスクまたはリニアタスクフローの開始時刻。東部標準時（ET）を使用します。
endTime	Date/Time	タスクまたはリニアタスクフローの終了時刻。東部標準時（ET）を使用します。
startTimeUtc	Date/Time	タスクまたはリニアタスクフローの開始時刻。協定世界時（UTC）を使用します。
endTimeUtc	Date/Time	タスクまたはリニアタスクフローの終了時刻。協定世界時（UTC）を使用します。
state	Short	タスクが正常に完了したかどうかを示します。次のいずれかのコードを返します。 1. タスクが正常に完了しました。 2. タスクは完了しましたが、エラーが発生しました。 3. タスクを完了できませんでした。
failedSourceRows	Long	ソースから読み込まれなかった行の数。
successSourceRows	Long	ソースからの読み込みに成功した行の数。
failedTargetRows	Long	ターゲットに書き込まれなかった行の合計数。
successTargetRows	Long	ターゲットへの書き込みに成功した行の数。
scheduleName	String	スケジュール名（タスクがスケジュールによって開始された場合）。
entries		子オブジェクトに関する情報の開始を示します。

特定のIDに関するログ情報を要求する場合、activityLogEntryオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
id	String	ログのエントリID。
type	String	タスクのタイプ。データ統合では、次のいずれかのコードを返します。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 DSS。同期タスク。 MTT。マッピングタスク。 PCS。PowerCenterタスク。 WORKFLOW。リニアタスクフロー。
objectId	String	タスクID。
objectName	String	タスクの名前。
runId	String	タスクの実行に必要なID。
agentId	String	タスクを実行するエージェント。
runtimeEnvironmentId	String	タスクを実行するランタイム環境。
startTime	Date/Time	タスクまたはリニアタスクフローの開始時刻。東部標準時（ET）を使用します。
endTime	Date/Time	タスクまたはリニアタスクフローの終了時刻。東部標準時（ET）を使用します。
startTimeUtc	Date/Time	タスクまたはリニアタスクフローの開始時刻。協定世界時（UTC）を使用します。
endTimeUtc	Date/Time	タスクまたはリニアタスクフローの終了時刻。協定世界時（UTC）を使用します。
state	Short	タスクが正常に完了したかどうかを示します。次のいずれかのコードを返します。 1. タスクが正常に完了しました。 2. タスクは完了しましたが、エラーが発生しました。 3. タスクを完了できませんでした。 4. タスクは開始されていません。
UIState	Short	内部目的でのみ使用されます。
isStopped	Boolean	タスクがユーザーによって停止されたかどうか。タスクがエラーありで完了したか、完了できなかった場合、値が true になる可能性があります。
failedSourceRows	Long	ソースから読み込まれなかった行の数。
successSourceRows	Long	ソースからの読み込みに成功した行の数。
failedTargetRows	Long	ターゲットに書き込まれなかった行の合計数。
successTargetRows	Long	ターゲットへの書き込みに成功した行の数。
errorMsg	String	ジョブに関連付けられているエラーメッセージ。
startedBy	String	タスクを開始したユーザー。
runContextType	String	タスクの開始時に使用されたメソッド。次の値が含まれます。 UI。タスクがユーザーインタフェースを使用して開始されました。 SCHEDULER。タスクがタスクスケジューラを使用して開始されました。 REST API。タスクがREST APIを使用して開始されました。 OUTBOUND MESSAGE。タスクが送信メッセージを使用して開始されました。
scheduleName	String	スケジュール名（タスクがスケジュールによって開始された場合）。
orgId	String	組織ID。
totalSuccessRows	Long	ソースから正常に読み取られた行およびターゲットへ正常に書き込まれた行の合計数。
totalFailedRows	Long	ソースから読み取られなかった行およびターゲットへ正常に書き込まれなかった行の合計数。
logFilename	String	生成されるログファイルの名前。
errorFilename	String	生成されるエラーファイルの名前。
errorFileDir	String	Secure Agentマシン上のエラーファイルの場所。
connType	String	接続タイプ。
stopOnError	Boolean	致命的でないエラーが発生した場合に取るランタイム環境のアクションを決定します。次の値が含まれます。 True。エラーが発生した場合にリニアタスクフローが停止します。 False。エラーが発生した場合でもリニアタスクフローが処理を継続します。
items		各タスクのactivityLogEntryItemオブジェクトを含みます。
type	String	activityLogEntryItemオブジェクトに含まれています。タスクのタイプ。データ統合では、次のいずれかのコードを返します。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 DSS。同期タスク。 MTT。マッピングタスク。 PCS。PowerCenterタスク。 WORKFLOW。リニアタスクフロー。
objectId	String	activityLogEntryItemオブジェクトに含まれています。タスクID。
objectName	String	activityLogEntryItemオブジェクトに含まれています。タスクの名前。
runId	String	activityLogEntryItemオブジェクトに含まれています。タスクの実行に必要なID。
agentId	String	activityLogEntryItemオブジェクトに含まれています。タスクを実行したエージェント。
runtimeEnvironmentId	String	activityLogEntryItemオブジェクトに含まれています。タスクを実行したランタイム環境。
startTime	Date/Time	activityLogEntryItemオブジェクトに含まれています。タスクまたはリニアタスクフローの開始時刻。東部標準時（ET）を使用します。
endTime	Date/Time	activityLogEntryItemオブジェクトに含まれています。タスクまたはリニアタスクフローの終了時刻。東部標準時（ET）を使用します。
state	String	activityLogEntryItemオブジェクトに含まれています。タスクが正常に完了したかどうかを示します。次のいずれかのコードを返します。 1. タスクが正常に完了しました。 2. タスクは完了しましたが、エラーが発生しました。 3. タスクを完了できませんでした。
isStopped	Boolean	タスクがユーザーによって停止されたかどうか。タスクがエラーありで完了したか、完了できなかった場合、値が true になる可能性があります。
errorMsg	String	activityLogEntryItemオブジェクトに含まれています。ジョブに関連付けられているエラーメッセージ。
connType	String	activityLogEntryItemオブジェクトに含まれています。接続タイプ。
children	String	activityLogEntryItemオブジェクトに含まれています。リニアタスクフローで各テーブルのactivityLogEntryItemオブジェクトを返します。
startedBy	String	タスクを開始したユーザー。
runContextType	String	タスクの開始時に使用されたメソッド。次の値が含まれます。 UI。タスクがユーザーインタフェースを使用して開始されました。 SCHEDULER。タスクがタスクスケジューラを使用して開始されました。 REST API。タスクがREST APIを使用して開始されました。 OUTBOUND MESSAGE。タスクが送信メッセージを使用して開始されました。
scheduleName	String	スケジュール名（タスクがスケジュールによって開始された場合）。
transformationEntries		各トランスフォーメーションのtransformationLogEntryオブジェクトにある情報を含みます。
id	String	transformationLogEntryオブジェクトに含まれています。トランスフォーメーションID。
txName	String	transformationLogEntryオブジェクトに含まれています。トランスフォーメーション名。ターゲットトランスフォーメーションの場合、ターゲットオブジェクト名を返します。
txType	String	transformationLogEntryオブジェクトに含まれています。トランスフォーメーションタイプ。
successRows	Long	transformationLogEntryオブジェクトに含まれています。トランスフォーメーションで成功した行の数。
affectedRows	長整数型	transformationLogEntryオブジェクトに含まれています。定義されたタスク操作の影響を受ける行の数。データ転送タスクのターゲットトランスフォーメーション、および完全なSQL ELTの最適化用に接続されていないマッピングに基づくマッピングタスクに適用されます。SQL ELTモードのマッピングまたは詳細マッピングには適用されません。
failedRows	Long	transformationLogEntryオブジェクトに含まれています。トランスフォーメーションで失敗した行の数。
sequenceValues		シーケンスジェネレータトランスフォーメーションを含むタスクから生成された情報を返します。各トランスフォーメーションのsequenceValueLogEntryオブジェクトを含みます。
txName	String	sequenceValueLogEntryオブジェクトに含まれています。トランスフォーメーション名。ターゲットトランスフォーメーションの場合、ターゲットオブジェクト名を返します。
nextValue	String	sequenceValueLogEntryオブジェクトに含まれています。タスクで生成される最後の値。
inOutParameterValues		タスクで使用される入出力パラメータの値。各パラメータのinOutParameterValueLogEntryを含みます。
name	String	inOutParameterValueLogEntryオブジェクトに含まれています。パラメータ名。
value	String	inOutParameterValueLogEntryオブジェクトに含まれています。パラメータ値。

GETの例

JSON形式のログから返された情報を20行要求するには、次の要求を使用できます。

GET <serverUrl>/api/v2/activity/activityLog?rowLimit=20 HTTP/1.0
Accept:application/json
icSessionId: <icSessionId>

要求が正常に実行されると、ログから返された各エントリのactivityLogEntryオブジェクトのリストが返されます。

次のテキストは、JSON形式で返されたリストのサンプルです。

[
    {
        "@type": "activityLogEntry",
        "id": "000001C100000000000C",
        "type": "DRS",
        "objectName": "drstask1",
        "runId": 1,
        "runtimeEnvironmentId": "00000C25000000000002",
	       "startTime": "2012-07-30T13:30:30.000Z",
        "endTime": "2012-07-30T13:32:30.000Z",
        "state": 1,
        "failedSourceRows": 0,
        "successSourceRows": 39,
        "failedTargetRows": 0,
        "successTargetRows": 39,
        "errorMsg": null,
        "entries": [
            {
                "@type": "activityLogEntry",
                "id": "128964732",
                "type": "DRS",
                "objectName": "Contact",
                "runId": 0,
                "runtimeEnvironmentId": "00000C25000000000002",
                "agentId: "01000008000000000006",
                "startTime": "2012-07-30T13:32:31.000Z",
                "endTime": "2012-07-30T13:35:31.000Z",
                "state": 1,
                "isStopped": FALSE,
                "failedSourceRows": 0,
                "successSourceRows": 39,
                "failedTargetRows": 0,
                "successTargetRows": 39,
                "errorMsg": "No errors encountered.",
                "entries": []
            },
        ]
    },
    {
        "@type": "activityLogEntry",
        "id": "010000C1000000000PGP",
        "type": "MTT_TEST",
        "objectId": "0100000Z00000000001N",
        "objectName": "Mapping-MultiSource",
        "runId": 12,
        "startTime": "2020-03-27T08:05:56.000Z",
        "endTime": "2020-03-27T08:06:07.000Z",
        "startTimeUtc": "2020-03-27T12:05:56.000Z",
        "endTimeUtc": "2020-03-27T12:06:07.000Z",
        "state": 2,
        "failedSourceRows": 0,
        "successSourceRows": 800,
        "failedTargetRows": 200,
        "successTargetRows": 600,
        "startedBy": "di@infa.com",
        "runContextType": "ICS_UI",
        "entries": [
            {
                "@type": "activityLogEntry",
                "id": "118964723",
                "type": "MTT_TEST",
                "objectName": "",
                "runId": 12,
                "agentId": "01000008000000000004",
                "runtimeEnvironmentId": "01000025000000000004",
                "startTime": "2020-03-27T08:05:56.000Z",
                "endTime": "2020-03-27T08:06:07.000Z",
                "startTimeUtc": "2020-03-27T12:05:56.000Z",
                "endTimeUtc": "2020-03-27T12:06:07.000Z",
                "state": 2,
                "failedSourceRows": 0,
                "successSourceRows": 800,
                "failedTargetRows": 200,
                "successTargetRows": 600,
                "errorMsg": null,
                "startedBy": "di@infa.com",
                "runContextType": "ICS_UI",
                "entries": [],
                "subTaskEntries": [],
                "logEntryItemAttrs": {
                    "CONSUMED_COMPUTE_UNITS": "0.0",
                    "ERROR_CODE": "0",
                    "IS_SERVER_LESS": "false",
                    "REQUESTED_COMPUTE_UNITS": "0.0",
                    "Session Log File Name": "s_mtt_0Sr7LdcbAG2ldG33Lp8koQ_2.log"
                },
                "totalSuccessRows": 0,
                "totalFailedRows": 0,
                "stopOnError": false,
                "hasStopOnErrorRecord": false,
                "contextExternalId": "0100000Z00000000001N",
                "transformationEntries": [
                    {
                        "@type": "transformationLogEntry",
                        "id": "141332309",
                        "txName": "FFSource2",
                        "txType": "SOURCE",
                        "successRows": 600,
                        "failedRows": 0
                    },
                    {
                        "@type": "transformationLogEntry",
                        "id": "141332310",
                        "txName": "FFSource1",
                        "txType": "SOURCE",
                        "successRows": 200,
                        "failedRows": 0
                    },
                    {
                        "@type": "transformationLogEntry",
                        "id": "141332311",
                        "txName": "FFTarget.csv",
                        "txType": "TARGET",
                        "successRows": 600,
                        "affectedRows": 600,
                        "failedRows": 0
                    },
                    {
                        "@type": "transformationLogEntry",
                        "id": "141332312",
                        "txName": "MYSQLTarget",
                        "txType": "TARGET",
                        "successRows": 0,
                        "affectedRows": 0,
                        "failedRows": 200
                    }
                ]
            }
        ]
    }
]

エラーログの要求

サーバーからエラーログを要求できます。

特定のログIDでサーバーからエラーログを要求するには、次のURIを使用します。

/api/v2/activity/errorLog/id

サーバーからエラーログを取得するには、次の要求を使用できます。

GET <server URL>/api/v2/activity/errorLog/000002C10000000002BG  HTTP/1.0
Accept:application/json
icSessionId: <icSessionId>

サーバーは、次の例で示すようなエラーログを文字列として返します。

"Col1","Col2","Error"

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table [test] has no keys specified."

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table [test] has no keys specified."

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table [test] has no keys specified."

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table [test] has no keys specified."

"05/11/2015 00:00:00.000000000","05/11/2015 00:00:00.000000000","ERROR: Target table [test] has no keys specified."

セッションログの要求

sessionLog APIを使用して、すべてのタスクタイプのセッションログをダウンロードできます。

レプリケーション

タスクのようなサブタスクを持つタスクでは、階層内のすべてのセッションログを含むZIPファイルをダウンロードできます。2つのレベルのタスクを持つ

レプリケーション

タスクでは、すべてのセッションログを使用しない場合にitemIdを指定してサブタスクのセッションログを返すことができます。3つのレベルのタスクを持つリニアタスクフローでは、itemIdまたはchildItemIdを指定して特定のサブタスクのセッションログを返すことができます。

次のURIを使用してセッションログをダウンロードします。

/saas/api/v2/activity/activityLog/<Top_Level_Log_Entry_Id>/sessionLog?itemId=<child-log-entry-item-id>&childItemId=<child-log-entry-item-id>

次の例の要求には、特定のセッションログの要求およびサブタスクのセッションログの要求が含まれます。

タスクが

レプリケーション

タスクまたはリニアタスクフローの場合にZIPファイルを返すことができるセッションログを要求するには、次の要求を使用できます。

/saas/api/v2/activity/activityLog/000001C1000000000591/sessionLog

レプリケーション

タスクまたはリニアタスクフローの特定のサブタスクでセッションログを要求するには、次の要求を使用できます。

/saas/api/v2/activity/activityLog/000001C1000000000591/sessionLog?itemId=233

リニアタスクフローでサブタスクのセッションログを要求するには、次の要求を使用できます。

/saas/api/v2/activity/activityLog/000001C1000000000591/sessionLog?itemId=233&childItemId=234

プラットフォームREST APIバージョン2リソース

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

activityLog

activityLog

GET要求

GET応答

GETの例

エラーログの要求

セッションログの要求