Processconfiguration - Get

Referência

Service:: Work

API Version:: 7.1-preview.1

Obter configuração do processo

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path	True	string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da API.

Respostas

Nome	Tipo	Description
200 OK	ProcessConfiguration	operação bem-sucedida

Segurança

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

Nome	Description
vso.work	Concede a capacidade de ler itens de trabalho, consultas, quadros, caminhos de área e iterações e outros metadados relacionados ao acompanhamento de itens de trabalho. Também concede a capacidade de executar consultas, pesquisar itens de trabalho e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.

Exemplos

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"
}

Definições

Nome	Description
CategoryConfiguration	Detalhes sobre uma determinada categoria de lista de pendências
ProcessConfiguration	Configurações de processo para o projeto
WorkItemFieldReference	Referência a um campo em um item de trabalho
WorkItemTypeReference	Referência a um tipo de item de trabalho.

CategoryConfiguration

Detalhes sobre uma determinada categoria de lista de pendências

Nome	Tipo	Description
name	string	Nome
referenceName	string	Nome da Referência de Categoria
workItemTypes	WorkItemTypeReference[]	Tipos de item de trabalho para a categoria de lista de pendências

ProcessConfiguration

Configurações de processo para o projeto

Nome	Tipo	Description
bugWorkItems	CategoryConfiguration	Detalhes sobre itens de trabalho de bugs
portfolioBacklogs	CategoryConfiguration[]	Detalhes sobre listas de pendências de portfólio
requirementBacklog	CategoryConfiguration	Detalhes da lista de pendências de requisitos
taskBacklog	CategoryConfiguration	Detalhes da lista de pendências da tarefa
typeFields	<string, WorkItemFieldReference>	Campos de tipo para a configuração do processo
url	string

WorkItemFieldReference

Referência a um campo em um item de trabalho

Nome	Tipo	Description
name	string	O nome amigável do campo.
referenceName	string	O nome de referência do campo.
url	string	A URL REST do recurso.

WorkItemTypeReference

Referência a um tipo de item de trabalho.

Nome	Tipo	Description
name	string	Nome do tipo de item de trabalho.
url	string

Partilhar via