Condividi tramite

Gestione elementi di lavoro

  • Articolo

Risorse di rilevamento degli elementi di lavoro

È possibile ottenere, creare e aggiornare bug, attività e altri elementi di lavoro per il team. Le query consentono di usare le capacità complete di Work Item Query Language per cercare e filtrare elementi di lavoro. È possibile usare Work Item Query Language per ottenere ogni elemento di lavoro che soddisfa la query. Gli elementi di lavoro mantengono una cronologia completa ed è possibile ottenere ogni revisione completa dell'elemento di lavoro o solo gli aggiornamenti apportati in ogni revisione. È anche possibile contrassegnare gli elementi di lavoro.

Attività comuni

Ottenere elementi di lavoro usando una query

  1. Cercare la query che si vuole usare.
  2. Ottenere i risultati per la query.
  3. Ottenere ognuno degli elementi di lavoro in base all'ID.

Aggiornare WorkItems in batch

Usare l'API Batch WorkItem Update per aggiornare gli elementi di lavoro in batch.

Aggiornare i campi di un elemento di lavoro

  1. Ottenere l'ID dell'elemento di lavoro da aggiornare.
  2. Aggiornare i campi dell'elemento di lavoro.
  1. Ottenere l'ID degli elementi di lavoro da collegare.
  2. Aggiungere un collegamento tra gli elementi di lavoro.

Usare la creazione di un elemento di lavoro e aggiungere un'API di collegamento in una chiamata batch.

Allegare un file a un elemento di lavoro

  1. Ottenere l'ID dell'elemento di lavoro da aggiornare.
  2. Caricare l'allegato nell'archivio allegati.
  3. Aggiungere l'allegato all'elemento di lavoro.

Creare un elemento di lavoro

Creare un elemento di lavoro. Assicurarsi di specificare almeno un titolo. Alcuni tipi di elementi di lavoro richiedono valori per altri campi.

Ottenere la cronologia completa di un elemento di lavoro

  1. Ottenere l'ID dell'elemento di lavoro.
  2. Ottenere un elenco di aggiornamenti apportati a un elemento di lavoro.
  3. Ottiene l'intero elemento di lavoro visualizzato in qualsiasi revisione.

Eliminare un elemento di lavoro

  1. Ottenere l'ID dell'elemento di lavoro.
  2. Eliminare l'elemento di lavoro.

Ottenere i campi usati in un progetto team

  1. Ottiene i tipi di elementi di lavoro usati in un progetto team.
  2. Ottenere ogni tipo di elemento di lavoro per visualizzare i campi usati. Ignorare la maschera xml per fieldinstances.

Ottenere categorie di elementi di lavoro

Usare categorie di elementi di lavoro per ottenere i tipi di elementi di lavoro usati in un progetto team per funzioni diverse. Ad esempio, per visualizzare gli elementi di lavoro visualizzati nel backlog, ottenere la categoria dei requisiti.

Ottenere aree e iterazioni

Ottenere la gerarchia di aree o la gerarchia di iterazione per il progetto team.

Ottenere tipi di relazioni tra elementi di lavoro

Ottenere i tipi disponibili di collegamenti agli elementi di lavoro disponibili nella raccolta di progetti.

Risorse dei metadati degli elementi di lavoro

Gli elementi di lavoro sono regolati dai metadati. Alcuni metadati hanno come ambito un progetto team specifico e altri metadati hanno come ambito una raccolta di progetti, ad esempio la raccolta predefinita dell'account Azure DevOps Services.

Metadati con ambito progetto

Il progetto team ha un set di tipi di elementi di lavoro. Ogni tipo di elemento di lavoro può appartenere a una categoria , ad esempio "requisito" o "bug" per definire il ruolo nel progetto. I nodi di classificazione definiscono il set di valori che possono essere usati nell'area e nei campi di iterazione per gli elementi di lavoro nel progetto team.

Metadati con ambito raccolta

I tipi di elemento di lavoro condividono campi e tipi di relazione (collegamenti e allegati) con altri tipi di elementi di lavoro.

API di aggiornamento batch degli elementi di lavoro

Esegue più richieste di aggiornamento degli elementi di lavoro. La risposta contiene singole risposte per ognuna delle richieste nel batch. Le richieste non riuscite non influiscono sulle richieste successive nel batch.

SEMANTICA DELL'API REST

PATCH https://dev.azure.com/{organization}/_apis/wit/$batch?api-version=6.1

Parametri dell'URI

Nome In Obbligatoria Tipo Descrizione
Organizzazione Percorso True string Nome dell'organizzazione di Azure DevOps.
api-version query string Versione dell'API da usare.
bypassRules query boolean Non applicare le regole del tipo di elemento di lavoro per questo aggiornamento.
suppressNotifications query boolean Non generare alcuna notifica per questa modifica.

Corpo della richiesta

Il corpo della richiesta è composto come elenco di richieste di aggiornamento degli elementi di lavoro. Ogni elemento di questo elenco conterrà tutte le informazioni su una singola richiesta di aggiornamento, inclusi il metodo REST, il percorso, le intestazioni e il corpo.

È possibile consultare la documentazione relativa all'aggiornamento degli elementi di lavoro per informazioni dettagliate su una singola richiesta.

Esempio di aggiornamento batch

Richiesta

PATCH https://dev.azure.com/fabrikam/_apis/wit/$batch?api-version=6.1

Corpo della richiesta

[
  {
    // Add priority and test rev on work item with id 1
    "method": "PATCH",
    "uri": "/_apis/wit/workitems/1?api-version=6.1",
    "headers": {
      "Content-Type": "application/json-patch+json"
    },
    "body": [
      {
        "op": "test",
        "path": "/rev",
        "value": 3
      },
      {
        "op": "add",
        "path": "/fields/Microsoft.VSTS.Common.Priority",
        "value": "1"
      }
    ]
  },
  {
    // Replace tags on work item with id 299x   
    "method": "PATCH",
    "uri": "/_apis/wit/workitems/299?api-version=6.1",
    "headers": {
      "Content-Type": "application/json-patch+json"
    },
    "body": [
      {
        "op": "replace",
        "path": "/fields/System.Tags",
        "value": "Tag1; Tag2"
      }
    ]
  },
  {
    // You can also use Work Item Create format
    "method": "PATCH",
    "uri": "/mytestprojectname/_apis/wit/workitems/$Bug?api-version=4.1",
    "headers": {
        "Content-Type": "application/json-patch+json"
    },
    "body": [
        {
            "op": "add",
            "path": "/id",
            "value": "-1"
        },
        {
            "op": "add",
            "path": "/fields/System.Title",
            "from": null,
            "value": "Sample 1"
        }
    ]
  },
]

Response.

La risposta è costituita da singole risposte per ogni richiesta di aggiornamento in batch.

  • count : numero di risposte di aggiornamento in batch restituite
  • value : elenco di oggetti risposta con il codice di risposta, le intestazioni e il corpo
{
  "count": 2,
  "value": [
    {
      "code": 200,
      "headers": {
        "Content-Type": "application/json; charset=utf-8"
      },
      "body": "{work item object}"
    },
    {
      "code": 200,
      "headers": {
        "Content-Type": "application/json; charset=utf-8"
      },
      "body": "{work item object}"
    }
  ]
}