Work Items - Create

Ссылка

Service:: Work Item Tracking

API Version:: 7.1-preview.3

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

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&$expand={$expand}&api-version=7.1-preview.3

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор или имя проекта
type	path	True	string	Тип рабочего элемента создаваемого рабочего элемента
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.3.
$expand	query		WorkItemExpand	Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { None, Relations, Fields, Links, All }.
bypassRules	query		boolean	Не применять правила типа рабочих элементов в этом обновлении
suppressNotifications	query		boolean	Не запускайте уведомления об этом изменении
validateOnly	query		boolean	Укажите, требуется ли только проверить изменения без сохранения рабочего элемента

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

Media Types: "application/json-patch+json"

Имя	Тип	Описание
from	string	Путь для копирования для операции перемещения и копирования.
op	Operation	Операция исправления
path	string	Путь к операции. В случае массива для указания позиции в массиве можно использовать отсчитываемый от нуля индекс (например, /biscuits/0/name). Символ "-" можно использовать вместо индекса для вставки в конце массива (например, /biscuits/-).
value	object	Значение операции. Это либо примитив, либо JToken.

Ответы

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

Имя

Описание

vso.work_write

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

Примеры

Create work item

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3

[
  {
    "op": "add",
    "path": "/fields/System.Title",
    "from": null,
    "value": "Sample task"
  }
]

Sample Response

Status code:: 200

{
  "id": 131489,
  "rev": 1,
  "fields": {
    "System.AreaPath": "CustomProcessPrj",
    "System.TeamProject": "CustomProcessPrj",
    "System.IterationPath": "CustomProcessPrj",
    "System.WorkItemType": "Task",
    "System.State": "New",
    "System.Reason": "New",
    "System.CreatedDate": "2017-10-06T01:04:51.57Z",
    "System.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"
    },
    "System.ChangedDate": "2017-10-06T01:04:51.57Z",
    "System.ChangedBy": {
      "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"
    },
    "System.Title": "Sample task",
    "Microsoft.VSTS.Common.StateChangeDate": "2017-10-06T01:04:51.57Z",
    "Microsoft.VSTS.Common.Priority": 2
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
    },
    "workItemUpdates": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/updates"
    },
    "workItemRevisions": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/revisions"
    },
    "workItemHistory": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/history"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=20cda608-32f0-4e6e-9b7c-8def7b38d15a&id=131489"
    },
    "workItemType": {
      "href": "https://dev.azure.com/fabrikam/aaee31d9-14cf-48b9-a92b-3f1446c13f80/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
}

Определения

Имя	Описание
JsonPatchDocument	Модель JSON для операций исправления JSON
Operation	Операция исправления
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
WorkItem	Описывает рабочий элемент.
WorkItemCommentVersionRef	Представляет ссылку на определенную версию комментария к рабочему элементу.
WorkItemExpand	Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { None, Relations, Fields, Links, All }
WorkItemRelation

JsonPatchDocument

Модель JSON для операций исправления JSON

Имя	Тип	Описание
from	string	Путь для копирования для операции перемещения и копирования.
op	Operation	Операция исправления
path	string	Путь к операции. В случае массива для указания позиции в массиве можно использовать отсчитываемый от нуля индекс (например, /biscuits/0/name). Символ "-" можно использовать вместо индекса для вставки в конце массива (например, /biscuits/-).
value	object	Значение операции. Это либо примитив, либо JToken.

Operation

Операция исправления

Имя	Тип	Описание
add	string
copy	string
move	string
remove	string
replace	string
test	string

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	Номер версии.

WorkItemExpand

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { None, Relations, Fields, Links, All }

Имя	Тип	Описание
all	string	Разворачивает все.
fields	string	Развернуть рабочий элемент "Поля".
links	string	Разверните рабочий элемент ссылок.
none	string	Поведение по умолчанию.
relations	string	Рабочий элемент "Отношения" разверните.

WorkItemRelation

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

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