Processconfiguration - Get

参考

Service:: Work

API Version:: 7.1-preview.1

获取进程配置

GET https://dev.azure.com/{organization}/{project}/_apis/work/processconfiguration?api-version=7.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.1”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	ProcessConfiguration	成功的操作

安全性

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

名称	说明
vso.work	授予读取工作项、查询、板、区域和迭代路径以及其他工作项跟踪相关元数据的能力。此外，还允许通过服务挂钩执行查询、搜索工作项和接收有关工作项事件的通知。

示例

Get process configuration

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/processconfiguration?api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "typeFields": {
    "Effort": {
      "referenceName": "Microsoft.VSTS.Scheduling.StoryPoints",
      "name": "Story Points",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.StoryPoints"
    },
    "Order": {
      "referenceName": "Microsoft.VSTS.Common.StackRank",
      "name": "Stack Rank",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
    },
    "RemainingWork": {
      "referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
      "name": "Remaining Work",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.RemainingWork"
    },
    "Team": {
      "referenceName": "System.AreaPath",
      "name": "Area Path",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AreaPath"
    },
    "Activity": {
      "referenceName": "Microsoft.VSTS.Common.Activity",
      "name": "Activity",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.Activity"
    }
  },
  "taskBacklog": {
    "name": "Tasks",
    "referenceName": "Microsoft.TaskCategory",
    "workItemTypes": [
      {
        "name": "Task",
        "url": "https://dev.azure.com/fabrikam/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/Task"
      }
    ]
  },
  "requirementBacklog": {
    "name": "Stories",
    "referenceName": "Microsoft.RequirementCategory",
    "workItemTypes": [
      {
        "name": "User Story",
        "url": "https://dev.azure.com/fabrikam/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/User%20Story"
      }
    ]
  },
  "portfolioBacklogs": [
    {
      "name": "Epics",
      "referenceName": "Microsoft.EpicCategory",
      "workItemTypes": [
        {
          "name": "Epic",
          "url": "https://dev.azure.com/fabrikam/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/Epic"
        }
      ]
    },
    {
      "name": "Features",
      "referenceName": "Microsoft.FeatureCategory",
      "workItemTypes": [
        {
          "name": "Feature",
          "url": "https://dev.azure.com/fabrikam/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/Feature"
        }
      ]
    }
  ],
  "bugWorkItems": {
    "name": "Bugs",
    "referenceName": "Microsoft.BugCategory",
    "workItemTypes": [
      {
        "name": "Bug",
        "url": "https://dev.azure.com/fabrikam/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/Bug"
      }
    ]
  },
  "url": "https://dev.azure.com/fabrikam/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/work/processconfiguration"
}

定义

名称	说明
CategoryConfiguration	有关给定积压工作类别的详细信息
ProcessConfiguration	项目的流程配置
WorkItemFieldReference	对工作项中的字段的引用
WorkItemTypeReference	对工作项类型的引用。

CategoryConfiguration

有关给定积压工作类别的详细信息

名称	类型	说明
name	string	名称
referenceName	string	类别引用名称
workItemTypes	WorkItemTypeReference[]	积压工作类别的工作项类型

ProcessConfiguration

项目的流程配置

名称	类型	说明
bugWorkItems	CategoryConfiguration	有关 bug 工作项的详细信息
portfolioBacklogs	CategoryConfiguration[]	有关项目组合积压工作的详细信息
requirementBacklog	CategoryConfiguration	需求积压工作的详细信息
taskBacklog	CategoryConfiguration	任务积压工作的详细信息
typeFields	<string, WorkItemFieldReference>	进程配置的类型字段
url	string

WorkItemFieldReference

对工作项中的字段的引用

名称	类型	说明
name	string	字段的友好名称。
referenceName	string	字段的引用名称。
url	string	资源的 REST URL。

WorkItemTypeReference

对工作项类型的引用。

名称	类型	说明
name	string	工作项类型的名称。
url	string

通过