Reporting Work Item Revisions - Read Reporting Revisions Post

Ссылка

Service:: Work Item Tracking

API Version:: 4.1

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

POST https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?api-version=4.1

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemrevisions?continuationToken={continuationToken}&startDateTime={startDateTime}&$expand={$expand}&api-version=4.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 4.1.
$expand	query		ReportingRevisionsExpand
continuationToken	query		string	Указывает водяной знак для запуска пакета. Опустите этот параметр, чтобы получить первый пакет исправлений.
startDateTime	query		string date-time	Дата и время, используемые в качестве отправной точки для исправлений, все изменения будут происходить после этой даты и времени. Не может использоваться в сочетании с параметром watermark.

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

Имя	Тип	Описание
fields	string[]	Список полей, возвращаемых в редакциях рабочих элементов. Опустите этот параметр, чтобы получить все поля, доступные для отчета.
includeDeleted	boolean	Включите удаленный рабочий элемент в результат.
includeIdentityRef	boolean	Возвращает ссылку на удостоверение вместо строкового значения для полей идентификаторов.
includeLatestOnly	boolean	Включите только последнюю версию рабочего элемента, пропуская все предыдущие редакции рабочего элемента.
includeTagRef	boolean	Включить ссылку на тег вместо строкового значения для поля System.Tags
types	string[]	Список типов для фильтрации результатов по определенным типам рабочих элементов. Опустите этот параметр, чтобы получить редакции всех типов рабочих элементов.

Ответы

Имя	Тип	Описание
200 OK	ReportingWorkItemRevisionsBatch	успешная операция

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

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	Предоставляет возможность чтения рабочих элементов, запросов, досок, путей областей и итераций, а также других метаданных, связанных с отслеживанием рабочих элементов. Также предоставляет возможность выполнять запросы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Имя

Описание

vso.work

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

Примеры

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/reporting/workitemrevisions?continuationToken=813;350;1&api-version=4.1

{
  "types": [
    "Bug",
    "Task",
    "Product Backlog Item"
  ],
  "fields": [
    "System.WorkItemType",
    "System.Title",
    "System.AreaPath"
  ],
  "includeIdentityRef": true
}

Sample Response

Status code:: 200

{
  "values": [
    {
      "id": 3,
      "rev": 8,
      "fields": {
        "System.AreaPath": "Fabrikam-Fiber-Git",
        "System.WorkItemType": "Product Backlog Item",
        "System.Title": "Technician can submit invoices on Windows Phone"
      }
    }
  ],
  "nextLink": "https://dev.azure.com/fabrikam/_apis/wit/reporting/workItemRevisions?continuationToken=842;5;3&api-version=2.0",
  "isLastBatch": true
}

Определения

Имя	Описание
ReportingRevisionsExpand
ReportingWorkItemRevisionsBatch
ReportingWorkItemRevisionsFilter

ReportingRevisionsExpand

Имя	Тип	Описание
fields	string
none	string

ReportingWorkItemRevisionsBatch

Имя	Тип	Описание
continuationToken	string
isLastBatch	boolean
nextLink	string
values	string[]

ReportingWorkItemRevisionsFilter

Имя	Тип	Описание
fields	string[]	Список полей, возвращаемых в редакциях рабочих элементов. Опустите этот параметр, чтобы получить все поля, доступные для отчета.
includeDeleted	boolean	Включите удаленный рабочий элемент в результат.
includeIdentityRef	boolean	Возвращает ссылку на удостоверение вместо строкового значения для полей идентификаторов.
includeLatestOnly	boolean	Включите только последнюю версию рабочего элемента, пропуская все предыдущие редакции рабочего элемента.
includeTagRef	boolean	Включить ссылку на тег вместо строкового значения для поля System.Tags
types	string[]	Список типов для фильтрации результатов по определенным типам рабочих элементов. Опустите этот параметр, чтобы получить редакции всех типов рабочих элементов.

Поделиться через