Processes - Edit Process

服务:

Work Item Tracking Process

API 版本:

7.1

编辑特定 ID 的过程。

PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processTypeId}?api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
processTypeId	path	True	string (uuid)
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
description	string	流程的新说明
isDefault	boolean	如果真正的新项目默认使用此过程
isEnabled	boolean	如果为 false，则进程将被禁用，并且不能用于创建项目
name	string	进程的新名称

响应

名称	类型	说明
200 OK	ProcessInfo	成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

作用域

名称	说明
vso.work_write	授予读取、创建和更新工作项和查询、更新板元数据、读取区域和迭代路径、其他工作项跟踪相关元数据、执行查询以及通过服务挂钩接收有关工作项事件的通知的能力。

示例

Edit the process

示例请求

HTTP

PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processTypeId}?api-version=7.1

{
  "name": "MyNewAgileProcess_Renamed",
  "description": "My new renamed process",
  "IsDefault": "false",
  "IsEnabled": "false"
}

示例响应

状态代码:

200

{
  "typeId": "fb70612d-c6d5-421a-ace1-04939e81b669",
  "referenceName": "fabrikam.MyNewAgileProcess",
  "name": "MyNewAgileProcess_Renamed",
  "description": "My new renamed process",
  "parentProcessTypeId": "adcc42ab-9882-485e-a3ed-7678f01f66bc",
  "isEnabled": false,
  "customizationType": "Inherited"
}

定义

名称	说明
CustomizationType	指示此工作项的自定义类型。 系统行为继承自父进程，但未修改。 继承的行为是从父进程继承的修改行为。 自定义行为是由用户在当前进程中创建的行为。
ProcessInfo	过程。
ProjectReference	定义项目引用类。
UpdateProcessModel	描述更新进程的请求

CustomizationType

枚举

指示此工作项的自定义类型。 系统行为继承自父进程，但未修改。 继承的行为是从父进程继承的修改行为。 自定义行为是由用户在当前进程中创建的行为。

值	说明
custom	如果新创建的工作项类型已自定义，则自定义类型为 Custom。
inherited	如果自定义了继承进程的现有工作项类型，则自定义自定义类型。
system	自定义类型为 System（如果系统生成的 workitemtype）。

ProcessInfo

Object

过程。

名称	类型	说明
customizationType	CustomizationType	指示此过程的自定义类型。 系统进程是默认进程。 继承的进程是以前系统进程的修改进程。
description	string	过程的说明。
isDefault	boolean	进程默认值。
isEnabled	boolean	是否已启用进程。
name	string	进程的名称。
parentProcessTypeId	string (uuid)	父进程的 ID。
projects	ProjectReference[]	用户订阅到的此过程中的项目。
referenceName	string	进程的引用名称。
typeId	string (uuid)	进程的 ID。

ProjectReference

Object

定义项目引用类。

名称	类型	说明
description	string	项目说明
id	string (uuid)	项目的 ID
name	string	项目的名称
url	string	项目的 URL

UpdateProcessModel

Object

描述更新进程的请求

名称	类型	说明
description	string	流程的新说明
isDefault	boolean	如果真正的新项目默认使用此过程
isEnabled	boolean	如果为 false，则进程将被禁用，并且不能用于创建项目
name	string	进程的新名称