The following macros are not currently supported in the header:
  • style

IT 项目管理 API

本文介绍了 IT 项目管理 (ITPM) 模块中可用的 ReST API。 集成开发人员可以使用这些 API 将 ServiceAide Cloud Service Management 与外部应用程序相集成。

您可以使用这些 API 通过外部应用程序在 ServiceAide Cloud Service Management 中执行以下操作:

  • 查询 ITPM 模块中与特定项目相关的项目和任务列表。
  • 将项目标记为收藏项目。
  • 从外部系统中创建项目及该项目中的任务。
  • 更新项目属性并添加团队成员。
  • 更新项目任务以分配所有者、关闭任务以及修改估计时间和所用时间。
  • 阻止或取消阻止任务。
  • 删除项目或项目中的任务。
  • 创建和修改任务板上的泳道。

每个 API 都由以下结构组成:

  • URL:特定于您的切片的应用程序 URL
  • 标头:您的切片和登录用户的基本标识符
  • 负载:用于执行操作的脚本
    执行 API 时,可以将该脚本中的变量替换为实际值。 对于某些 API,您不需要负载。 对于此类 API,可以直接发送此 URL 字段中的值。

注意:所有日期值都为 UTC 时间(毫秒)。

每个 API 调用的标头都需要(必需)标头。 必选标头及其相应的值如下表所示:

标头针对以下对象必选
Cookie有效的 ServiceAide Cloud Service
管理会话
所有 API 调用
内容类型application/jsonPOST、PUT
接受application/jsonPOST、PUT、DELETE、GET

ITPM 模块包括以下 API:

项目 API

您可以使用以下 API 对项目执行操作。 处理现有项目时,请在 URL 中包括项目 ID,如下所示:

http://<应用程序 URL>/itpm/Project('项目 ID')

按 ID 获取

使用项目 ID 检索项目。

URL

http://<应用程序 URL>/itpm/Project('项目 ID')

有效负载

不适用

方法

GET

响应

不适用

创建

创建项目。

URL

http://<应用程序 URL>/itpm/Project

有效负载

方法

POST

响应

不适用

更新

更新项目。

URL

http://<应用程序 URL>/itpm/Project('项目 ID')

有效负载


方法

POST

响应

不适用

停用

停用项目。

URL

http://<应用程序 URL>/itpm/Project('项目 ID')

有效负载

不适用

方法

DELETE

响应

不适用

获取全部

检索您拥有的所有项目的列表。

URL

http://<应用程序 URL>/itpm/Project

有效负载

不适用

方法

GET

响应

不适用

标记或取消标记为收藏项目

将项目标记为您的收藏项目。

URL

http://<应用程序 URL>/itpm/Project('项目 ID')

有效负载


方法

POST

响应

不适用

更改项目所有者

更改项目的所有者。

URL

http://<应用程序 URL>/itpm/Project('项目 ID')/$links/ownedBy

有效负载


方法

PUT

响应

不适用

更改项目组织

不适用

分配 API

使用这些 API 将成员分配给项目。

分配用户

将用户分配给项目。

URL

http://<应用程序 URL>/itpm/Allocation?$expand=project, user

有效负载


方法

POST

响应

不适用

取消分配用户

从项目成员身份中删除用户。

URL

http://<应用程序 url>/itpm/Allocation('分配 ID')

有效负载

不适用

方法

DELETE

响应

不适用

更改分配

删除“编辑”权限或向用户提供“编辑”权限。

URL

http://<应用程序 url>/itpm/Allocation('分配 ID')

有效负载


方法

POST

响应

不适用

获取分配

检索项目成员的列表。

URL

http://<应用程序 URL>/itpm/Project('项目 ID')/allocations

有效负载

不适用

方法

GET

响应

不适用

泳道 API

使用这些 API 在项目任务板上创建和修改泳道。

添加泳道

在任务板上创建泳道。

URL

http://<应用程序 URL>/itpm/Lane

有效负载


方法

POST

响应

不适用

更新泳道

在任务板上修改泳道。

URL

http://<应用程序 URL>/itpm/Lane('项目 ID')

有效负载


方法

POST

响应

不适用

删除泳道

在项目的任务板上删除泳道。

URL

http://<应用程序 URL>/itpm/Lane('通道 ID')

有效负载

不适用

方法

DELETE

响应

不适用

获取泳道

在项目任务板中检索所有泳道的列表。

URL

http://<应用程序 URL>/itpm/Project('项目 ID')/lanes

有效负载

不适用

方法

GET

响应

不适用

任务 API

使用这些 API 来创建和修改项目中的任务。

创建

创建任务。

URL

http://<应用程序 URL>/itpm/Task

有效负载


方法

POST

响应

不适用

按项目获取所有任务

检索项目中的所有任务。

URL

http://<应用程序 URL>/itpm/Project('项目 ID')/tasks?$filter=

有效负载

不适用

方法

GET

响应

不适用

按泳道获取所有任务

检索特定泳道中的所有任务。

URL

http://<应用程序 URL>/itpm/Lane('通道 ID')/tasks

有效负载

不适用

方法

GET

响应

不适用

删除任务

从项目中删除任务。

URL

http://<应用程序 URL>/itpm/Task('任务 ID')

有效负载

不适用

方法

DELETE

响应

不适用

更新

修改任务。

URL

http://localhost:9000/itpm/Task('任务 ID')

有效负载



方法

POST

响应

不适用

任务清单 API

您可为任务创建清单项。 

创建清单

URL 

http://<应用程序 URL>/itpm/CheckListItem

方法 

POST

有效负载

 {
   "description":"Item 1 to be finished",
   "position":2232,
   "done":false,
   "task":{
      "__metadata":{
         "uri":"/itpm/Task('6e87bc52-0aad-4faa-b633-cec827858c04')",
         "type":"odata.Task"
      }
   }
}

响应 

不适用

更新清单

URL 

http://<应用程序 URL>/itpm/CheckListItem('清单项 ID')

方法 

POST

有效负载

 {
   "description":"Item 1 to be finished updated",
   "position":2236,
   "done":true,
   "task":{
      "__metadata":{
         "uri":"/itpm/Task('6e87bc52-0aad-4faa-b633-cec827858c04')",
         "type":"odata.Task"
      }
   }
}


响应 

不适用

获取所有清单项

URL 

http://<应用程序 URL>/itpm/Task('任务 ID')

方法 

GET

响应

不适用

获取某一任务的所有已完成清单项

URL 

http://<应用程序 URL>/itpm/Task('任务 ID')/checklistItems?$filter=done eq true

方法 

GET

响应

不适用

删除清单

URL 

http://<应用程序 URL>/itpm/CheckListItem('清单项 ID')

方法 

DELETE

响应 

不适用 

全部删除 

URL

http://<应用程序 URL>/itpm/Task('任务 ID')/$links/checklistItems

方法

DELETE

响应

不适用

故障单 API

您可以导入多个故障单。

URL

http://<应用程序 URL>/ImportTickets?$expand=importResults/task/ticket

方法

POST

有效负载

{
   "lane":{
      "__metadata":{
         "uri":"/itpm/Lane('872586ad-b903-466e-a498-dc5b73a4f91e')",
         "type":"odata.Lane"
      }
   },
   "ticketIds":[7,8,9]
}

响应

不适用

 

登录授权 API

以下 API 允许您在基于用户名和密码的应用程序中对用户进行身份验证。 

 

URL

http:/<context_url>/odata/login?$format=JSON

方法

POST

application/x-www-form-urlencoded

表单参数

用户名:<user_login>

密码:<password>

响应 

响应包含 JSON 格式的以下参数。

  • 状态  
  • primary_org_logo_idb
  • external_slice
  • external_user_id
  • maintenance_notice

注意:响应还包含 Cookie“LOTUSSESSION="1389265934:080c19ee-e95c-4dce-bfda-09d2ff4dd87d:abb769cf-b153-4052-aa0c-b807434e3191:1945ad38cf8891e3cec4e9d6e33267b417a6c2cb"; Version=1; Path=/”

 

 

 

 

 

 

© 2017 ServiceAide 1-650-206-8988 http://www.serviceaide.com info@serviceaide.com