Queries - Update

Обновление запроса или папки. Это позволяет обновлять, переименовывать и перемещать запросы и папки.

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

Параметры URI

Имя В Обязательно Тип Описание
organization
path True

string

Название организации Azure DevOps.

project
path True

string

Идентификатор проекта или имя проекта

query
path True

string

Идентификатор или путь для обновляемого запроса.

api-version
query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение 7.0.

$undeleteDescendants
query

boolean

Отмените удаление дочерних элементов этой папки. Важно отметить, что это не приведет к возврату изменений разрешений, которые ранее были применены к потомкам.

Текст запроса

Имя Тип Описание
_links

ReferenceLinks

Ссылки на связанные ресурсы REST.

children

QueryHierarchyItem[]

Дочерние элементы запроса внутри папки запроса.

clauses

WorkItemQueryClause

Предложения для неструктурированного запроса.

columns

WorkItemFieldReference[]

Столбцы запроса.

createdBy

IdentityReference

Удостоверение, создавшего элемент запроса.

createdDate

string

При создании элемента запроса.

filterOptions

LinkQueryMode

Режим запроса ссылки.

hasChildren

boolean

Если это папка запроса, указывает, содержит ли она какие-либо дочерние элементы.

id

string

Идентификатор элемента запроса.

isDeleted

boolean

Указывает, удален ли этот элемент запроса. Если задать значение false для удаленного элемента запроса, он будет отменен. Удаление запроса или папки не приведет к возврату изменений разрешений, которые были применены к ним ранее.

isFolder

boolean

Указывает, является ли это папкой запроса или запросом.

isInvalidSyntax

boolean

Указывает, является ли wiQL этого запроса недопустимым. Это может быть вызвано недопустимым синтаксисом или недопустимым путем к области или итерации.

isPublic

boolean

Указывает, является ли этот элемент запроса общедоступным или закрытым.

lastExecutedBy

IdentityReference

Идентификатор, который последний раз выполнял запрос.

lastExecutedDate

string

Время последнего выполнения запроса.

lastModifiedBy

IdentityReference

Удостоверение, последнее изменение которого был изменен элемент запроса.

lastModifiedDate

string

Время последнего изменения элемента запроса.

linkClauses

WorkItemQueryClause

Предложение запроса ссылки.

name

string

Имя элемента запроса.

path

string

Путь к элементу запроса.

queryRecursionOption

QueryRecursionOption

Параметр рекурсии для использования в запросе в виде дерева.

queryType

QueryType

Тип запроса.

sortColumns

WorkItemQuerySortColumn[]

Столбцы сортировки запроса.

sourceClauses

WorkItemQueryClause

Исходные предложения в дереве или запросе ссылки на один прыжок.

targetClauses

WorkItemQueryClause

Целевые предложения в дереве или запросе ссылки на один прыжок.

url

string

wiql

string

Текст WIQL запроса

Ответы

Имя Тип Описание
200 OK

QueryHierarchyItem

успешная операция

Безопасность

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

Имя Описание
vso.work_write Предоставляет возможность считывать, создавать и обновлять рабочие элементы и запросы, обновлять метаданные доски, пути чтения областей и итераций, другие метаданные, связанные с отслеживанием рабочих элементов, выполнять запросы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Примеры

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.0

{
  "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.0

{
  "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.0

{
  "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.0

{
  "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"
}

Определения

Имя Описание
IdentityReference

Описывает ссылку на удостоверение.

LinkQueryMode

Режим запроса ссылки.

LogicalOperation

Логический оператор, разделяющий предложение условия

QueryHierarchyItem

Представляет элемент в иерархии запросов рабочих элементов. Это может быть запрос или папка.

QueryRecursionOption

Параметр рекурсии для использования в древовидном запросе.

QueryType

Тип запроса.

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

WorkItemFieldOperation

Описывает операцию с полем рабочего элемента.

WorkItemFieldReference

Ссылка на поле в рабочем элементе

WorkItemQueryClause

Представляет предложение в запросе рабочего элемента. Здесь показана структура запроса рабочего элемента.

WorkItemQuerySortColumn

Столбец сортировки.

IdentityReference

Описывает ссылку на удостоверение.

Имя Тип Описание
_links

ReferenceLinks

Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.

descriptor

string

Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.

directoryAlias

string

Нерекомендуемое — можно получить запрос пользователя Graph, на который ссылается запись self словаря IdentityRef _links.

displayName

string

Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.

id

string

imageUrl

string

Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links"

inactive

boolean

Нерекомендуемое — можно получить запрос к состоянию членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links".

isAadIdentity

boolean

Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

name

string

Устаревшее свойство back-compat. Это было конкретное значение WIT из констант. Будут скрыты (но существуют) на клиенте, если они не предназначены для последней версии

profileUrl

string

Не рекомендуется — не используется в большинстве уже существовающих реализаций ToIdentityRef

uniqueName

string

Не рекомендуется использовать вместо него домен+principalName.

url

string

Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа.

LinkQueryMode

Режим запроса ссылки.

Имя Тип Описание
linksOneHopDoesNotContain

string

Возвращает рабочие элементы, удовлетворяющие источнику, только если ни один связанный рабочий элемент не соответствует критериям ссылки и целевого объекта.

linksOneHopMayContain

string

Возвращает рабочие элементы, удовлетворяющие критериям источника и ссылки, даже если ни один связанный рабочий элемент не соответствует целевым критериям.

linksOneHopMustContain

string

Возвращает рабочие элементы, в которых удовлетворяются критерии источника, целевого объекта и ссылки.

linksRecursiveDoesNotContain

string

linksRecursiveMayContain

string

Возвращает рабочие элементы иерархии рабочих элементов, которые по умолчанию удовлетворяют источнику

linksRecursiveMustContain

string

workItems

string

Возвращает плоский список рабочих элементов.

LogicalOperation

Логический оператор, разделяющий предложение условия

Имя Тип Описание
and

string

none

string

or

string

QueryHierarchyItem

Представляет элемент в иерархии запросов рабочих элементов. Это может быть запрос или папка.

Имя Тип Описание
_links

ReferenceLinks

Ссылки на связанные ресурсы REST.

children

QueryHierarchyItem[]

Дочерние элементы запроса внутри папки запроса.

clauses

WorkItemQueryClause

Предложения для неструктурированного запроса.

columns

WorkItemFieldReference[]

Столбцы запроса.

createdBy

IdentityReference

Удостоверение, создавшего элемент запроса.

createdDate

string

При создании элемента запроса.

filterOptions

LinkQueryMode

Режим запроса ссылки.

hasChildren

boolean

Если это папка запроса, указывает, содержит ли она какие-либо дочерние элементы.

id

string

Идентификатор элемента запроса.

isDeleted

boolean

Указывает, удален ли этот элемент запроса. Если задать значение false для удаленного элемента запроса, он будет отменен. Удаление запроса или папки не приведет к возврату изменений разрешений, которые были применены к ним ранее.

isFolder

boolean

Указывает, является ли это папкой запроса или запросом.

isInvalidSyntax

boolean

Указывает, является ли wiQL этого запроса недопустимым. Это может быть вызвано недопустимым синтаксисом или недопустимым путем к области или итерации.

isPublic

boolean

Указывает, является ли этот элемент запроса общедоступным или частным.

lastExecutedBy

IdentityReference

Идентификатор, который последний раз выполнял запрос.

lastExecutedDate

string

Время последнего выполнения запроса.

lastModifiedBy

IdentityReference

Удостоверение, последнее изменение которого был изменен элемент запроса.

lastModifiedDate

string

Время последнего изменения элемента запроса.

linkClauses

WorkItemQueryClause

Предложение запроса ссылки.

name

string

Имя элемента запроса.

path

string

Путь к элементу запроса.

queryRecursionOption

QueryRecursionOption

Параметр рекурсии для использования в древовидном запросе.

queryType

QueryType

Тип запроса.

sortColumns

WorkItemQuerySortColumn[]

Столбцы сортировки запроса.

sourceClauses

WorkItemQueryClause

Исходные предложения в дереве или запросе ссылки на один прыжок.

targetClauses

WorkItemQueryClause

Целевые предложения в дереве или запросе ссылки на один прыжок.

url

string

wiql

string

Текст запроса WIQL

QueryRecursionOption

Параметр рекурсии для использования в древовидном запросе.

Имя Тип Описание
childFirst

string

Возвращает рабочие элементы, удовлетворяющие целевым критериям, даже если ни один рабочий элемент не удовлетворяет критериям источника и ссылки.

parentFirst

string

Возвращает рабочие элементы, удовлетворяющие источнику, даже если ни один связанный рабочий элемент не соответствует целевым условиям и критериям связи.

QueryType

Тип запроса.

Имя Тип Описание
flat

string

Возвращает плоский список рабочих элементов.

oneHop

string

Возвращает список рабочих элементов и их прямые ссылки.

tree

string

Возвращает дерево рабочих элементов, отображающее их иерархию ссылок.

Класс, представляющий коллекцию ссылок REST.

Имя Тип Описание
links

object

Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

WorkItemFieldOperation

Описывает операцию с полем рабочего элемента.

Имя Тип Описание
name

string

Понятное имя операции.

referenceName

string

Имя ссылки операции.

WorkItemFieldReference

Ссылка на поле в рабочем элементе

Имя Тип Описание
name

string

Понятное имя поля.

referenceName

string

Имя ссылки поля.

url

string

URL-адрес REST ресурса.

WorkItemQueryClause

Представляет предложение в запросе рабочего элемента. Здесь показана структура запроса рабочего элемента.

Имя Тип Описание
clauses

WorkItemQueryClause[]

Дочерние предложения, если текущее предложение является логическим оператором

field

WorkItemFieldReference

Поле, связанное с условием

fieldValue

WorkItemFieldReference

Справа от условия при сравнении поля с полем

isFieldValue

boolean

Определяет, является ли это сравнение полей

logicalOperator

LogicalOperation

Логический оператор, разделяющий предложение условия

operator

WorkItemFieldOperation

Оператор field

value

string

Справа от условия при сравнении поля со значением

WorkItemQuerySortColumn

Столбец сортировки.

Имя Тип Описание
descending

boolean

Направление сортировки.

field

WorkItemFieldReference

Поле рабочего элемента.