Condividi tramite


Work Items - Create

Crea un singolo elemento di lavoro.

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3
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

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 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. Questa opzione deve essere impostata su '7.1-preview.3' per usare questa versione dell'API.

$expand
query

WorkItemExpand

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { Nessuna, Relazioni, Campi, Collegamenti, Tutti }.

bypassRules
query

boolean

Non applicare le regole del tipo di elemento di lavoro in questo aggiornamento

suppressNotifications
query

boolean

Non generare notifiche per questa modifica

validateOnly
query

boolean

Indicare se si desidera convalidare solo le modifiche senza salvare l'elemento di lavoro

Corpo della richiesta

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

Nome Tipo Descrizione
from

string

Percorso da cui copiare per l'operazione Sposta/Copia.

op

Operation

Operazione di patch

path

string

Percorso dell'operazione. Nel caso di una matrice, è possibile utilizzare un indice in base zero per specificare la posizione nella matrice , ad esempio /biscotti/0/nome. Il carattere "-" può essere usato anziché un indice per inserire alla fine della matrice (ad esempio /biscotti/-).

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 di aggiornamento, l'area di lettura e i percorsi di iterazione di altri metadati correlati agli elementi di lavoro, eseguire query e ricevere notifiche sugli eventi dell'elemento di lavoro tramite hook del servizio.

Esempio

Create work item

Sample Request

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

{
  "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 di patch

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

WorkItem

Descrive un elemento di lavoro.

WorkItemCommentVersionRef

Rappresenta il riferimento a una versione specifica di un commento in un elemento di lavoro.

WorkItemExpand

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { Nessuna, Relazioni, Campi, Collegamenti, Tutti }

WorkItemRelation

JsonPatchDocument

Modello JSON per operazioni patch JSON

Nome Tipo Descrizione
from

string

Percorso da cui copiare per l'operazione Sposta/Copia.

op

Operation

Operazione di patch

path

string

Percorso dell'operazione. Nel caso di una matrice, è possibile utilizzare un indice in base zero per specificare la posizione nella matrice , ad esempio /biscotti/0/nome. Il carattere "-" può essere usato anziché un indice per inserire alla fine della matrice (ad esempio /biscotti/-).

value

object

Valore dell'operazione. Si tratta di una primitiva o di un JToken.

Operation

Operazione di patch

Nome Tipo Descrizione
add

string

copy

string

move

string

remove

string

replace

string

test

string

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

WorkItem

Descrive un elemento di lavoro.

Nome Tipo Descrizione
_links

ReferenceLinks

Riferimenti ai collegamenti alle risorse REST correlate.

commentVersionRef

WorkItemCommentVersionRef

Riferimento a una versione specifica del commento aggiunto/modificato/eliminato in questa revisione.

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

WorkItemCommentVersionRef

Rappresenta il riferimento a una versione specifica di un commento in un elemento di lavoro.

Nome Tipo Descrizione
commentId

integer

ID assegnato al commento.

createdInRevision

integer

[Interno] Revisione dell'elemento di lavoro in cui è stato aggiunto il commento in origine.

isDeleted

boolean

[Interno] Specifica se il commento è stato eliminato.

text

string

[Interno] Testo del commento.

url

string

version

integer

Numero di versione.

WorkItemExpand

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { Nessuna, Relazioni, Campi, Collegamenti, Tutti }

Nome Tipo Descrizione
all

string

Espande tutto.

fields

string

Espandere l'elemento di lavoro campi.

links

string

Espandere l'elemento di lavoro collegamenti.

none

string

Comportamento predefinito.

relations

string

Espandere l'elemento di lavoro Relazioni.

WorkItemRelation

Nome Tipo Descrizione
attributes

object

Raccolta di attributi di collegamento.

rel

string

Tipo di relazione.

url

string

URL di collegamento.