Work Item Types Field - Get

Service:

Work Item Tracking

API Version:

7.1-preview.3

Obtenha um campo para um tipo de item de trabalho com referências detalhadas.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}/fields/{field}?api-version=7.1-preview.3

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}/fields/{field}?$expand={$expand}&api-version=7.1-preview.3

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
field	path	True	string
organization	path	True	string	O nome da organização do Azure DevOps.
project	path	True	string	ID do projeto ou nome do projeto
type	path	True	string	Tipo de item de trabalho.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.3' para usar essa versão da API.
$expand	query		WorkItemTypeFieldsExpandLevel	Expanda o nível para a resposta da API. Propriedades: para incluir valores permitidos, valor padrão, isRequired etc. como parte da resposta; Nenhum: para ignorar essas propriedades.

Respostas

Nome	Tipo	Description
200 OK	WorkItemTypeFieldWithReferences	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 project scoped work item type field data

Get project scoped work item type field data with expand option

Get project scoped work item type field data

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypes/Bug/fields/System.IterationPath?api-version=7.1-preview.3

Sample Response

Status code:

200

{
  "helpText": "The iteration within which this bug will be fixed",
  "alwaysRequired": false,
  "defaultValue": null,
  "referenceName": "System.IterationPath",
  "name": "Iteration Path",
  "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}

Get project scoped work item type field data with expand option

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypes/Bug/fields/System.ChangedBy?$expand=All&api-version=7.1-preview.3

Sample Response

Status code:

200

{
  "alwaysRequired": false,
  "defaultValue": null,
  "allowedValues": [
    {
      "displayName": "Jamal Hartnett",
      "id": "df828ec3-71d8-6e69-9afd-e736c5a32145",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "descriptor": "s2s.M2FjODRhZmItYWIwNC00ZWM0LWEyZWItOGEyYWJmNGJlNDQ3QDcyZjk4OGJmLTg2ZjEtNCFhZi05MWFiLTJkN2NkMDExZGI0Nw"
    },
    {
      "displayName": "Norman Paulk",
      "id": "df828ec3-71d8-6e69-9afd-e736c5b32145",
      "uniqueName": "Fabrikamfiber16@hotmail.com",
      "descriptor": "s2s.M2FjODRhZmIeYWIwNC00ZWM0LWEyZWItOGEyYWJmNGJlNDQ3QDcyZjk4OGJmLTg2ZjEtNDFhZi05MWFiLTJkN2NkMDExZGI0Nw"
    },
    {
      "displayName": "Chuck Reinhart",
      "id": "df828ec3-71d8-6e69-9afd-g736c5a32145",
      "uniqueName": "fabrikamfiber3@hotmail.com",
      "descriptor": "s2s.M2FjODRhZmItYWIwNC00SWG0LWEyZWItOGEyYWJmNGJlNDQ3QDcyZjk4OGJmLTg2ZjEtNDFhZi05MWFiLTJkN2NkMDExZGI0Nw"
    }
  ],
  "dependentFields": [],
  "referenceName": "System.ChangedBy",
  "name": "Changed By",
  "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.ChangedBy"
}

Definições

Nome	Description
WorkItemFieldReference	Referência a um campo em um item de trabalho
WorkItemTypeFieldsExpandLevel	Expanda o nível para a resposta da API. Propriedades: para incluir valores permitidos, valor padrão, isRequired etc. como parte da resposta; Nenhum: para ignorar essas propriedades.
WorkItemTypeFieldWithReferences	Instância de campo de um workItemype com referências detalhadas.

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.

WorkItemTypeFieldsExpandLevel

Expanda o nível para a resposta da API. Propriedades: para incluir valores permitidos, valor padrão, isRequired etc. como parte da resposta; Nenhum: para ignorar essas propriedades.

Nome	Tipo	Description
all	string	Inclui valores permitidos e campos dependentes do campo.
allowedValues	string	Inclui valores permitidos para o campo.
dependentFields	string	Inclui campos dependentes do campo.
none	string	Inclui apenas propriedades básicas do campo.

WorkItemTypeFieldWithReferences

Instância de campo de um workItemype com referências detalhadas.

Nome	Tipo	Description
allowedValues	object[]	A lista de valores permitidos do campo.
alwaysRequired	boolean	Indica se o valor do campo é sempre necessário.
defaultValue	object	Representa o valor padrão do campo.
dependentFields	WorkItemFieldReference[]	A lista de campos dependentes.
helpText	string	Obtém o texto da ajuda para o campo.
name	string	O nome amigável do campo.
referenceName	string	O nome de referência do campo.
url	string	A URL REST do recurso.