Servigistics InService 發佈與載入 > 其他資訊 > Task Manager 服務
  
Task Manager 服務
Task Manager 提供含狀態傳輸 (REST) API，可讓您執行各種任務並對目前執行中的任務執行動作。以下提供此 API 的使用方式範例。
新增集合
下列範例顯示您可以如何使用 REST API 來執行「新增集合」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
部署集合
下列範例顯示您可以如何使用 REST API 來執行「部署集合」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
取得任務狀況
下列範例顯示您可以如何使用 REST API 來檢查目前執行中任務的狀況。請注意，您必須提供任務的識別元。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
POST
請求具有下列參數：
◦ Content-Type - 應用程式 json
◦ Authorization - 基本授權
◦ X-XSRF-TOKEN - 靜態值
資料參數 (JSON)
資料參數是一個 JSON 檔案 (GetTaskStatus.json)：
{
"taskManagerCommands":
[
{"action":"getStatus",
"tid":"20313"}
]
}
認證
基本
資料參數
無
成功回應
200 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
轉換與載入配套
下列範例顯示您可以如何使用 REST API 來執行「轉換與載入配套」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
轉換與載入 (初次載入)
下列範例顯示您在初次載入資料時可以如何使用 REST API 來執行「轉換與載入」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
轉換與載入
下列範例顯示您可以如何使用 REST API 來執行「轉換與載入」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
刪除任務
下列範例顯示您可以如何使用 REST API 來刪除目前執行中的任務。請注意，您必須提供任務的識別元。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
POST
請求具有下列參數：
◦ Content-Type - 應用程式 json
◦ Authorization - 基本授權
◦ X-XSRF-TOKEN - 靜態值
資料參數 (JSON)
資料參數是一個 JSON 檔案 (DeleteTask.json)：
{
"taskManagerCommands":
[
{"action":"delete",
"tid":"1748"}
]
}
認證
基本
資料參數
無
成功回應
200 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
從網站中刪除區段
下列範例顯示您可以如何使用 REST API 來執行「從網站刪除區段」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
繼續任務
下列範例顯示您可以如何使用 REST API 來繼續目前已暫停的任務。請注意，您必須提供任務的識別元。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
POST
請求具有下列參數：
◦ Content-Type - 應用程式 json
◦ Authorization - 基本授權
◦ X-XSRF-TOKEN - 靜態值
資料參數 (JSON)
資料參數是一個 JSON 檔案 (Resume.json)：
{
"taskManagerCommands":
[
{"action":"resume",
"tid":"5576"}
]
}
認證
基本
資料參數
無
成功回應
200 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
暫停任務
下列範例顯示您可以如何使用 REST API 來暫停目前執行中的任務。請注意，您必須提供任務的識別元。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
POST
請求具有下列參數：
◦ Content-Type - 應用程式 json
◦ Authorization - 基本授權
◦ X-XSRF-TOKEN - 靜態值
資料參數 (JSON)
資料參數是一個 JSON 檔案 (PauseAction.json)：
{
"taskManagerCommands":
[
{"action":"pause",
"tid":"5642"}
]
}
認證
基本
資料參數
無
成功回應
200 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
中止任務
下列範例顯示您可以如何使用 REST API 來中止目前執行中的任務。請注意，您必須提供任務的識別元。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
POST
請求具有下列參數：
◦ Content-Type - 應用程式 json
◦ Authorization - 基本授權
◦ X-XSRF-TOKEN - 靜態值
資料參數 (JSON)
資料參數是一個 JSON 檔案 (AbortTask.json)：
{
"taskManagerCommands":
[
{"action":"abort",
"tid":"5642"}
]
}
認證
基本
資料參數
無
成功回應
200 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
將類別新增至非產品集合
下列範例顯示您可以如何使用 REST API 來執行「新增類別至非產品集合」任務。
URL
http://server:port/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",
}
]
}
另一個範例 (適用於 SHARED 區段)：
{
"taskManagerCommands":
[
{
"name":"Add Category",
"action":"run",
"publication_name":"PARTDOCUMENTS",
"list_categories": "PARTDOCUMENTS",
"list_contexts":"PARTDOCUMENTS",
"segment_id":"SHARED",
}
]
}
認證
基本
資料參數
無
成功回應
200 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
發佈至網站
下列範例顯示您可以如何使用 REST API 來執行「發佈至網站」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
移除區段組態設定
下列範例顯示您可以如何使用 REST API 來執行「移除區段組態設定」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
將前後關聯新增至集合
下列範例顯示您可以如何使用 REST API 來執行「新增前後關聯至集合」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
新增資料類型
下列範例顯示您可以如何使用 REST API 來執行「新增資料類型」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
清除轉換與載入暫時資料
下列範例顯示您可以如何使用 REST API 來執行「清除轉換與載入暫時資料」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
匯出網站內容
下列範例顯示您可以如何使用 REST API 來執行「匯出網站內容」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
建立離線封包
下列範例顯示您可以如何使用 REST API 來執行「建立離線封包」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
從網站中刪除集合
下列範例顯示您可以如何使用 REST API 來執行「從網站刪除集合」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
部署資產
下列範例顯示您可以如何使用 REST API 來執行「部署資產」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
移除集合組態設定
下列範例顯示您可以如何使用 REST API 來執行「移除集合組態設定」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
轉換與載入 CSV 資料
下列範例顯示您可以如何使用 REST API 來執行「轉換與載入 CSV 資料」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤
更新 Publication Manager 中的資產
下列範例顯示您可以如何使用 REST API 來執行「更新 Publication Manager 中的資產」任務。
URL
http://server:port/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 - 成功
錯誤回應
400 - BAD_REQUEST
401 - 未經授權的請求
500 - 內部伺服器錯誤