Work Item Type Categories - Get

Referência

Service:: Work Item Tracking

API Version:: 6.0

Obtenha categoria de tipo de item de trabalho específica por nome.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypecategories/{category}?api-version=6.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
category	path	True	string	O nome da categoria
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 '6.0' para usar essa versão da api.

Respostas

Nome	Tipo	Description
200 OK	WorkItemTypeCategory	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 category by name

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypecategories/{category}?api-version=6.0

Sample Response

Status code:: 200

{
  "name": "Requirement Category",
  "referenceName": "Microsoft.RequirementCategory",
  "defaultWorkItemType": {
    "name": "Product Backlog Item",
    "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Product%20Backlog%20Item"
  },
  "workItemTypes": [
    {
      "name": "Product Backlog Item",
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Product%20Backlog%20Item"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.RequirementCategory"
}

Definições

Nome	Description
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
WorkItemTypeCategory	Descreve uma categoria de tipo de item de trabalho.
WorkItemTypeReference	Referência a um tipo de item de trabalho.

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

WorkItemTypeCategory

Descreve uma categoria de tipo de item de trabalho.

Nome	Tipo	Description
_links	ReferenceLinks	Vincular referências a recursos REST relacionados.
defaultWorkItemType	WorkItemTypeReference	Obtém ou define o tipo padrão do item de trabalho.
name	string	O nome da categoria.
referenceName	string	O nome de referência da categoria.
url	string
workItemTypes	WorkItemTypeReference[]	Os tipos de item de trabalho que pertencem à categoria.

WorkItemTypeReference

Referência a um tipo de item de trabalho.

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

Compartilhar via