Work Items - Create

Riferimento

Service:: Work Item Tracking

API Version:: 5.0

Crea un singolo elemento di lavoro.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome del progetto
type	path	True	string	Tipo di elemento di lavoro dell'elemento di lavoro da creare
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '5.0' per usare questa versione dell'API.
bypassRules	query		boolean	Non applicare le regole del tipo di elemento di lavoro per questo aggiornamento
suppressNotifications	query		boolean	Non generare notifiche per questa modifica
validateOnly	query		boolean	Indicare se si desidera solo convalidare le modifiche senza salvare l'elemento di lavoro

Corpo della richiesta

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

Nome	Tipo	Descrizione
from	string	Percorso da da per l'operazione Di spostamento/copia.
op	Operation	Operazione patch
path	string	Percorso dell'operazione
value	object	Valore dell'operazione. Si tratta di una primitiva o di un JToken.

Risposte

Nome	Tipo	Descrizione
200 OK	WorkItem	operazione riuscita

Sicurezza

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	Descrizione
vso.work_write	Concede la possibilità di leggere, creare e aggiornare elementi di lavoro e query, aggiornare i metadati della scheda, l'area di lettura e le iterazioni dei percorsi di altri metadati correlati al rilevamento degli elementi di lavoro, eseguire query e ricevere notifiche sugli eventi degli elementi di lavoro tramite hook del servizio.

Esempio

Create work item

Sample Request

HTTP

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

[
  {
    "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"
}

Definizioni

Nome	Descrizione
JsonPatchDocument	Modello JSON per operazioni patch JSON
Operation	Operazione patch
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
WorkItem	Descrive un elemento di lavoro.
WorkItemRelation

JsonPatchDocument

Modello JSON per operazioni patch JSON

Nome	Tipo	Descrizione
from	string	Percorso da da per l'operazione Di spostamento/copia.
op	Operation	Operazione patch
path	string	Percorso dell'operazione
value	object	Valore dell'operazione. Si tratta di una primitiva o di un JToken.

Operation

Operazione patch

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

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

WorkItem

Descrive un elemento di lavoro.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegare i riferimenti alle risorse REST correlate.
fields	object	Mappa di campi e valori per l'elemento di lavoro.
id	integer	ID elemento di lavoro.
relations	WorkItemRelation[]	Relazioni dell'elemento di lavoro.
rev	integer	Numero di revisione dell'elemento di lavoro.
url	string

WorkItemRelation

Nome	Tipo	Descrizione
attributes	object	Raccolta di attributi di collegamento.
rel	string	Tipo di relazione.
url	string	URL di collegamento.

Condividi tramite