States - Get

Referência

Serviço:: Work Item Tracking Process

Versão da API:: 7.1

Retorna uma definição de estado único em um tipo de item de trabalho do processo.

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states/{stateId}?api-version=7.1

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
processId	path	True	string (uuid)	A ID do processo
stateId	path	True	string (uuid)	A ID do estado
witRefName	path	True	string	O nome de referência do tipo de item de trabalho
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api.

Respostas

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

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

Nome	Description
vso.work	Concede a capacidade de ler itens de trabalho, consultas, placas, 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 state definition

Solicitação de exemplo

HTTP

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states/{stateId}?api-version=7.1

Resposta de exemplo

Código de status:: 200

{
  "id": "7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
  "name": "New",
  "color": "b2b2b2",
  "stateCategory": "Proposed",
  "order": 1,
  "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/states/7b7e3e8c-e500-40b6-ad56-d59b8d64d757"
}

Definições

Nome	Description
CustomizationType	Indica o tipo de personalização neste item de trabalho. Os comportamentos do sistema são herdados do processo pai, mas não modificados. Comportamentos herdados são comportamentos modificados que foram herdados do processo pai. Comportamentos personalizados são comportamentos criados pelo usuário no processo atual.
WorkItemStateResultModel	Classe que representa um resultado de estado do item de trabalho.

CustomizationType

Enumeração

Indica o tipo de personalização neste item de trabalho. Os comportamentos do sistema são herdados do processo pai, mas não modificados. Comportamentos herdados são comportamentos modificados que foram herdados do processo pai. Comportamentos personalizados são comportamentos criados pelo usuário no processo atual.

Valor	Description
custom	O tipo de personalização será Personalizado se o workitemtype recém-criado for personalizado.
inherited	O tipo de personalização será herdado se o workitemtype existente do processo herdado for personalizado.
system	O tipo de personalização é System if is system generated workitemtype.

WorkItemStateResultModel

Objeto

Classe que representa um resultado de estado do item de trabalho.

Nome	Tipo	Description
color	string	Cor do estado do item de trabalho.
customizationType	CustomizationType	Tipo de personalização de estado do item de trabalho.
hidden	boolean	Se o estado do item de trabalho estiver oculto.
id	string (uuid)	ID do Workitemstate.
name	string	Nome do estado do item de trabalho.
order	integer (int32)	Ordem de estado do item de trabalho.
stateCategory	string	Statecategory do estado do item de trabalho.
url	string	URL de estado do item de trabalho.

Compartilhar via