Controls - Edit Control

Referência

Serviço:: Work Item Tracking Process Definitions

Versão da API:: 4.1-preview.1

Atualizações um controle no formulário do item de trabalho

PATCH https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workItemTypes/{witRefName}/layout/groups/{groupId}/controls/{controlId}?api-version=4.1-preview.1

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
controlId	path	True	string	A ID do controle
groupId	path	True	string	A ID do grupo
organization	path	True	string	O nome da organização do Azure DevOps.
processId	path	True	string uuid	A ID do processo
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 '4.1-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
contribution	WitContribution	Contribuição para o controle.
controlType	string	Tipo do controle.
height	integer	Altura do controle para controles html.
id	string	A ID do nó de layout.
inherited	boolean	Um valor que indica se esse nó de layout foi herdado de um layout pai. Espera-se que isso seja definido apenas pelo combinador.
isContribution	boolean	Um valor que indica se o nó de layout é contribuição ou não.
label	string	Rótulo para o campo
metadata	string	Texto interno do controle.
order	integer
overridden	boolean	Um valor que indica se esse nó de layout foi substituído por um layout filho.
readOnly	boolean	Um valor que indica se o controle é somente leitura.
visible	boolean	Um valor que indica se o controle deve estar oculto ou não.
watermark	string	Texto de marca d'água para a caixa de texto.

Respostas

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

Segurança

accessToken

Token de acesso pessoal. Use qualquer valor para o nome de usuário e o token como a senha.

Tipo: basic

Exemplos

Update a control on the work item form

Solicitação de exemplo

HTTP

PATCH https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workItemTypes/{witRefName}/layout/groups/{groupId}/controls/{controlId}?api-version=4.1-preview.1

{
  "order": null,
  "label": "",
  "readOnly": false,
  "visible": true,
  "controlType": null,
  "id": "c1681eea-cf9e-4a32-aee9-83e97fde894a",
  "metadata": null,
  "inherited": null,
  "overridden": null,
  "watermark": null,
  "contribution": {
    "contributionId": "ms-devlabs.toggle-control.toggle-control-contribution",
    "inputs": {
      "FieldName": "System.BoardColumnDone",
      "TrueLabel": "new value"
    },
    "height": null,
    "showOnDeletedWorkItem": null
  },
  "isContribution": true,
  "height": null
}

Resposta de exemplo

Código de status:: 200

{
  "id": "c1681eea-cf9e-4a32-aee9-83e97fde894a",
  "label": "",
  "readOnly": false,
  "visible": true,
  "contribution": {
    "contributionId": "ms-devlabs.toggle-control.toggle-control-contribution",
    "inputs": {
      "FieldName": "System.BoardColumnDone",
      "TrueLabel": "new value"
    }
  },
  "isContribution": true
}

Definições

Nome	Description
Control	Represente um controle no formulário.
WitContribution

Control

Object

Represente um controle no formulário.

Nome	Tipo	Description
contribution	WitContribution	Contribuição para o controle.
controlType	string	Tipo do controle.
height	integer	Altura do controle para controles html.
id	string	A ID do nó de layout.
inherited	boolean	Um valor que indica se esse nó de layout foi herdado de um layout pai. Espera-se que isso seja definido apenas pelo combinador.
isContribution	boolean	Um valor que indica se o nó de layout é contribuição ou não.
label	string	Rótulo para o campo
metadata	string	Texto interno do controle.
order	integer
overridden	boolean	Um valor que indica se esse nó de layout foi substituído por um layout filho.
readOnly	boolean	Um valor que indica se o controle é somente leitura.
visible	boolean	Um valor que indica se o controle deve estar oculto ou não.
watermark	string	Texto de marca d'água para a caixa de texto.

WitContribution