Work Items - Get Work Item Template
Restituisce un singolo elemento di lavoro da un modello.
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?fields={fields}&asOf={asOf}&$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 |
Nome del tipo di elemento di lavoro |
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 |
Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { Nessuna, Relazioni, Campi, Collegamenti, Tutti }. |
||
as
|
query |
string date-time |
Stringa di ora della data UTC AsOf |
|
fields
|
query |
string |
Elenco delimitato da virgole di campi richiesti |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
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 | Concede la possibilità di leggere elementi di lavoro, query, schede, aree e percorsi 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 dell'elemento di lavoro tramite hook del servizio. |
Esempio
Returns a single work item from a template
Sample Request
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3
Sample Response
{
"fields": {
"System.WorkItemType": "Bug",
"System.AreaPath": "Test Project",
"System.TeamProject": "Test Project",
"System.IterationPath": "Test Project",
"System.State": "New",
"System.Reason": "New",
"Microsoft.VSTS.Common.StateChangeDate": "1753-01-01T00:00:00Z",
"System.ChangedBy": {
"displayName": "Fabricam Zhang",
"url": "https://app.vssps.visualstudio.com/Accf03646-3dbb-4c84-91f3-739a6c8797a1/_apis/Identities/5f499b36-f993-6330-9295-1abf1a669337",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabricam3/_apis/GraphProfile/MemberAvatars/msa.NWY0OTliMzYtZjk5My03MzMwLTkyOTUtMWFiZjFhNjY5MzM3"
}
},
"id": "5f499b36-f993-6330-9295-1abf1a669337",
"uniqueName": "fabricam2@outlook.com",
"imageUrl": "https://dev.azure.com/fabricam3/_api/_common/identityImage?id=5f499b36-f993-6330-9295-1abf1a669337",
"descriptor": "msa.NWY0OTliMzYtZjk5My03MzMwLTkyOTUtMWFiZjFhNjY5MzM3"
},
"System.CreatedBy": {
"displayName": "Fabricam Zhang",
"url": "https://app.vssps.visualstudio.com/Accf03646-3dbb-4c84-91f3-739a6c8797a1/_apis/Identities/5f499b36-f993-6330-9295-1abf1a669337",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabricam3/_apis/GraphProfile/MemberAvatars/msa.NWY0OTliMzYtZjk5My03MzMwLTkyOTUtMWFiZjFhNjY5MzM3"
}
},
"id": "5f499b36-f993-6330-9295-1abf1a669337",
"uniqueName": "fabricam2@outlook.com",
"imageUrl": "https://dev.azure.com/fabricam3/_api/_common/identityImage?id=5f499b36-f993-6330-9295-1abf1a669337",
"descriptor": "msa.NWY0OTliMzYtZjk5My03MzMwLTkyOTUtMWFiZjFhNjY5MzM3"
},
"Microsoft.VSTS.Common.Priority": 2,
"Microsoft.VSTS.Common.Severity": "3 - Medium",
"Microsoft.VSTS.Common.ValueArea": "Business"
},
"_links": {
"workItemType": {
"href": "https://dev.azure.com/fabricam3/c1b5ee8b-7c3f-4e7d-bb53-ce022cf5af4b/_apis/wit/workItemTypes/Bug"
},
"fields": {
"href": "https://dev.azure.com/fabricam3/c1b5ee8b-7c3f-4e7d-bb53-ce022cf5af4b/_apis/wit/fields"
}
},
"url": "https://dev.azure.com/fabricam3/c1b5ee8b-7c3f-4e7d-bb53-ce022cf5af4b/_apis/wit/workItems"
}
Definizioni
Nome | Descrizione |
---|---|
Reference |
Classe da rappresentare una raccolta di collegamenti di riferimento REST. |
Work |
Descrive un elemento di lavoro. |
Work |
Rappresenta il riferimento a una versione specifica di un commento in un elemento di lavoro. |
Work |
Parametri di espansione per gli attributi dell'elemento di lavoro. Le opzioni possibili sono { Nessuna, Relazioni, Campi, Collegamenti, Tutti } |
Work |
ReferenceLinks
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 |
Riferimenti ai collegamenti alle risorse REST correlate. |
|
commentVersionRef |
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 |
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. |
Commenti e suggerimenti
https://aka.ms/ContentUserFeedback.
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedereInvia e visualizza il feedback per