Condividi tramite

Work Items - Get Work Items Batch

  • Riferimento
Servizio:
Work Item Tracking
Versione API:
7.1

Ottiene gli elementi di lavoro per un elenco di ID elemento di lavoro (massimo 200)

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsbatch?api-version=7.1

Parametri dell'URI

Nome In Necessario Tipo Descrizione
organization
 path True

string

Nome dell'organizzazione di Azure DevOps.
project
 path

string

ID progetto o nome progetto
api-version
 query True

string

Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.

Corpo della richiesta

Nome Tipo Descrizione
$expand

WorkItemExpand

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { None, Relations, Fields, Links, All }
asOf

string (date-time)

Stringa di data e ora UTC AsOf
errorPolicy

WorkItemErrorPolicy

Flag per controllare i criteri di errore in una richiesta di recupero bulk degli elementi di lavoro. Le opzioni possibili sono {Fail, Omit}.
fields

string[]

Campi richiesti
ids

integer[] (int32)

ID dell'elemento di lavoro richiesto

Risposte

Nome Tipo Descrizione
200 OK

WorkItem[]

operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Ambiti

Nome Descrizione
vso.work Concede la possibilità di leggere elementi di lavoro, query, lavagne, percorsi di aree e iterazioni e altri metadati correlati al rilevamento degli elementi di lavoro. Concede inoltre la possibilità di eseguire query, cercare elementi di lavoro e ricevere notifiche sugli eventi degli elementi di lavoro tramite hook del servizio.

Esempio

Get list of work items for specific fields

Esempio di richiesta

POST https://dev.azure.com/fabrikam/_apis/wit/workitemsbatch?api-version=7.1

{
  "ids": [
    297,
    299,
    300
  ],
  "fields": [
    "System.Id",
    "System.Title",
    "System.WorkItemType",
    "Microsoft.VSTS.Scheduling.RemainingWork"
  ]
}

Risposta di esempio

Codice di stato:
200 
{
  "count": 3,
  "value": [
    {
      "id": 297,
      "rev": 1,
      "fields": {
        "System.Id": 297,
        "System.WorkItemType": "Product Backlog Item",
        "System.Title": "Customer can sign in using their Microsoft Account"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
    },
    {
      "id": 299,
      "rev": 7,
      "fields": {
        "System.Id": 299,
        "System.WorkItemType": "Task",
        "System.Title": "JavaScript implementation for Microsoft Account",
        "Microsoft.VSTS.Scheduling.RemainingWork": 4
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
    },
    {
      "id": 300,
      "rev": 1,
      "fields": {
        "System.Id": 300,
        "System.WorkItemType": "Task",
        "System.Title": "Unit Testing for MSA login",
        "Microsoft.VSTS.Scheduling.RemainingWork": 3
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
    }
  ]
}

Definizioni

Nome Descrizione
ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.
WorkItem

Descrive un elemento di lavoro.
WorkItemBatchGetRequest

Descrive una richiesta per ottenere un set di elementi di lavoro
WorkItemCommentVersionRef

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

Flag per controllare i criteri di errore in una richiesta di recupero bulk degli elementi di lavoro. Le opzioni possibili sono {Fail, Omit}.
WorkItemExpand

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { None, Relations, Fields, Links, All }
WorkItemRelation
Object

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

Object

Descrive un elemento di lavoro.

Nome Tipo Descrizione
_links

ReferenceLinks

Collegamenti ai riferimenti 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 (int32)

ID elemento di lavoro.
relations

WorkItemRelation[]

Relazioni dell'elemento di lavoro.
rev

integer (int32)

Numero di revisione dell'elemento di lavoro.
url

string

WorkItemBatchGetRequest

Object

Descrive una richiesta per ottenere un set di elementi di lavoro

Nome Tipo Descrizione
$expand

WorkItemExpand

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { None, Relations, Fields, Links, All }
asOf

string (date-time)

Stringa di data e ora UTC AsOf
errorPolicy

WorkItemErrorPolicy

Flag per controllare i criteri di errore in una richiesta di recupero bulk degli elementi di lavoro. Le opzioni possibili sono {Fail, Omit}.
fields

string[]

Campi richiesti
ids

integer[] (int32)

ID dell'elemento di lavoro richiesto

WorkItemCommentVersionRef

Object

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

Nome Tipo Descrizione
commentId

integer (int32)

ID assegnato al commento.
createdInRevision

integer (int32)

[Interno] Revisione dell'elemento di lavoro in cui è stato originariamente aggiunto questo commento.
isDeleted

boolean

[Interno] Specifica se il commento è stato eliminato.
text

string

[Interno] Testo del commento.
url

string

version

integer (int32)

Numero di versione.

WorkItemErrorPolicy

Enumerazione

Flag per controllare i criteri di errore in una richiesta di recupero bulk degli elementi di lavoro. Le opzioni possibili sono {Fail, Omit}.

Valore Descrizione
fail

Errore di lavoro non riuscita.
omit

Omettere i criteri di errore di lavoro.

WorkItemExpand

Enumerazione

Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { None, Relations, Fields, Links, All }

Valore Descrizione
all

Espande tutto.
fields

Espandere l'elemento di lavoro Campi.
links

Espandere l'elemento di lavoro Collegamenti.
none

Comportamento predefinito.
relations

Espansione dell'elemento di lavoro Relazioni.

WorkItemRelation

Object
Nome Tipo Descrizione
attributes

object

Raccolta di attributi di collegamento.
rel

string

Tipo di relazione.
url

string

URL del collegamento.