Servigistics InService 发布和加载 > 其他信息 > Task Manager 服务
  
Task Manager 服务
Task Manager 提供了具象状态传输 (REST) API，使您能够在运行多个不同任务的同时针对当前正在运行的任务执行操作。下文提供了有关此 API 使用方法的示例。
Add Collection
以下示例用于说明如何使用 REST API 运行 Add Collection 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
Deploy Collection
以下示例用于说明如何使用 REST API 运行 Deploy Collection 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
获取任务状况
以下示例用于说明如何使用 REST API 检查当前正在运行的任务的状况。请注意，您必须提供任务的标识符。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ X-XSRF-TOKEN - 静态值
数据参数 (JSON)
数据参数是一个 JSON 文件 (GetTaskStatus.json)：
{
"taskManagerCommands":
[
{"action":"getStatus",
"tid":"20313"}
]
}
验证
基本
数据参数
无
成功响应
200 - 正常
错误响应
400 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
变换并加载束
以下示例将说明如何使用 REST API 运行 Transform and Load a Bundle 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
变换和加载 (初始加载)
以下示例将显示进行数据的初始加载时如何使用 REST API 运行 Transform and Load 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
Transform and Load
以下示例将说明如何使用 REST API 运行 Transform and Load 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
删除任务
以下示例用于说明如何使用 REST API 删除当前正在运行的任务。请注意，您必须提供任务的标识符。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ X-XSRF-TOKEN - 静态值
数据参数 (JSON)
数据参数是一个 JSON 文件 (DeleteTask.json)
{
"taskManagerCommands":
[
{"action":"delete",
"tid":"1748"}
]
}
验证
基本
数据参数
无
成功响应
200 - 正常
错误响应
400 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
从站点删除段
以下示例将说明如何使用 REST API 运行 Delete Segment From Sites 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ X-XSRF-TOKEN - 静态值
数据参数 (JSON)
数据参数是一个 JSON 文件 (DeleteSegmentFromSite.json)：
{
"taskManagerCommands":
[
{
"name":"Delete Segment From Sites",
"action":"run",
"publication_name":"SEG1",
"site_groups":"Preview"
}
]
}
验证
基本
数据参数
无
成功响应
200 - 正常
错误响应
400 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
恢复任务
以下示例用于说明如何使用 REST API 恢复当前暂停的任务。请注意，您必须提供任务的标识符。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ X-XSRF-TOKEN - 静态值
数据参数 (JSON)
数据参数是一个 JSON 文件 (Resume.json)：
{
"taskManagerCommands":
[
{"action":"resume",
"tid":"5576"}
]
}
验证
基本
数据参数
无
成功响应
200 - 正常
错误响应
400 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
暂停任务
以下示例用于说明如何使用 REST API 暂停当前正在运行的任务。请注意，您必须提供任务的标识符。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ X-XSRF-TOKEN - 静态值
数据参数 (JSON)
数据参数是一个 JSON 文件 (PauseAction.json)：
{
"taskManagerCommands":
[
{"action":"pause",
"tid":"5642"}
]
}
验证
基本
数据参数
无
成功响应
200 - 正常
错误响应
400 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
中止任务
以下示例用于说明如何使用 REST API 中止当前正在运行的任务。请注意，您必须提供任务的标识符。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ X-XSRF-TOKEN - 静态值
数据参数 (JSON)
数据参数是一个 JSON 文件 (AbortTask.json)：
{
"taskManagerCommands":
[
{"action":"abort",
"tid":"5642"}
]
}
验证
基本
数据参数
无
成功响应
200 - 正常
错误响应
400 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
将类别添加到非产品集合
以下示例用于说明如何使用 REST API 运行 Add Category To a Non Product Collection 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
发布到站点
以下示例将说明如何使用 REST API 运行 Publish To Site 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
移除段配置设置
以下示例将说明如何使用 REST API 运行 Remove Segment Configuration Setting 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
将上下文添加到集合
以下示例用于说明如何使用 REST API 运行 Add Context To a Collection 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
添加数据类型
以下示例用于说明如何使用 REST API 运行 Add Data Type 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
清除变换并加载临时数据
以下示例将说明如何使用 REST API 运行 Clean Transformation and Loading temporary Data 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
导出站点内容
以下示例将说明如何使用 REST API 运行 Export Site Content 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ X-XSRF-TOKEN - 静态值
数据参数 (JSON)
数据参数是一个 JSON 文件 (Create Backup From Site.json)：
{
"taskManagerCommands":
[
{
"name":"Create Backup From Site",
"action":"run",
"siteId" : "Preview",
"isFullBackupFromSiteTask" : "true"
}
]
}
验证
基本
数据参数
无
成功响应
200 - 正常
错误响应
400 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
创建离线包
以下示例将说明如何使用 REST API 运行 Create Offline Packet 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
从站点删除集合
以下示例将说明如何使用 REST API 运行 Delete Collection From Sites 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
部署资产
以下示例用于说明如何使用 REST API 运行 Deploy Assets 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
移除集合配置设置
以下示例将说明如何使用 REST API 运行 Remove Collection Configuration Setting 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
Transform and Load CSV Data
以下示例将说明如何使用 REST API 运行 Transform and Load CSV Data 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误
在 Publication Manager 中更新资产
以下示例用于说明如何使用 REST API 运行 Updates Assets In Publication Manager 任务。
URL
http://server:port/TaskManager/rest/TaskManagerRest/runTask
方法
发布
该请求具有以下参数：
◦ 内容-类型 - 应用程序 json
◦ 授权 - 基本授权
◦ 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 - 错误请求
401 - 未授权请求
500 - 内部服务器错误