Recyclebin - Restore Work Item

Ссылка

Service:: Work Item Tracking

API Version:: 7.1-preview.2

Восстанавливает удаленный рабочий элемент из корзины.

PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/recyclebin/{id}?api-version=7.1-preview.2

Параметры URI

Имя	В	Обязательно	Тип	Описание
id	path	True	integer int32	Идентификатор восстанавливаемого рабочего элемента
organization	path	True	string	Название организации Azure DevOps.
project	path		string	Идентификатор или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.2.

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

Имя	Тип	Описание
isDeleted	boolean	Задает значение, указывающее, удаляется ли этот рабочий элемент.

Ответы

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

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

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

Имя

Описание

vso.work_write

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

Примеры

Restore a work item

Sample Request

HTTP

PATCH https://dev.azure.com/{organization}/_apis/wit/recyclebin/403?api-version=7.1-preview.2

{
  "isDeleted": false
}

Sample Response

Status code:: 200

{
  "id": 403,
  "code": 200,
  "type": "Bug",
  "name": "Test bug to be deleted and then restored",
  "project": "Fabrikam-Fiber-Git",
  "deletedDate": "1/11/2017 11:18:16 PM",
  "deletedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
  "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/403",
  "resource": {
    "id": 403,
    "rev": 3,
    "fields": {
      "System.AreaPath": "Fabrikam-Fiber-Git",
      "System.TeamProject": "Fabrikam-Fiber-Git",
      "System.IterationPath": "Fabrikam-Fiber-Git\\Release 1\\Sprint 2",
      "System.WorkItemType": "Bug",
      "System.State": "New",
      "System.Reason": "New defect reported",
      "System.CreatedDate": "2017-01-11T23:14:16.37Z",
      "System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
      "System.ChangedDate": "2017-01-11T23:18:16.03Z",
      "System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
      "System.Title": "Test bug to be deleted and then restored",
      "System.BoardColumn": "New",
      "System.BoardColumnDone": false,
      "Microsoft.VSTS.Common.StateChangeDate": "2017-01-11T23:14:16.37Z",
      "Microsoft.VSTS.Common.Priority": 2,
      "Microsoft.VSTS.Common.Severity": "3 - Medium",
      "WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column": "New",
      "WEF_6CB513B6E70E43499D9FC94E5BBFB784_Kanban.Column.Done": false,
      "Microsoft.VSTS.Common.ValueArea": "Business"
    },
    "_links": {
      "self": {
        "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/403"
      },
      "workItemUpdates": {
        "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/403/updates"
      },
      "workItemRevisions": {
        "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/403/revisions"
      },
      "workItemHistory": {
        "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/403/history"
      },
      "html": {
        "href": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=403"
      },
      "workItemType": {
        "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Bug"
      },
      "fields": {
        "href": "https://dev.azure.com/fabrikam/_apis/wit/fields"
      }
    },
    "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/403"
  }
}

Определения

Имя	Описание
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
WorkItem	Описывает рабочий элемент.
WorkItemCommentVersionRef	Представляет ссылку на определенную версию комментария к рабочему элементу.
WorkItemDelete	Полностью удаленный объект рабочего элемента. Включает сам рабочий элемент.
WorkItemDeleteUpdate	Описывает запрос на обновление для удаленного рабочего элемента.
WorkItemRelation

ReferenceLinks

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

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

WorkItem

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

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на связанные ресурсы REST.
commentVersionRef	WorkItemCommentVersionRef	Ссылка на определенную версию комментария, добавленного, измененного или удаленного в этой редакции.
fields	object	Карта поля и значений для рабочего элемента.
id	integer	Идентификатор рабочего элемента.
relations	WorkItemRelation[]	Отношения рабочего элемента.
rev	integer	Номер редакции рабочего элемента.
url	string

WorkItemCommentVersionRef

Представляет ссылку на определенную версию комментария к рабочему элементу.

Имя	Тип	Описание
commentId	integer	Идентификатор, назначенный примечания.
createdInRevision	integer	[Внутренний] Редакция рабочего элемента, в которой изначально был добавлен этот комментарий.
isDeleted	boolean	[Внутренний] Указывает, был ли удален комментарий.
text	string	[Внутренний] Текст комментария.
url	string
version	integer	Номер версии.

WorkItemDelete

Полностью удаленный объект рабочего элемента. Включает сам рабочий элемент.

Имя	Тип	Описание
code	integer	Код состояния HTTP для операции с рабочим элементом в пакетном запросе.
deletedBy	string	Пользователь, удаливший тип рабочего элемента.
deletedDate	string	Дата удаления рабочего элемента.
id	integer	Идентификатор рабочего элемента.
message	string	Сообщение об исключении для операции рабочего элемента в пакетном запросе.
name	string	Имя или название рабочего элемента.
project	string	Родительский проект удаленного рабочего элемента.
resource	WorkItem	Удаленный объект рабочего элемента.
type	string	Тип рабочего элемента.
url	string	URL-адрес REST API ресурса

WorkItemDeleteUpdate

Описывает запрос на обновление для удаленного рабочего элемента.

Имя	Тип	Описание
isDeleted	boolean	Задает значение, указывающее, удаляется ли этот рабочий элемент.

WorkItemRelation

Имя	Тип	Описание
attributes	object	Коллекция атрибутов ссылок.
rel	string	Тип связи.
url	string	URL-адрес ссылки.

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