Work Items - Create

Referência

Service:: Work Item Tracking

API Version:: 7.1-preview.3

Cria um único item de trabalho.

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&$expand={$expand}&api-version=7.1-preview.3

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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	O tipo de item de trabalho do item de trabalho a ser criado
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		WorkItemExpand	Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }.
bypassRules	query		boolean	Não impor as regras de tipo de item de trabalho nesta atualização
suppressNotifications	query		boolean	Não acione nenhuma notificação para essa alteração
validateOnly	query		boolean	Indique se você deseja apenas validar as alterações sem salvar o item de trabalho

Corpo da solicitação

Media Types: "application/json-patch+json"

Nome	Tipo	Description
from	string	O caminho do qual copiar para a operação Mover/Copiar.
op	Operation	A operação de patch
path	string	O caminho para a operação. No caso de uma matriz, um índice baseado em zero pode ser usado para especificar a posição na matriz (por exemplo, /biscuits/0/name). O caractere "-" pode ser usado em vez de um índice para inserir no final da matriz (por exemplo, /biscuits/-).
value	object	O valor da operação. Este é um primitivo ou um JToken.

Respostas

Nome	Tipo	Description
200 OK	WorkItem	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_write	Concede a capacidade de ler, criar e atualizar itens de trabalho e consultas, atualizar metadados do quadro, ler caminhos de área e iterações de outros itens de trabalho que acompanham metadados relacionados, executar consultas e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.

Exemplos

Create work item

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3

[
  {
    "op": "add",
    "path": "/fields/System.Title",
    "from": null,
    "value": "Sample task"
  }
]

Sample Response

Status code:: 200

{
  "id": 131489,
  "rev": 1,
  "fields": {
    "System.AreaPath": "CustomProcessPrj",
    "System.TeamProject": "CustomProcessPrj",
    "System.IterationPath": "CustomProcessPrj",
    "System.WorkItemType": "Task",
    "System.State": "New",
    "System.Reason": "New",
    "System.CreatedDate": "2017-10-06T01:04:51.57Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2017-10-06T01:04:51.57Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "Sample task",
    "Microsoft.VSTS.Common.StateChangeDate": "2017-10-06T01:04:51.57Z",
    "Microsoft.VSTS.Common.Priority": 2
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
    },
    "workItemUpdates": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/updates"
    },
    "workItemRevisions": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/revisions"
    },
    "workItemHistory": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/history"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=20cda608-32f0-4e6e-9b7c-8def7b38d15a&id=131489"
    },
    "workItemType": {
      "href": "https://dev.azure.com/fabrikam/aaee31d9-14cf-48b9-a92b-3f1446c13f80/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
}

Definições

Nome	Description
JsonPatchDocument	O modelo JSON para operações de patch JSON
Operation	A operação de patch
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
WorkItem	Descreve um item de trabalho.
WorkItemCommentVersionRef	Representa a referência a uma versão específica de um comentário em um Item de Trabalho.
WorkItemExpand	Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }
WorkItemRelation

JsonPatchDocument

O modelo JSON para operações de patch JSON

Nome	Tipo	Description
from	string	O caminho do qual copiar para a operação Mover/Copiar.
op	Operation	A operação de patch
path	string	O caminho para a operação. No caso de uma matriz, um índice baseado em zero pode ser usado para especificar a posição na matriz (por exemplo, /biscuits/0/name). O caractere "-" pode ser usado em vez de um índice para inserir no final da matriz (por exemplo, /biscuits/-).
value	object	O valor da operação. Este é um primitivo ou um JToken.

Operation

A operação de patch

Nome	Tipo	Description
add	string
copy	string
move	string
remove	string
replace	string
test	string

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.

WorkItem

Descreve um item de trabalho.

Nome	Tipo	Description
_links	ReferenceLinks	Vincular referências a recursos REST relacionados.
commentVersionRef	WorkItemCommentVersionRef	Referência a uma versão específica do comentário adicionado/editado/excluído nesta revisão.
fields	object	Mapa de campos e valores para o item de trabalho.
id	integer	O ID do item de trabalho.
relations	WorkItemRelation[]	Relações do item de trabalho.
rev	integer	Número de revisão do item de trabalho.
url	string

WorkItemCommentVersionRef

Representa a referência a uma versão específica de um comentário em um Item de Trabalho.

Nome	Tipo	Description
commentId	integer	A ID atribuída ao comentário.
createdInRevision	integer	[Interno] A revisão do item de trabalho em que este comentário foi originalmente adicionado.
isDeleted	boolean	[Interno] Especifica se o comentário foi excluído.
text	string	[Interno] O texto do comentário.
url	string
version	integer	O número de versão.

WorkItemExpand

Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }

Nome	Tipo	Description
all	string	Expande tudo.
fields	string	Os campos do item de trabalho se expandem.
links	string	Links item de trabalho expandir.
none	string	Comportamento padrão.
relations	string	O item de trabalho relações se expande.

WorkItemRelation

Nome	Tipo	Description
attributes	object	Coleção de atributos de link.
rel	string	Tipo de relação.
url	string	Url do link.

Compartilhar via