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

Work Items - Create

  • Ссылка
Служба:
Work Item Tracking
Версия API:
7.1

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

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1
С использованием необязательных параметров: 
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&$expand={$expand}&api-version=7.1

Параметры URI

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

string

Имя организации Azure DevOps.
project
 path True

string

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

string

Тип рабочего элемента для создания рабочего элемента
api-version
 query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".
$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

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

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

Примеры

Create work item

Образец запроса

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

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

Пример ответа

Код состояния:
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

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

JsonPatchDocument

Object

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

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

string

Путь к копированию из операции перемещения и копирования.
op

Operation

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

string

Путь к операции. В случае массива индекс на основе нуля можно использовать для указания позиции в массиве (например, /biscuits/0/name). Символ "-" можно использовать вместо индекса для вставки в конец массива (например, /biscuits/-).
value

object

Значение операции. Это либо примитив, либо JToken.

Operation

Перечисление

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

Значение Описание
add
copy
move
remove
replace
test
Object

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

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

object

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

WorkItem

Object

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

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

ReferenceLinks

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

WorkItemCommentVersionRef

Ссылка на определенную версию комментария, добавленную или редактируемую или удаленную в этой редакции.
fields

object

Сопоставление полей и значений для рабочего элемента.
id

integer (int32)

Идентификатор рабочего элемента.
relations

WorkItemRelation[]

Отношения рабочего элемента.
rev

integer (int32)

Номер редакции рабочего элемента.
url

string

WorkItemCommentVersionRef

Object

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

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

integer (int32)

Идентификатор, назначенный примечания.
createdInRevision

integer (int32)

[Внутренний] Редакция рабочего элемента, в которой изначально добавлен этот комментарий.
isDeleted

boolean

[Внутренний] Указывает, был ли удален комментарий.
text

string

[Внутренний] Текст комментария.
url

string

version

integer (int32)

Номер версии.

WorkItemExpand

Перечисление

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

Значение Описание
all

Развертывает все.
fields

Развернуть рабочий элемент полей.
links

Разверните рабочий элемент ссылок.
none

Поведение по умолчанию.
relations

Разверните рабочий элемент отношений.

WorkItemRelation

Object
Имя Тип Описание
attributes

object

Коллекция атрибутов ссылки.
rel

string

Тип отношения.
url

string

URL-адрес ссылки.