Freigeben über


Queries - Update

Aktualisieren sie eine Abfrage oder einen Ordner. Dadurch können Sie Abfragen und Ordner aktualisieren, umbenennen und verschieben.

PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?api-version=7.1-preview.2
PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?$undeleteDescendants={$undeleteDescendants}&api-version=7.1-preview.2

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
path True

string

Der Name der Azure DevOps-Organisation.

project
path True

string

Projekt-ID oder Projektname

query
path True

string

Die ID oder der Pfad für die zu aktualisierende Abfrage.

api-version
query True

string

Version der zu verwendenden API. Dies sollte auf "7.1-preview.2" festgelegt werden, um diese Version der API zu verwenden.

$undeleteDescendants
query

boolean

Wiederherstellen der untergeordneten Elemente dieses Ordners. Es ist wichtig zu beachten, dass dadurch nicht die Berechtigungsänderungen zurückgesetzt werden, die zuvor auf die Nachfolger angewendet wurden.

Anforderungstext

Name Typ Beschreibung
_links

ReferenceLinks

Links zu verwandten REST-Ressourcen.

children

QueryHierarchyItem[]

Die untergeordneten Abfrageelemente in einem Abfrageordner.

clauses

WorkItemQueryClause

Die -Klauseln für eine flache Abfrage.

columns

WorkItemFieldReference[]

Die Spalten der Abfrage.

createdBy

IdentityReference

Die Identität, die das Abfrageelement erstellt hat.

createdDate

string

Wann das Abfrageelement erstellt wurde.

filterOptions

LinkQueryMode

Der Linkabfragemodus.

hasChildren

boolean

Wenn es sich um einen Abfrageordner handelt, gibt an, ob er untergeordnete Elemente enthält.

id

string

Die ID des Abfrageelements.

isDeleted

boolean

Gibt an, ob dieses Abfrageelement gelöscht wird. Wenn Sie dies für ein gelöschtes Abfrageelement auf false festlegen, wird es wiederherstellen. Durch das Wiederherstellen einer Abfrage oder eines Ordners werden die zuvor darauf angewendeten Berechtigungsänderungen nicht zurückgesetzt.

isFolder

boolean

Gibt an, ob es sich um einen Abfrageordner oder eine Abfrage handelt.

isInvalidSyntax

boolean

Gibt an, ob die WIQL dieser Abfrage ungültig ist. Dies kann auf eine ungültige Syntax oder einen nicht mehr gültigen Bereichs-/Iterationspfad zurückzuführen sein.

isPublic

boolean

Gibt an, ob dieses Abfrageelement öffentlich oder privat ist.

lastExecutedBy

IdentityReference

Die Identität, die die Abfrage zuletzt ausgeführt hat.

lastExecutedDate

string

Wann die Abfrage zuletzt ausgeführt wurde.

lastModifiedBy

IdentityReference

Die Identität, die das Abfrageelement zuletzt geändert hat.

lastModifiedDate

string

Zeitpunkt der letzten Änderung des Abfrageelements.

linkClauses

WorkItemQueryClause

Die Linkabfrageklausel.

name

string

Der Name des Abfrageelements.

path

string

Der Pfad des Abfrageelements.

queryRecursionOption

QueryRecursionOption

Die Rekursionsoption für die Verwendung in einer Strukturabfrage.

queryType

QueryType

Der Abfragetyp.

sortColumns

WorkItemQuerySortColumn[]

Die Sortierspalten der Abfrage.

sourceClauses

WorkItemQueryClause

Die Quellklauseln in einer Struktur- oder One-Hop-Linkabfrage.

targetClauses

WorkItemQueryClause

Die Zielklauseln in einer Struktur- oder One-Hop-Linkabfrage.

url

string

wiql

string

Der WIQL-Text der Abfrage

Antworten

Name Typ Beschreibung
200 OK

QueryHierarchyItem

Erfolgreicher Vorgang

Sicherheit

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

Name Beschreibung
vso.work_write Ermöglicht das Lesen, Erstellen und Aktualisieren von Arbeitselementen und Abfragen, aktualisieren von Boardmetadaten, Lesebereichs- und Iterationspfaden für andere Metadaten im Zusammenhang mit der Nachverfolgung von Arbeitselementen, Ausführen von Abfragen und das Empfangen von Benachrichtigungen zu Arbeitselementereignissen über Diensthooks.

Beispiele

Rename a folder
Rename a query
Undelete a query or folder
Update a query

Rename a folder

Sample Request

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

{
  "name": "Website"
}

Sample Response

{
  "id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
  "name": "Website",
  "path": "Shared Queries/Website",
  "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.077Z",
  "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"
}

Rename a query

Sample Request

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

{
  "name": "Website"
}

Sample Response

{
  "id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
  "name": "Website",
  "path": "Shared Queries/Website",
  "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.077Z",
  "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"
}

Undelete a query or folder

Sample Request

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

{
  "isDeleted": false
}

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:59:01.86Z",
  "isFolder": true,
  "hasChildren": true,
  "children": [
    {
      "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": "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:59:01.82Z",
      "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' and [System.State] = 'Active' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc",
      "isPublic": false,
      "clauses": {
        "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": "Bug"
          },
          {
            "field": {
              "referenceName": "System.State",
              "name": "State",
              "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
            },
            "operator": {
              "referenceName": "SupportedOperations.Equals",
              "name": "="
            },
            "value": "Active"
          }
        ]
      },
      "_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"
    }
  ],
  "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"
}

Update a query

Sample Request

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

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

Sample Response

{
  "id": "342f0f44-4069-46b1-a940-3d0468979ceb",
  "name": "Active Bugs",
  "path": "Shared Queries/Website team/Active Bugs",
  "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:58.44Z",
  "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' and [System.State] = 'Active' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc",
  "isPublic": true,
  "clauses": {
    "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": "Bug"
      },
      {
        "field": {
          "referenceName": "System.State",
          "name": "State",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
        },
        "operator": {
          "referenceName": "SupportedOperations.Equals",
          "name": "="
        },
        "value": "Active"
      }
    ]
  },
  "_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"
}

Definitionen

Name Beschreibung
IdentityReference

Beschreibt einen Verweis auf eine Identität.

LinkQueryMode

Der Linkabfragemodus.

LogicalOperation

Logischer Operator, der die Bedingungsklausel trennt

QueryHierarchyItem

Stellt ein Element in der Arbeitselementabfragehierarchie dar. Dies kann entweder eine Abfrage oder ein Ordner sein.

QueryRecursionOption

Die Rekursionsoption für die Verwendung in einer Strukturabfrage.

QueryType

Der Abfragetyp.

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

WorkItemFieldOperation

Beschreibt einen Arbeitselementfeldvorgang.

WorkItemFieldReference

Verweis auf ein Feld in einem Arbeitselement

WorkItemQueryClause

Stellt eine -Klausel in einer Arbeitselementabfrage dar. Dies zeigt die Struktur einer Arbeitselementabfrage an.

WorkItemQuerySortColumn

Eine Sortierspalte.

IdentityReference

Beschreibt einen Verweis auf eine Identität.

Name Typ Beschreibung
_links

ReferenceLinks

Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.

descriptor

string

Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.

directoryAlias

string

Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "self" des IdentityRef-Wörterbuchs "_links" verwiesen wird.

displayName

string

Dies ist der nicht eindeutige Anzeigename des Graph-Betreffs. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.

id

string

imageUrl

string

Veraltet: Im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links" verfügbar

inactive

boolean

Veraltet: Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.

isAadIdentity

boolean

Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

name

string

Legacy-Back-Compat-Eigenschaft. Dies war der WIT-spezifische Wert aus Konstanten. Wird auf dem Client ausgeblendet (ist aber vorhanden), es sei denn, er zielt auf die neueste Version ab.

profileUrl

string

Veraltet– wird in den meisten vorhandenen Implementierungen von ToIdentityRef nicht verwendet.

uniqueName

string

Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.

url

string

Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

LinkQueryMode

Der Linkabfragemodus.

Name Typ Beschreibung
linksOneHopDoesNotContain

string

Gibt Nur dann Arbeitselemente zurück, die die Quelle erfüllen, wenn kein verknüpftes Arbeitselement die Link- und Zielkriterien erfüllt.

linksOneHopMayContain

string

Gibt Arbeitselemente zurück, die die Quell- und Linkkriterien erfüllen, auch wenn kein verknüpftes Arbeitselement die Zielkriterien erfüllt.

linksOneHopMustContain

string

Gibt Arbeitselemente zurück, bei denen die Quell-, Ziel- und Linkkriterien erfüllt sind.

linksRecursiveDoesNotContain

string

linksRecursiveMayContain

string

Gibt Arbeitselemente zurück, eine Hierarchie von Arbeitselementen, die standardmäßig die Quelle erfüllen.

linksRecursiveMustContain

string

workItems

string

Gibt eine flache Liste der Arbeitselemente zurück.

LogicalOperation

Logischer Operator, der die Bedingungsklausel trennt

Name Typ Beschreibung
and

string

none

string

or

string

QueryHierarchyItem

Stellt ein Element in der Arbeitselementabfragehierarchie dar. Dies kann entweder eine Abfrage oder ein Ordner sein.

Name Typ Beschreibung
_links

ReferenceLinks

Links zu verwandten REST-Ressourcen.

children

QueryHierarchyItem[]

Die untergeordneten Abfrageelemente in einem Abfrageordner.

clauses

WorkItemQueryClause

Die -Klauseln für eine flache Abfrage.

columns

WorkItemFieldReference[]

Die Spalten der Abfrage.

createdBy

IdentityReference

Die Identität, die das Abfrageelement erstellt hat.

createdDate

string

Wann das Abfrageelement erstellt wurde.

filterOptions

LinkQueryMode

Der Linkabfragemodus.

hasChildren

boolean

Wenn es sich um einen Abfrageordner handelt, gibt an, ob er untergeordnete Elemente enthält.

id

string

Die ID des Abfrageelements.

isDeleted

boolean

Gibt an, ob dieses Abfrageelement gelöscht wird. Wenn Sie dies für ein gelöschtes Abfrageelement auf false festlegen, wird es wiederherstellen. Durch das Wiederherstellen einer Abfrage oder eines Ordners werden die zuvor darauf angewendeten Berechtigungsänderungen nicht zurückgesetzt.

isFolder

boolean

Gibt an, ob es sich um einen Abfrageordner oder eine Abfrage handelt.

isInvalidSyntax

boolean

Gibt an, ob die WIQL dieser Abfrage ungültig ist. Dies kann auf eine ungültige Syntax oder einen nicht mehr gültigen Bereichs-/Iterationspfad zurückzuführen sein.

isPublic

boolean

Gibt an, ob dieses Abfrageelement öffentlich oder privat ist.

lastExecutedBy

IdentityReference

Die Identität, die die Abfrage zuletzt ausgeführt hat.

lastExecutedDate

string

Wann die Abfrage zuletzt ausgeführt wurde.

lastModifiedBy

IdentityReference

Die Identität, die das Abfrageelement zuletzt geändert hat.

lastModifiedDate

string

Zeitpunkt der letzten Änderung des Abfrageelements.

linkClauses

WorkItemQueryClause

Die Linkabfrageklausel.

name

string

Der Name des Abfrageelements.

path

string

Der Pfad des Abfrageelements.

queryRecursionOption

QueryRecursionOption

Die Rekursionsoption für die Verwendung in einer Strukturabfrage.

queryType

QueryType

Der Abfragetyp.

sortColumns

WorkItemQuerySortColumn[]

Die Sortierspalten der Abfrage.

sourceClauses

WorkItemQueryClause

Die Quellklauseln in einer Struktur- oder One-Hop-Linkabfrage.

targetClauses

WorkItemQueryClause

Die Zielklauseln in einer Struktur- oder One-Hop-Linkabfrage.

url

string

wiql

string

Der WIQL-Text der Abfrage

QueryRecursionOption

Die Rekursionsoption für die Verwendung in einer Strukturabfrage.

Name Typ Beschreibung
childFirst

string

Gibt Arbeitselemente zurück, die die Zielkriterien erfüllen, auch wenn kein Arbeitselement die Quell- und Linkkriterien erfüllt.

parentFirst

string

Gibt Arbeitselemente zurück, die die Quelle erfüllen, auch wenn kein verknüpftes Arbeitselement die Ziel- und Linkkriterien erfüllt.

QueryType

Der Abfragetyp.

Name Typ Beschreibung
flat

string

Ruft eine flache Liste von Arbeitselementen ab.

oneHop

string

Ruft eine Liste der Arbeitselemente und deren direkte Links ab.

tree

string

Ruft eine Struktur von Arbeitselementen ab, die deren Linkhierarchie anzeigen.

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

WorkItemFieldOperation

Beschreibt einen Arbeitselementfeldvorgang.

Name Typ Beschreibung
name

string

Anzeigename des Vorgangs.

referenceName

string

Verweisname des Vorgangs.

WorkItemFieldReference

Verweis auf ein Feld in einem Arbeitselement

Name Typ Beschreibung
name

string

Der Anzeigename des Felds.

referenceName

string

Der Verweisname des Felds.

url

string

Die REST-URL der Ressource.

WorkItemQueryClause

Stellt eine -Klausel in einer Arbeitselementabfrage dar. Dies zeigt die Struktur einer Arbeitselementabfrage an.

Name Typ Beschreibung
clauses

WorkItemQueryClause[]

Untergeordnete Klauseln, wenn die aktuelle Klausel ein logischer Operator ist

field

WorkItemFieldReference

Der Bedingung zugeordnetes Feld

fieldValue

WorkItemFieldReference

Rechte Seite der Bedingung, wenn ein Feld-zu-Feld-Vergleich

isFieldValue

boolean

Bestimmt, ob es sich um einen Feld-zu-Feld-Vergleich handelt.

logicalOperator

LogicalOperation

Logischer Operator, der die Bedingungsklausel trennt

operator

WorkItemFieldOperation

Der Feldoperator

value

string

Rechte Seite der Bedingung, wenn ein Feld-zu-Wert-Vergleich

WorkItemQuerySortColumn

Eine Sortierspalte.

Name Typ Beschreibung
descending

boolean

Die Richtung, nach der sortiert werden soll.

field

WorkItemFieldReference

Ein Arbeitselementfeld.