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 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path	True	string	프로젝트 ID 또는 프로젝트 이름
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"

Name	형식	Description
from	string	이동/복사 작업에 대해 복사할 경로입니다.
op	Operation	패치 작업
path	string	작업의 경로입니다. 배열의 경우 0부터 시작하는 인덱스를 사용하여 배열의 위치를 지정할 수 있습니다(예: /biscuits/0/name). 배열의 끝에 삽입할 인덱스 대신 "-" 문자를 사용할 수 있습니다(예: /biscuits/-).
value	object	작업의 값입니다. 기본 형식 또는 JToken입니다.

응답

Name	형식	Description
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

Name	Description
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"
}

정의

Name	Description
JsonPatchDocument	JSON 패치 작업에 대한 JSON 모델
Operation	패치 작업
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
WorkItem	작업 항목을 설명합니다.
WorkItemCommentVersionRef	작업 항목에 대한 특정 버전의 주석에 대한 참조를 나타냅니다.
WorkItemExpand	작업 항목 특성에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Relations, Fields, Links, All }입니다.
WorkItemRelation

JsonPatchDocument

JSON 패치 작업에 대한 JSON 모델

Name	형식	Description
from	string	이동/복사 작업에 대해 복사할 경로입니다.
op	Operation	패치 작업
path	string	작업의 경로입니다. 배열의 경우 0부터 시작하는 인덱스를 사용하여 배열의 위치를 지정할 수 있습니다(예: /biscuits/0/name). 배열의 끝에 삽입할 인덱스 대신 "-" 문자를 사용할 수 있습니다(예: /biscuits/-).
value	object	작업의 값입니다. 기본 형식 또는 JToken입니다.

Operation

패치 작업

Name	형식	Description
add	string
copy	string
move	string
remove	string
replace	string
test	string

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

WorkItem

작업 항목을 설명합니다.

Name	형식	Description
_links	ReferenceLinks	관련 REST 리소스에 대한 참조를 연결합니다.
commentVersionRef	WorkItemCommentVersionRef	이 수정 버전에서 추가/편집/삭제된 특정 버전의 주석에 대한 참조입니다.
fields	object	작업 항목에 대한 필드 및 값의 맵입니다.
id	integer	작업 항목 ID입니다.
relations	WorkItemRelation[]	작업 항목의 관계입니다.
rev	integer	작업 항목의 수정 번호입니다.
url	string

WorkItemCommentVersionRef

작업 항목에 대한 특정 버전의 주석에 대한 참조를 나타냅니다.

Name	형식	Description
commentId	integer	주석에 할당된 ID입니다.
createdInRevision	integer	[내부] 이 주석이 원래 추가된 작업 항목 수정 버전입니다.
isDeleted	boolean	[내부] 주석이 삭제되었는지 여부를 지정합니다.
text	string	[내부] 주석의 텍스트입니다.
url	string
version	integer	버전 번호입니다.

WorkItemExpand

작업 항목 특성에 대한 확장 매개 변수입니다. 가능한 옵션은 { None, Relations, Fields, Links, All }입니다.

Name	형식	Description
all	string	모두 확장합니다.
fields	string	필드 작업 항목이 확장됩니다.
links	string	링크 작업 항목이 확장됩니다.
none	string	기본 동작
relations	string	관계 작업 항목이 확장됩니다.

WorkItemRelation

Name	형식	Description
attributes	object	링크 특성의 컬렉션입니다.
rel	string	관계 유형입니다.
url	string	링크 URL입니다.