Condividi tramite


Queries - Create

Crea una query o sposta una query.

Altre informazioni sulla sintassi WIQL (Work Item Query Language) sono disponibili qui.

POST https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?api-version=5.0

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 del progetto

query
path True

string

ID padre o percorso in cui deve essere creata la query.

api-version
query True

string

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

Corpo della richiesta

Nome Tipo Descrizione
_links

ReferenceLinks

Collegare i riferimenti alle risorse REST correlate.

children

QueryHierarchyItem[]

Elementi della 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

Quando è stato creato l'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 questo elemento di query viene eliminato. Se si imposta su false su un elemento di query eliminato, verrà annullata l'operazione. L'annullamento della disabilitazione di una query o di una cartella non restituirà le modifiche dell'autorizzazione applicate in precedenza.

isFolder

boolean

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

isInvalidSyntax

boolean

Indica se WIQL di questa query non è valido. Ciò potrebbe essere dovuto alla sintassi non valida o a un percorso di area/iterazione non valido.

isPublic

boolean

Indica se questo elemento di query è pubblico o privato.

lastExecutedBy

IdentityReference

Identità che ha eseguito l'ultima query.

lastExecutedDate

string

Quando la query è stata eseguita l'ultima volta.

lastModifiedBy

IdentityReference

Identità che ha modificato l'elemento di query.

lastModifiedDate

string

Quando l'elemento di query è stato modificato.

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

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_write Concede la possibilità di leggere, creare e aggiornare elementi di lavoro e query, aggiornare i metadati della scheda, l'area di lettura e le iterazioni dei percorsi di altri metadati correlati al rilevamento degli elementi di lavoro, eseguire query e ricevere notifiche sugli eventi degli elementi di lavoro tramite hook del servizio.

Esempio

Create a folder
Create a query
Move a query or folder

Create a folder

Sample Request

POST https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

{
  "name": "Website team",
  "isFolder": true
}

Sample Response

{
  "id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
  "name": "Website team",
  "path": "Shared Queries/Website team",
  "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": "2016-06-01T16:58:56.323Z",
  "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": "2016-06-01T16:58:56.323Z",
  "isFolder": true,
  "hasChildren": false,
  "isPublic": true,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/eb5c1e25-9b3e-4416-a833-e500122882c7"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}

Create a query

Sample Request

POST https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

{
  "name": "All Bugs",
  "wiql": "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.WorkItemType] = 'Bug' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"
}

Sample Response

{
  "id": "342f0f44-4069-46b1-a940-3d0468979ceb",
  "name": "All Bugs",
  "path": "Shared Queries/Website team/All Bugs",
  "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": "2016-06-01T16:58:56.64Z",
  "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": "2016-06-01T16:58:56.64Z",
  "queryType": "flat",
  "columns": [
    {
      "referenceName": "System.Id",
      "name": "ID",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
    },
    {
      "referenceName": "System.Title",
      "name": "Title",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
    },
    {
      "referenceName": "System.State",
      "name": "State",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
    }
  ],
  "sortColumns": [
    {
      "field": {
        "referenceName": "Microsoft.VSTS.Common.Priority",
        "name": "Priority",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.Priority"
      },
      "descending": false
    },
    {
      "field": {
        "referenceName": "System.CreatedDate",
        "name": "Created Date",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.CreatedDate"
      },
      "descending": true
    }
  ],
  "wiql": "select [System.Id], [System.Title], [System.State] from WorkItems where [System.WorkItemType] = 'Bug' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc",
  "isPublic": true,
  "clauses": {
    "field": {
      "referenceName": "System.WorkItemType",
      "name": "Work Item Type",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
    },
    "operator": {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    "value": "Bug"
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=342f0f44-4069-46b1-a940-3d0468979ceb"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "wiql": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/342f0f44-4069-46b1-a940-3d0468979ceb"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
}

Move a query or folder

Sample Request

POST https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

{
  "id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}

Sample Response

{
  "id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
  "name": "Website",
  "path": "My Queries/Website",
  "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": "2016-06-01T16:58:56.323Z",
  "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": "2016-06-01T16:58:59.407Z",
  "isFolder": true,
  "hasChildren": true,
  "isPublic": false,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/3c65fbc1-d427-48ce-9091-633dde9e27e2"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}

Definizioni

Nome Descrizione
IdentityReference

Descrive un riferimento a un'identità.

LinkQueryMode

Modalità di query di collegamento.

LogicalOperation

Operatore logico che separa la clausola condition

QueryHierarchyItem

Rappresenta un elemento nella gerarchia di query dell'elemento di lavoro. Può trattarsi di una query o di una cartella.

QueryRecursionOption

Opzione di ricorsione da usare in una query ad albero.

QueryType

Tipo di query.

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

WorkItemFieldOperation

Descrive un'operazione di 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. In questo modo viene illustrata 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 grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo argomento grafico.

descriptor

string

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

directoryAlias

string

displayName

string

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

id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

name

string

Proprietà back-compat legacy. Questo è stato il valore specifico del WIT da Costanti. Sarà nascosto (ma esiste) nel client, a meno che non siano destinate alla versione più recente

profileUrl

string

uniqueName

string

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 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 elementi di lavoro in cui sono 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

LogicalOperation

Operatore logico che separa la clausola condition

Nome Tipo Descrizione
aND

string

nONE

string

oR

string

QueryHierarchyItem

Rappresenta un elemento nella gerarchia di query dell'elemento di lavoro. Può trattarsi di una query o di una cartella.

Nome Tipo Descrizione
_links

ReferenceLinks

Riferimenti ai collegamenti alle risorse REST correlate.

children

QueryHierarchyItem[]

Elementi della 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

Quando è stato creato l'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 questo elemento di query viene eliminato. Se si imposta su false su un elemento di query eliminato, verrà annullata l'operazione. L'annullamento della disabilitazione di una query o di una cartella non restituirà le modifiche dell'autorizzazione applicate in precedenza.

isFolder

boolean

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

isInvalidSyntax

boolean

Indica se WIQL di questa query non è valido. Ciò potrebbe essere dovuto alla sintassi non valida o a un percorso di area/iterazione non valido.

isPublic

boolean

Indica se questo elemento di query è pubblico o privato.

lastExecutedBy

IdentityReference

Identità che ha eseguito l'ultima query.

lastExecutedDate

string

Quando la query è stata eseguita l'ultima volta.

lastModifiedBy

IdentityReference

Identità che ha modificato l'elemento di query.

lastModifiedDate

string

Quando l'elemento di query è stato modificato.

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 ad 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 a un hop.

targetClauses

WorkItemQueryClause

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

url

string

wiql

string

Testo WIQL della query

QueryRecursionOption

Opzione di ricorsione da usare in una query ad 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 flat 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 mostrano la gerarchia dei collegamenti.

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.

WorkItemFieldOperation

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

Nome Tipo Descrizione
name

string

Nome 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 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. In questo modo viene illustrata 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 a condizione

fieldValue

WorkItemFieldReference

Lato destro della condizione quando un campo da confrontare sul campo

isFieldValue

boolean

Determina se si tratta di un campo da confrontare sul campo

logicalOperator

LogicalOperation

Operatore logico che separa la clausola condition

operator

WorkItemFieldOperation

Operatore campo

value

string

Lato destro della condizione quando un campo da confrontare con valori

WorkItemQuerySortColumn

Colonna di ordinamento.

Nome Tipo Descrizione
descending

boolean

Direzione da ordinare.

field

WorkItemFieldReference

Campo elemento di lavoro.