Projects - Update

Referência

Service:: Core

API Version:: 7.1-preview.4

Atualize o nome, a abreviação, a descrição ou a restauração de um projeto existente.

PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version=7.1-preview.4

Parâmetros de URI

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

Corpo da solicitação

Nome	Tipo	Description
_links	ReferenceLinks	Os links para outros objetos relacionados a esse objeto.
abbreviation	string	Abreviação do projeto.
capabilities	object	Conjunto de recursos que este projeto tem (como modelo de processo & controle de versão).
defaultTeam	WebApiTeamRef	A referência superficial para a equipe padrão.
defaultTeamImageUrl	string	Url para a imagem de identidade de equipe padrão.
description	string	A descrição do projeto (se houver).
id	string	Identificador do projeto.
lastUpdateTime	string	Hora da última atualização do projeto.
name	string	Nome do projeto.
revision	integer	Revisão do projeto.
state	ProjectState	Estado do projeto.
url	string	URL para a versão completa do objeto.
visibility	ProjectVisibility	Visibilidade do projeto.

Respostas

Nome	Tipo	Description
200 OK	OperationReference	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.project_write	Concede a capacidade de ler e atualizar projetos e equipes.

Definições

Nome	Description
OperationReference	Referência para uma operação assíncrona.
OperationStatus	O status atual da operação.
ProjectState	O estado atual do projeto.
ProjectVisibility	Indica a quem o projeto está visível.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
TeamProject	Representa um objeto Team Project.
WebApiTeamRef

OperationReference

Referência para uma operação assíncrona.

Nome	Tipo	Description
id	string	Identificador exclusivo para a operação.
pluginId	string	Identificador exclusivo para o plug-in.
status	OperationStatus	O status atual da operação.
url	string	URL para obter o objeto de operação completo.

OperationStatus

O status atual da operação.

Nome	Tipo	Description
cancelled	string	A operação foi cancelada pelo usuário.
failed	string	A operação foi concluída com uma falha.
inProgress	string	A operação está em andamento.
notSet	string	A operação não tem um conjunto de status.
queued	string	A operação foi enfileirada.
succeeded	string	A operação foi concluída com sucesso.

ProjectState

O estado atual do projeto.

Nome	Tipo	Description
all	string	Todos os projetos, independentemente do estado, exceto Excluídos.
createPending	string	O projeto foi enfileirado para criação, mas o processo ainda não foi iniciado.
deleted	string	O projeto foi excluído.
deleting	string	O Project está em processo de exclusão.
new	string	O projeto está em processo de criação.
unchanged	string	O projeto não foi alterado.
wellFormed	string	O project é completamente criado e pronto para uso.

ProjectVisibility

Indica a quem o projeto está visível.

Nome	Tipo	Description
private	string	O projeto só é visível para usuários com acesso explícito.
public	string	O projeto é visível para todos.

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.

TeamProject

Representa um objeto Team Project.

Nome	Tipo	Description
_links	ReferenceLinks	Os links para outros objetos relacionados a esse objeto.
abbreviation	string	Abreviação do projeto.
capabilities	object	Conjunto de recursos que este projeto tem (como modelo de processo & controle de versão).
defaultTeam	WebApiTeamRef	A referência superficial para a equipe padrão.
defaultTeamImageUrl	string	Url para a imagem de identidade de equipe padrão.
description	string	A descrição do projeto (se houver).
id	string	Identificador do projeto.
lastUpdateTime	string	Hora da última atualização do projeto.
name	string	Nome do projeto.
revision	integer	Revisão do projeto.
state	ProjectState	Estado do projeto.
url	string	URL para a versão completa do objeto.
visibility	ProjectVisibility	Visibilidade do projeto.

WebApiTeamRef

Nome	Tipo	Description
id	string	Guid da Equipe (Identidade). Uma ID do Team Foundation.
name	string	Nome da equipe
url	string	URL da API REST da Equipe

Partilhar via