Work Items - Get Work Item

Ссылка

Service:: Work Item Tracking

API Version:: 4.1

Возвращает один рабочий элемент.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=4.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?fields={fields}&asOf={asOf}&$expand={$expand}&api-version=4.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
id	path	True	integer int32	Идентификатор рабочего элемента
organization	path	True	string	Название организации Azure DevOps.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 4.1.
$expand	query		WorkItemExpand	Параметры развертывания для атрибутов рабочего элемента. Возможные варианты: { Нет, Связи, Поля, Ссылки, Все }.
asOf	query		string date-time	Строка даты и времени AsOf в формате UTC
fields	query		string array (string)	Разделенный запятыми список запрошенных полей

Ответы

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

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

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

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

Примеры

Get work item

Get work item with asOf parameter

Get work item

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/12?api-version=4.1

Sample Response

Status code:: 200

{
  "id": 12,
  "rev": 3,
  "fields": {
    "System.AreaPath": "MyAgilePrj2",
    "System.TeamProject": "MyAgilePrj2",
    "System.IterationPath": "MyAgilePrj2\\Iteration 1",
    "System.WorkItemType": "User Story",
    "System.State": "Active",
    "System.Reason": "Implementation started",
    "System.AssignedTo": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
    "System.CreatedDate": "2017-09-04T06:11:59.05Z",
    "System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
    "System.ChangedDate": "2017-10-04T23:32:02.18Z",
    "System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
    "System.Title": "Epic 2",
    "Microsoft.VSTS.Common.StateChangeDate": "2017-10-04T23:32:01.6Z",
    "Microsoft.VSTS.Common.ActivatedDate": "2017-10-04T23:32:01.6Z",
    "Microsoft.VSTS.Common.ActivatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
    "Microsoft.VSTS.Common.Priority": 2,
    "Microsoft.VSTS.Common.ValueArea": "Business",
    "System.Tags": "client; sample; teamservices"
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12"
    },
    "workItemUpdates": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12/updates"
    },
    "workItemRevisions": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12/revisions"
    },
    "workItemHistory": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12/history"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=20cda608-32f0-4e6e-9b7c-8def7b38d15a&id=12"
    },
    "workItemType": {
      "href": "https://dev.azure.com/fabrikam/54332e84-3d54-4c67-9bd0-0e88a9849330/_apis/wit/workItemTypes/User%20Story"
    },
    "fields": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12"
}

Get work item with asOf parameter

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/564?asOf=2017-12-21T19:42:54.230Z&api-version=4.1

Sample Response

Status code:: 200

{
  "id": 564,
  "rev": 4,
  "fields": {
    "System.AreaPath": "MyAgilePrj2",
    "System.TeamProject": "MyAgilePrj2",
    "System.IterationPath": "MyAgilePrj2\\Iteration 0",
    "System.WorkItemType": "Task",
    "System.State": "Proposed",
    "System.Reason": "New",
    "System.AssignedTo": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
    "System.CreatedDate": "2017-12-16T00:46:58.01Z",
    "System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
    "System.ChangedDate": "2017-12-16T00:49:08.81Z",
    "System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
    "System.Title": "t1.3",
    "Microsoft.VSTS.Common.StateChangeDate": "2017-12-16T00:46:58.01Z",
    "Microsoft.VSTS.Common.Priority": 2,
    "Microsoft.VSTS.CMMI.Blocked": "No",
    "Microsoft.VSTS.Common.Triage": "Pending",
    "Microsoft.VSTS.CMMI.TaskType": "Planned",
    "Microsoft.VSTS.CMMI.RequiresReview": "No",
    "Microsoft.VSTS.CMMI.RequiresTest": "No"
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/564/revisions/4"
    },
    "workItemRevisions": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/564/revisions"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/564"
    }
  },
  "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/564/revisions/4"
}

Определения

Имя	Описание
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
WorkItem	Описывает рабочий элемент.
WorkItemExpand	Параметры развертывания для атрибутов рабочего элемента. Возможные варианты: { Нет, Связи, Поля, Ссылки, Все }.
WorkItemRelation

ReferenceLinks

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

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

WorkItem

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

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

WorkItemExpand

Параметры развертывания для атрибутов рабочего элемента. Возможные варианты: { Нет, Связи, Поля, Ссылки, Все }.

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

WorkItemRelation

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

Work Items - Get Work Item

Параметры URI

Ответы

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

oauth2

Scopes

Примеры

Get work item

Sample Request

Sample Response

Get work item with asOf parameter

Sample Request

Sample Response

Определения

ReferenceLinks

WorkItem

WorkItemExpand

WorkItemRelation

Обратная связь

Дополнительные ресурсы