Condividi tramite

Queries - Get Queries Batch

  • Riferimento
Service:
Work Item Tracking
API Version:
7.1-preview.1

Ottiene un elenco di query in base agli ID (massimo 1000)

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

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
api-version
 query True

string

Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.1' per usare questa versione dell'API.

Corpo della richiesta

Nome Tipo Descrizione
$expand

QueryExpand

Parametri di espansione per le query. Le opzioni possibili sono { Nessuno, Wiql, Clausole, All, Minimal }
errorPolicy

QueryErrorPolicy

Flag per controllare i criteri di errore in una richiesta batch di query. Le opzioni possibili sono { Fail, Omit }.
ids

string[]

ID query richiesti

Risposte

Nome Tipo Descrizione
200 OK

QueryHierarchyItem[]

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

Gets a list of queries by ids

Sample Request

POST https://dev.azure.com/fabrikam/{project}/_apis/wit/queriesbatch?api-version=7.1-preview.1

{
  "ids": [
    "c6725763-d9ae-487e-bb42-00222e2f4d9f",
    "c19eec2d-07a0-4c20-be57-3f7903792ca6",
    "298f94fd-30ea-40f3-8d25-3202c9effa3a"
  ]
}

Sample Response

Status code:
200 
{
  "count": 3,
  "value": [
    {
      "id": "c6725763-d9ae-487e-bb42-00222e2f4d9f",
      "name": "Work Items With Summary Values",
      "path": "Shared Queries/Troubleshooting/Work Items With Summary Values",
      "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"
      },
      "createdDate": "2018-09-26T19:01:44.6Z",
      "lastModifiedBy": {
        "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"
      },
      "lastModifiedDate": "2018-09-26T19:01:44.6Z",
      "queryType": "oneHop",
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c6725763-d9ae-487e-bb42-00222e2f4d9f"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=c6725763-d9ae-487e-bb42-00222e2f4d9f"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/0389af80-0be8-4c1b-800e-9e91d081e052"
        },
        "wiql": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/wiql/c6725763-d9ae-487e-bb42-00222e2f4d9f"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c6725763-d9ae-487e-bb42-00222e2f4d9f"
    },
    {
      "id": "c19eec2d-07a0-4c20-be57-3f7903792ca6",
      "name": "Product Planning",
      "path": "Shared Queries/Product Planning",
      "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"
      },
      "createdDate": "2018-09-26T19:01:44.6Z",
      "lastModifiedBy": {
        "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"
      },
      "lastModifiedDate": "2018-09-26T19:01:44.6Z",
      "queryType": "flat",
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c19eec2d-07a0-4c20-be57-3f7903792ca6"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=c19eec2d-07a0-4c20-be57-3f7903792ca6"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/06285cdf-e6f2-4230-80fd-66a2e11116d2"
        },
        "wiql": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/wiql/c19eec2d-07a0-4c20-be57-3f7903792ca6"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c19eec2d-07a0-4c20-be57-3f7903792ca6"
    },
    {
      "id": "298f94fd-30ea-40f3-8d25-3202c9effa3a",
      "name": "Current Iteration",
      "path": "Shared Queries/Current Iteration",
      "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"
      },
      "createdDate": "2018-09-26T19:01:44.6Z",
      "lastModifiedBy": {
        "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"
      },
      "lastModifiedDate": "2018-09-26T19:01:44.6Z",
      "isFolder": true,
      "hasChildren": true,
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/298f94fd-30ea-40f3-8d25-3202c9effa3a"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=298f94fd-30ea-40f3-8d25-3202c9effa3a"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/06285cdf-e6f2-4230-80fd-66a2e11116d2"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/298f94fd-30ea-40f3-8d25-3202c9effa3a"
    }
  ]
}

Definizioni

Nome Descrizione
IdentityReference

Descrive un riferimento a un'identità.
LinkQueryMode

Modalità di query di collegamento.
LogicalOperation

Operatore logico che separa la clausola condition
QueryBatchGetRequest

Descrive una richiesta per ottenere un elenco di query
QueryErrorPolicy

Flag per controllare i criteri di errore in una richiesta batch di query. Le opzioni possibili sono { Fail, Omit }.
QueryExpand

Parametri di espansione per le query. Le opzioni possibili sono { None, Wiql, Clauses, All, Minimal }
QueryHierarchyItem

Rappresenta un elemento nella gerarchia di query degli elementi di lavoro. Può trattarsi di una query o di una cartella.
QueryRecursionOption

Opzione di ricorsione da usare in una query albero.
QueryType

Tipo di query.
ReferenceLinks

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

Descrive un'operazione sul campo dell'elemento di lavoro.
WorkItemFieldReference

Riferimento a un campo in un elemento di lavoro
WorkItemQueryClause

Rappresenta una clausola in una query dell'elemento di lavoro. Viene visualizzata la struttura di una query dell'elemento di lavoro.
WorkItemQuerySortColumn

Colonna di ordinamento.

IdentityReference

Descrive un riferimento a un'identità.

Nome Tipo Descrizione
_links

ReferenceLinks

Questo campo contiene zero o più collegamenti interessanti sull'oggetto del grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo oggetto grafico.
descriptor

string

Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso oggetto grafico in account e organizzazioni.
directoryAlias

string

Deprecato: può essere recuperato eseguendo una query sull'utente graph a cui si fa riferimento nella voce "self" del dizionario "_links" IdentityRef
displayName

string

Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine.
id

string

imageUrl

string

Deprecato : disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive

boolean

Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza graph a cui si fa riferimento nella voce "membershipState" del dizionario GraphUser "_links"
isAadIdentity

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

name

string

Proprietà back-compat legacy. Questo è stato il valore specifico WIT di Constants. Verrà nascosto (ma esiste) nel client, a meno che non abbiano come destinazione la versione più recente
profileUrl

string

Deprecato: non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName

string

Deprecato: usare invece Domain+PrincipalName
url

string

Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

LinkQueryMode

Modalità di query di collegamento.

Nome Tipo Descrizione
linksOneHopDoesNotContain

string

Restituisce gli elementi di lavoro che soddisfano l'origine, solo se nessun elemento di lavoro collegato soddisfa i criteri di collegamento e di destinazione.
linksOneHopMayContain

string

Restituisce elementi di lavoro che soddisfano i criteri di origine e collegamento, anche se nessun elemento di lavoro collegato soddisfa i criteri di destinazione.
linksOneHopMustContain

string

Restituisce gli elementi di lavoro in cui vengono soddisfatti tutti i criteri di origine, destinazione e collegamento.
linksRecursiveDoesNotContain

string

linksRecursiveMayContain

string

Restituisce elementi di lavoro una gerarchia di elementi di lavoro che per impostazione predefinita soddisfano l'origine
linksRecursiveMustContain

string

workItems

string

Restituisce un elenco semplice di elementi di lavoro.

LogicalOperation

Operatore logico che separa la clausola condition

Nome Tipo Descrizione
and

string

none

string

or

string

QueryBatchGetRequest

Descrive una richiesta per ottenere un elenco di query

Nome Tipo Descrizione
$expand

QueryExpand

Parametri di espansione per le query. Le opzioni possibili sono { None, Wiql, Clauses, All, Minimal }
errorPolicy

QueryErrorPolicy

Flag per controllare i criteri di errore in una richiesta batch di query. Le opzioni possibili sono { Fail, Omit }.
ids

string[]

ID di query richiesti

QueryErrorPolicy

Flag per controllare i criteri di errore in una richiesta batch di query. Le opzioni possibili sono { Fail, Omit }.

Nome Tipo Descrizione
fail

string

omit

string

QueryExpand

Parametri di espansione per le query. Le opzioni possibili sono { None, Wiql, Clauses, All, Minimal }

Nome Tipo Descrizione
all

string

Espande tutte le proprietà
clauses

string

Espande colonne, collegamenti, changeinfo, testo e clausole WIQL
minimal

string

Visualizza le proprietà minime e il testo WIQL
none

string

Espande colonne, collegamenti e ChangeInfo
wiql

string

Espande colonne, collegamenti, changeinfo e testo WIQL

QueryHierarchyItem

Rappresenta un elemento nella gerarchia di query degli elementi di lavoro. Può trattarsi di una query o di una cartella.

Nome Tipo Descrizione
_links

ReferenceLinks

Collegare i riferimenti alle risorse REST correlate.
children

QueryHierarchyItem[]

Elementi di query figlio all'interno di una cartella di query.
clauses

WorkItemQueryClause

Clausole per una query flat.
columns

WorkItemFieldReference[]

Colonne della query.
createdBy

IdentityReference

Identità che ha creato l'elemento di query.
createdDate

string

Al momento della creazione dell'elemento di query.
filterOptions

LinkQueryMode

Modalità di query di collegamento.
hasChildren

boolean

Se si tratta di una cartella di query, indica se contiene elementi figlio.
id

string

ID dell'elemento di query.
isDeleted

boolean

Indica se l'elemento di query viene eliminato. Se si imposta su false in un elemento di query eliminato, verrà annullata l'eliminazione. L'annullamento dell'eliminazione di una query o di una cartella non restituirà le modifiche alle autorizzazioni applicate in precedenza.
isFolder

boolean

Indica se si tratta di una cartella di query o di una query.
isInvalidSyntax

boolean

Indica se wiql della query non è valido. Ciò potrebbe essere dovuto a una sintassi non valida o a un percorso di area/iterazione non valido.
isPublic

boolean

Indica se l'elemento di query è pubblico o privato.
lastExecutedBy

IdentityReference

Identità dell'ultima esecuzione della query.
lastExecutedDate

string

Data dell'ultima esecuzione della query.
lastModifiedBy

IdentityReference

Identità dell'ultima modifica dell'elemento di query.
lastModifiedDate

string

Data dell'ultima modifica dell'elemento di query.
linkClauses

WorkItemQueryClause

Clausola di query di collegamento.
name

string

Nome dell'elemento di query.
path

string

Percorso dell'elemento di query.
queryRecursionOption

QueryRecursionOption

Opzione di ricorsione da usare in una query albero.
queryType

QueryType

Tipo di query.
sortColumns

WorkItemQuerySortColumn[]

Colonne di ordinamento della query.
sourceClauses

WorkItemQueryClause

Clausole di origine in una query di collegamento ad albero o un hop.
targetClauses

WorkItemQueryClause

Clausole di destinazione in una query di collegamento ad albero o un hop.
url

string

wiql

string

Testo WIQL della query

QueryRecursionOption

Opzione di ricorsione da usare in una query albero.

Nome Tipo Descrizione
childFirst

string

Restituisce elementi di lavoro che soddisfano i criteri di destinazione, anche se nessun elemento di lavoro soddisfa i criteri di origine e collegamento.
parentFirst

string

Restituisce elementi di lavoro che soddisfano l'origine, anche se nessun elemento di lavoro collegato soddisfa i criteri di destinazione e collegamento.

QueryType

Tipo di query.

Nome Tipo Descrizione
flat

string

Ottiene un elenco semplice di elementi di lavoro.
oneHop

string

Ottiene un elenco di elementi di lavoro e i relativi collegamenti diretti.
tree

string

Ottiene un albero di elementi di lavoro che mostra la gerarchia dei collegamenti.

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.

WorkItemFieldOperation

Descrive un'operazione sul campo dell'elemento di lavoro.

Nome Tipo Descrizione
name

string

Nome descrittivo dell'operazione.
referenceName

string

Nome di riferimento dell'operazione.

WorkItemFieldReference

Riferimento a un campo in un elemento di lavoro

Nome Tipo Descrizione
name

string

Nome descrittivo del campo.
referenceName

string

Nome di riferimento del campo.
url

string

URL REST della risorsa.

WorkItemQueryClause

Rappresenta una clausola in una query dell'elemento di lavoro. Viene visualizzata la struttura di una query dell'elemento di lavoro.

Nome Tipo Descrizione
clauses

WorkItemQueryClause[]

Clausole figlio se la clausola corrente è un operatore logico
field

WorkItemFieldReference

Campo associato alla condizione
fieldValue

WorkItemFieldReference

Lato destro della condizione quando un campo per il confronto tra campi
isFieldValue

boolean

Determina se si tratta di un campo per il confronto tra campi
logicalOperator

LogicalOperation

Operatore logico che separa la clausola condition
operator

WorkItemFieldOperation

Operatore field
value

string

Lato destro della condizione quando un campo per il confronto dei valori

WorkItemQuerySortColumn

Colonna di ordinamento.

Nome Tipo Descrizione
descending

boolean

Direzione in base alla quale eseguire l'ordinamento.
field

WorkItemFieldReference

Campo dell'elemento di lavoro.