Queries - Get

Riferimento

Servizio:: Work Item Tracking

Versione API:: 7.1

Recupera una singola query e i relativi elementi figlio

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

Con parametri facoltativi:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?$expand={$expand}&$depth={$depth}&$includeDeleted={$includeDeleted}&$useIsoDateFormat={$useIsoDateFormat}&api-version=7.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
query	path	True	string	ID o percorso della query.
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.
$depth	query		integer (int32)	Nella cartella delle query restituire le query e le cartelle figlio a questa profondità.
$expand	query		QueryExpand	Includere la stringa di query (wiql), le clausole, le colonne dei risultati della query e le opzioni di ordinamento nei risultati.
$includeDeleted	query		boolean	Includere query e cartelle eliminate
$useIsoDateFormat	query		boolean	Le clausole di query DateTime verranno formattate usando un formato conforme a ISO 8601

Risposte

Nome	Tipo	Descrizione
200 OK	QueryHierarchyItem	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

Deleted query by ID

Flat query with expanded clauses

Folder by ID

Folder by Name

Hierarchical query with expanded clauses

Query by ID

Query by Name

Deleted query by ID

Esempio di richiesta

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$includeDeleted=true&api-version=7.1

Risposta di esempio

Codice di stato:: 200

{
  "id": "342f0f44-4069-46b1-a940-3d0468979ceb",
  "name": "Active Bugs",
  "path": "My Queries/Website/Active 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": "2014-03-18T17:18:36.06Z",
  "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": "2014-03-18T17:18:36.06Z",
  "lastExecutedBy": {
    "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"
  },
  "lastExecutedDate": "2014-03-18T17:19:36.06Z",
  "isDeleted": true,
  "isPublic": false,
  "_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"
}

Flat query with expanded clauses

Esempio di richiesta

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$expand=clauses&api-version=7.1

Risposta di esempio

Codice di stato:: 200

{
  "id": "df60fdf6-3b5f-4928-aae8-29ee63df6e31",
  "name": "All Bugs",
  "path": "Shared Queries/Website team/All Bugs",
  "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/df60fdf6-3b5f-4928-aae8-29ee63df6e31"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=df60fdf6-3b5f-4928-aae8-29ee63df6e31"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/addcb8b3-12d0-4f2c-b6ca-52bb584ae286"
    },
    "wiql": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/df60fdf6-3b5f-4928-aae8-29ee63df6e31"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/df60fdf6-3b5f-4928-aae8-29ee63df6e31"
}

Folder by ID

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "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": true,
  "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"
}

Folder by Name

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "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": true,
  "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"
}

Hierarchical query with expanded clauses

Esempio di richiesta

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$expand=clauses&api-version=7.1

Risposta di esempio

Codice di stato:: 200

{
  "id": "f0ade206-32f8-4360-9254-ad33f906cd2e",
  "name": "Active stories with tasks",
  "path": "Shared Queries/Website team/Active stories with tasks",
  "queryType": "tree",
  "columns": [
    {
      "referenceName": "System.Id",
      "name": "ID",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
    },
    {
      "referenceName": "System.WorkItemType",
      "name": "Work Item Type",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
    },
    {
      "referenceName": "System.Title",
      "name": "Title",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
    },
    {
      "referenceName": "System.AssignedTo",
      "name": "Assigned To",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AssignedTo"
    },
    {
      "referenceName": "System.State",
      "name": "State",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
    },
    {
      "referenceName": "System.Tags",
      "name": "Tags",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
    }
  ],
  "wiql": "SELECT [System.Id],[System.WorkItemType],[System.Title],[System.AssignedTo],[System.State],[System.Tags] FROM WorkItemLinks WHERE ([Source].[System.TeamProject] = @project AND [Source].[System.WorkItemType] = 'Product Backlog Item' AND [Source].[System.State] <> 'Removed') AND ([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') AND ([Target].[System.WorkItemType] = 'Task') mode(Recursive)",
  "isPublic": true,
  "linkClauses": {
    "logicalOperator": "and",
    "clauses": [
      {
        "field": {
          "referenceName": "System.Links.LinkType",
          "name": "Link Type",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Links.LinkType"
        },
        "operator": {
          "referenceName": "SupportedOperations.Equals",
          "name": "="
        },
        "value": "System.LinkTypes.Hierarchy-Forward"
      }
    ]
  },
  "filterOptions": "linksRecursiveMayContain",
  "sourceClauses": {
    "logicalOperator": "and",
    "clauses": [
      {
        "field": {
          "referenceName": "System.TeamProject",
          "name": "Team Project",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.TeamProject"
        },
        "operator": {
          "referenceName": "SupportedOperations.Equals",
          "name": "="
        },
        "value": "@project"
      },
      {
        "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": "Product Backlog Item"
      },
      {
        "field": {
          "referenceName": "System.State",
          "name": "State",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
        },
        "operator": {
          "referenceName": "SupportedOperations.NotEquals",
          "name": "<>"
        },
        "value": "Removed"
      }
    ]
  },
  "targetClauses": {
    "logicalOperator": "and",
    "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": "Task"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/f0ade206-32f8-4360-9254-ad33f906cd2e"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=f0ade206-32f8-4360-9254-ad33f906cd2e"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/addcb8b3-12d0-4f2c-b6ca-52bb584ae286"
    },
    "wiql": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/f0ade206-32f8-4360-9254-ad33f906cd2e"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/f0ade206-32f8-4360-9254-ad33f906cd2e"
}

Query by ID

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "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": "2014-03-18T17:18:36.06Z",
  "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": "2014-03-18T17:18:36.06Z",
  "lastExecutedBy": {
    "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"
  },
  "lastExecutedDate": "2014-03-18T17:19:36.06Z",
  "isPublic": true,
  "_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"
}

Query by Name

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "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": "2014-03-18T17:18:36.06Z",
  "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": "2014-03-18T17:18:36.06Z",
  "lastExecutedBy": {
    "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"
  },
  "lastExecutedDate": "2014-03-18T17:19:36.06Z",
  "isPublic": true,
  "_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"
}

Definizioni

Nome	Descrizione
IdentityReference	Descrive un riferimento a un'identità.
LinkQueryMode	Modalità di query di collegamento.
LogicalOperation	Operatore logico che separa la clausola condition
QueryExpand	Parametri di espansione per le query. Le opzioni possibili sono { None, Wiql, Clauses, All, Minimal }
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 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 illustrata la struttura di una query dell'elemento di lavoro.
WorkItemQuerySortColumn	Colonna di ordinamento.

IdentityReference

Object

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 sull'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 soggetto del 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 IdentityRef "_links"
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 (uuid)
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 "_links" GraphUser
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 del 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

Enumerazione

Modalità di query di collegamento.

Valore	Descrizione
linksOneHopDoesNotContain	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	Restituisce gli elementi di lavoro che soddisfano i criteri di origine e collegamento, anche se nessun elemento di lavoro collegato soddisfa i criteri di destinazione.
linksOneHopMustContain	Restituisce gli elementi di lavoro in cui sono soddisfatti tutti i criteri di origine, destinazione e collegamento.
linksRecursiveDoesNotContain
linksRecursiveMayContain	Restituisce elementi di lavoro una gerarchia di elementi di lavoro che per impostazione predefinita soddisfano l'origine
linksRecursiveMustContain
workItems	Restituisce un elenco semplice di elementi di lavoro.

LogicalOperation

Enumerazione

Operatore logico che separa la clausola condition

Valore	Descrizione
and
none
or

QueryExpand

Enumerazione

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

Valore	Descrizione
all	Espande tutte le proprietà
clauses	Espande colonne, collegamenti, changeinfo, testo e clausole WIQL
minimal	Visualizza le proprietà minime e il testo WIQL
none	Espande colonne, collegamenti e informazioni di modifica
wiql	Espande colonne, collegamenti, changeinfo e testo WIQL

QueryHierarchyItem

Object

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	Collegamenti ai 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 (date-time)	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 (uuid)	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. Se si annulla una query o una cartella, le modifiche alle autorizzazioni applicate in precedenza non verranno restituite.
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 (date-time)	Data dell'ultima esecuzione della query.
lastModifiedBy	IdentityReference	Identità che ha modificato l'ultimo elemento di query.
lastModifiedDate	string (date-time)	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

Enumerazione

Opzione di ricorsione da usare in una query albero.

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

QueryType

Enumerazione

Tipo di query.

Valore	Descrizione
flat	Ottiene un elenco semplice di elementi di lavoro.
oneHop	Ottiene un elenco di elementi di lavoro e i relativi collegamenti diretti.
tree	Ottiene un albero di elementi di lavoro che visualizzano la gerarchia dei collegamenti.

ReferenceLinks

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.

WorkItemFieldOperation

Object

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

Object

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

Object

Rappresenta una clausola in una query dell'elemento di lavoro. 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 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 di 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

Object

Colonna di ordinamento.

Nome	Tipo	Descrizione
descending	boolean	Direzione in base alla quale eseguire l'ordinamento.
field	WorkItemFieldReference	Campo dell'elemento di lavoro.

Condividi tramite

Queries - Get

Parametri dell'URI

Risposte

Sicurezza

oauth2

Ambiti

Esempio

Deleted query by ID

Esempio di richiesta

Risposta di esempio

Flat query with expanded clauses

Esempio di richiesta

Risposta di esempio

Folder by ID

Esempio di richiesta

Risposta di esempio

Folder by Name

Esempio di richiesta

Risposta di esempio

Hierarchical query with expanded clauses

Esempio di richiesta

Risposta di esempio

Query by ID

Esempio di richiesta

Risposta di esempio

Query by Name

Esempio di richiesta

Risposta di esempio

Definizioni

IdentityReference

LinkQueryMode

LogicalOperation

QueryExpand

QueryHierarchyItem

QueryRecursionOption

QueryType

ReferenceLinks

WorkItemFieldOperation

WorkItemFieldReference

WorkItemQueryClause

WorkItemQuerySortColumn

Risorse aggiuntive