Servigistics InService のパブリッシングおよびロード > 追加情報 > Task Manager サービス
  
Task Manager サービス
Task Manager には Representational State Transfer (REST) API が用意されており、これを使用することで、さまざまなタスクを実行すると同時に、現在実行されているタスクに対して操作を実行できます。この API を使用する方法の例を次に示します。
Add Collection
次の例は、REST API を使用して Add Collection タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (AddCollection.json) です。
{
"taskManagerCommands":
[
{
"publication_name":"Co7",
"name":"Add Collection",
"action":"run",
"s1000D_publication":"false",
"list_manuals":"<Publications>
<Publication name=\"Col1\">
<Manual name=\"BOM\" title=\"BOM\" format=\"xml
\" type=\"BOM\" model=\"NO_MODEL_ATTR\"/>
<Manual name=\"DOCRELATION\" title=\"DOCRELATION
\" format=\"xml\" type=\"DOCRELATION
\" model=\"NO_MODEL_ATTR\"/>
</Publication>
</Publications>",
"site_groups":"<SiteGroups><Group id=\"Preview\"/></SiteGroups>",
"segment_title":"Seg1",
"content_type":"Product Related Content",
"list_categories":"",
"rEDEPLOY_FLAG":"null",
"site_groups_selected":"true",
"assets_folder_path":"/opt/InService/InS_SW/SW/System/Assets",
"publication_title":"Col1",
"comment":"Col1",
"segment_id":"Seg1",
"list_contexts":"Context1"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Deploy Collection
次の例は、REST API を使用して Deploy Collection タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (DeployCollection.json) です。
{
"taskManagerCommands":
[
{
"publication_name":"Co7",
"name":"Deploy Collection",
"action":"run",
"profile_name":"ASSETS_Co7",
"update_type":"Assets",
"reset_index":"false",
"site_groups":"Preview",
"coreLogicGroup":"default",
"mode":"PublishToRuntime",
"monitoring_name":"Run Deploy Pub",
"list_contexts":"Context1",
"list_categories":"",
"publication_title":"Col1",
"P2RTLoadType":"CollectionProfile",
"pauseBeforeExpose":"false",
"isCoordinatorMode":"false"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Get Task Status
次の例は、REST API を使用して、現在実行されているタスクのステータスをチェックする方法を示しています。タスクの識別子を指定しなければならないことに注意してください。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (GetTaskStatus.json) です。
{
"taskManagerCommands":
[
{"action":"getStatus",
"tid":"20313"}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Transform and Load a Bundle
次の例は、REST API を使用して Transform and Load a Bundle タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (TransformANDLoadBundle.json) です。
{
"taskManagerCommands":
[
{
"name":"Transform and Load a Bundle",
"action":"run",
"bundleFolder":"/vagrant/Bundles/PH",
"partsFamily":"PARTS",
"updateIfTimestampEqual":"false",
"site_groups":"Preview",
"shouldValidate":"false",
"paramsList":"site_groups:convertCGMToSVG:updateIfTimestampEqual",
"rollback":"no",
"S1000DVersion":"4.0",
"logLevel":"10",
"pauseAfterTransform":"false",
"publication_title":"Col1",
"convertCGMToSVG":"false",
"isInitialDataLoad":"false"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Transform and Load (Initial Load)
次の例は、データの初期ロードを行うときに REST API を使用して Transform and Load を実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Transform and Load [TransformMgmtInitialLoad].json) です。
{
"taskManagerCommands":
[
{
"name":"Transform and Load",
"action":"run",
"rootFolder":"/vagrant/Bundles",
"partsFamily":"PARTS",
"updateIfTimestampEqual":"false",
"shouldValidate":"false",
"paramsList":"site_groups:convertCGMToSVG:updateIfTimestampEqual",
"site_groups":"Preview",
"rollback":"no",
"isInitialLoad" : "yes",
"S1000DVersion":"4.0",
"logLevel":"10",
"convertCGMToSVG":"false",
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Transform and Load
次の例は、REST API を使用して Transform and Load タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Transform and Load [TranformManagement].json) です。
{
"taskManagerCommands":
[
{
"name":"Transform and Load",
"action":"run",
"rootFolder":"/vagrant/Bundles",
"partsFamily":"PARTS",
"updateIfTimestampEqual":"false",
"shouldValidate":"false",
"paramsList":"site_groups:convertCGMToSVG:updateIfTimestampEqual",
"site_groups":"Preview",
"rollback":"no",
"isInitialLoad" : "no",
"S1000DVersion":"4.0",
"logLevel":"10",
"convertCGMToSVG":"false",
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Delete Task
次の例は、REST API を使用して、現在実行されているタスクを削除する方法を示しています。タスクの識別子を指定しなければならないことに注意してください。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (DeleteTask.json) です。
{
"taskManagerCommands":
[
{"action":"delete",
"tid":"1748"}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Delete Segment From Sites
次の例は、REST API を使用して Delete Segment From Sites タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (DeleteSegmentFromSite.json) です。
{
"taskManagerCommands":
[
{
"name":"Delete Segment From Sites",
"action":"run",
"publication_name":"SEG1",
"site_groups":"Preview"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Resume Task
次の例は、REST API を使用して、現在一時停止されているタスクを再開する方法を示しています。タスクの識別子を指定しなければならないことに注意してください。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Resume.json) です。
{
"taskManagerCommands":
[
{"action":"resume",
"tid":"5576"}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Pause Task
次の例は、REST API を使用して、現在実行されているタスクを一時停止する方法を示しています。タスクの識別子を指定しなければならないことに注意してください。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (PauseAction.json) です。
{
"taskManagerCommands":
[
{"action":"pause",
"tid":"5642"}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Abort Task
次の例は、REST API を使用して、現在実行されているタスクを中止する方法を示しています。タスクの識別子を指定しなければならないことに注意してください。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (AbortTask.json) です。
{
"taskManagerCommands":
[
{"action":"abort",
"tid":"5642"}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Add Category To a Non Product Collection
次の例は、REST API を使用して Add Category To a Non Product Collection タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Add Category.json) です。
{
"taskManagerCommands":
[
{
"name":"Add Category",
"action":"run",
"publication_name":"Col2",
"list_categories": "PARTDOCUMENTS"
"list_contexts":"0000014982,0000015163,0000022202"
"segment_id":"Seg2",
}
]
}
別の例 (共有セグメント):
{
"taskManagerCommands":
[
{
"name":"Add Category",
"action":"run",
"publication_name":"PARTDOCUMENTS",
"list_categories": "PARTDOCUMENTS",
"list_contexts":"PARTDOCUMENTS",
"segment_id":"SHARED",
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Publish To Site
次の例は、REST API を使用して Publish To Site タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Publish To Site.json) です。
{
"taskManagerCommands":
[
{
"name":"Publish To Site",
"action":"run",
"publication_name":"ALL",
"loadToMasterSiteOnly" : "false",
"isSynchExpose" : "false",
"pauseBeforeExpose" : "false",
"site_groups" : "Preview"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Remove Segment Configuration Setting
次の例は、REST API を使用して Remove Segment Configuration Setting タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Remove Segment Configuration Setting.json) です。
{
"taskManagerCommands":
[
{
"name":"Remove Segment Configuration Setting",
"action":"run",
"publication_name":"SEG1",
"site_groups":"Preview"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Add Context To a Collection
次の例は、REST API を使用して Add Context To a Collection タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Add Context.json) です。
{
"taskManagerCommands":
[
{
"name":"Add Context",
"action":"run",
"publication_name":"KMT-EX",
"list_categories":"",
"list_contexts":"KMT-EX,XYZ",
"segment_id":"KMT-EX-Seg",
"site_groups":"<SiteGroups><Group id=\"Preview\"/></SiteGroups>"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Add Data Type
次の例は、REST API を使用して Add Data Type タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Add Data Type.json) です。
{
"taskManagerCommands":
[
{
"name":"Add Data Type",
"action":"run",
"publication_name":"KMT-EX",
"multi_publications":"false",
"model_attr_value":"NO_MODEL_ATTR",
"manual":"P2CRELATION",
"manual_type":"P2CRELATION",
"site_groups":"",
"publication_names":"null",
"site_groups_selected":"false",
"REDEPLOY_FLAG":"null",
"assets_folder_path":"${enigma.bin.home}/System/Assets",
"comment":"KMT-EX",
"manual_title":"P2CRELATION",
"manual_format":"xml"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Clean Transformation and Loading temporary Data
次の例は、REST API を使用して Clean Transformation and Loading temporary Data タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Clean Transformation and Loading temporary Data.json) です。
{
"taskManagerCommands":
[
{
"name":"Clean Transformation and Loading temporary Data",
"action":"run",
"bundlesRootFolder":"/vagrant/Bundles/PH",
"cleanupState":"",
"archivingPath":"",
"deleteClonepacket":"true"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Export Site Content
次の例は、REST API を使用して Export Site Content タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Create Backup From Site.json) です。
{
"taskManagerCommands":
[
{
"name":"Create Backup From Site",
"action":"run",
"siteId" : "Preview",
"isFullBackupFromSiteTask" : "true"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Create Offline Packet
次の例は、REST API を使用して Create Offline Packet タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Create Offline Packet.json) です。
{
"taskManagerCommands":
[
{
"name":"Create Offline Packet",
"action":"run",
"publication_name" : "Seg1",
"siteId" : "Preview",
"postProcessPath" : "${enigma.config.home}/System/Config/Flows/
SACreatorForOffline/postProcessForSA.xml"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Delete Collection From Sites
次の例は、REST API を使用して Delete Collection From Sites タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Delete Collection From Sites.json) です。
{
"taskManagerCommands":
[
{
"name":"Delete Collection From Sites",
"action":"run",
"publication_name":"PARTS",
"site_groups":"<SiteGroups><Group id=\"Preview\"/></SiteGroups>"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Deploy Assets
次の例は、REST API を使用して Deploy Assets タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Deploy Assets.json) です。
{
"taskManagerCommands":
[
{
"name":"Deploy Assets",
"action":"run",
"site_groups":"Preview",
"isSynchExpose":"false",
"reset_index":"false",
"pauseBeforeExpose":"false",
"isCoordinatorMode":"false"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Remove Collection Configuration Setting
次の例は、REST API を使用して Remove Collection Configuration Setting タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Remove Collection Configuration Setting.json) です。
{
"taskManagerCommands":
[
{
"name":"Remove Collection Configuration Settting",
"action":"run",
"publication_name":"PARTS",
"taskName" : "Remove Collection Setting"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Transform and Load CSV Data
次の例は、REST API を使用して Transform and Load CSV Data タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Transform and Load CSV Data.json) です。
{
"taskManagerCommands":
[
{
"name":"Transform and Load CSV Data",
"action":"run",
"inputFolder":"/vagrant/CSVBundle",
"site_groups":"Preview",
"pauseAfterTransform":"false",
"piOnly" : "false",
"collectionName" : "",
"orgName" : "",
"paramsList":"site_groups:convertCGMToSVG",
"convertCGMToSVG":"false",
"inputFolderInternal" : "/vagrant/CSVBundle",
"bundleCategory" : "None"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー
Updates Assets In Publication Manager
次の例は、REST API を使用して Updates Assets In Publication Manager タスクを実行する方法を示しています。
URL
http://サーバー:ポート/TaskManager/rest/TaskManagerRest/runTask
メソッド
POST
このリクエストには以下のパラメータがあります。
◦ Content-Type - アプリケーション json
◦ Authorization - 基本認証
◦ X-XSRF-TOKEN - 静的な値
データパラメータ (JSON)
データパラメータは JSON ファイル (Updates Assets In Publication Manager.json) です。
{
"taskManagerCommands":
[
{
"name":"Update Assets In Publication Manager",
"action":"run",
"assets_folder_path":"${enigma.bin.home}/System/Assets"
}
]
}
認証
基本
データパラメータ
なし
成功応答
200 - OK
エラー応答
400 - 無効なリクエスト
401 - 権限のないリクエスト
500 - 内部サーバーエラー