Work Items - Create

Membuat satu item kerja.

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3
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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
organization
path True

string

Nama organisasi Azure DevOps.

project
path True

string

ID proyek atau nama proyek

type
path True

string

Tipe item kerja dari item kerja yang akan dibuat

api-version
query True

string

Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.3' untuk menggunakan versi api ini.

$expand
query

WorkItemExpand

Parameter perluas untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }.

bypassRules
query

boolean

Jangan menerapkan aturan tipe item kerja pada pembaruan ini

suppressNotifications
query

boolean

Jangan aktifkan pemberitahuan apa pun untuk perubahan ini

validateOnly
query

boolean

Menunjukkan apakah Anda hanya ingin memvalidasi perubahan tanpa menyimpan item kerja

Isi Permintaan

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

Nama Jenis Deskripsi
from

string

Jalur untuk menyalin dari untuk operasi Pindahkan/Salin.

op

Operation

Operasi patch

path

string

Jalur untuk operasi. Dalam kasus array, indeks berbasis nol dapat digunakan untuk menentukan posisi dalam array (misalnya /biskuit/0/name). Karakter "-" dapat digunakan alih-alih indeks untuk disisipkan di akhir array (misalnya /biskuit/-).

value

object

Nilai untuk operasi. Ini adalah primitif atau JToken.

Respons

Nama Jenis Deskripsi
200 OK

WorkItem

operasi berhasil

Keamanan

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

Nama Deskripsi
vso.work_write Memberikan kemampuan untuk membaca, membuat, dan memperbarui item dan kueri kerja, memperbarui metadata papan, membaca area dan jalur iterasi metadata terkait pelacakan item kerja lainnya, menjalankan kueri, dan menerima pemberitahuan tentang peristiwa item kerja melalui kait layanan.

Contoh

Create work item

Sample Request

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

{
  "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"
}

Definisi

Nama Deskripsi
JsonPatchDocument

Model JSON untuk Operasi Patch JSON

Operation

Operasi patch

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

WorkItem

Menjelaskan item kerja.

WorkItemCommentVersionRef

Mewakili referensi ke versi komentar tertentu pada Item Kerja.

WorkItemExpand

Parameter perluas untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }

WorkItemRelation

JsonPatchDocument

Model JSON untuk Operasi Patch JSON

Nama Jenis Deskripsi
from

string

Jalur untuk menyalin dari untuk operasi Pindahkan/Salin.

op

Operation

Operasi patch

path

string

Jalur untuk operasi. Dalam kasus array, indeks berbasis nol dapat digunakan untuk menentukan posisi dalam array (misalnya /biskuit/0/name). Karakter "-" dapat digunakan alih-alih indeks untuk disisipkan di akhir array (misalnya /biskuit/-).

value

object

Nilai untuk operasi. Ini adalah primitif atau JToken.

Operation

Operasi patch

Nama Jenis Deskripsi
add

string

copy

string

move

string

remove

string

replace

string

test

string

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama Jenis Deskripsi
links

object

Tampilan baca-saja dari tautan. Karena tautan Referensi dibaca saja, kami hanya ingin mengeksposnya sebagai baca-saja.

WorkItem

Menjelaskan item kerja.

Nama Jenis Deskripsi
_links

ReferenceLinks

Menautkan referensi ke sumber daya REST terkait.

commentVersionRef

WorkItemCommentVersionRef

Referensi ke versi tertentu dari komentar yang ditambahkan/diedit/dihapus dalam revisi ini.

fields

object

Peta bidang dan nilai untuk item kerja.

id

integer

ID item kerja.

relations

WorkItemRelation[]

Hubungan item kerja.

rev

integer

Nomor revisi item kerja.

url

string

WorkItemCommentVersionRef

Mewakili referensi ke versi komentar tertentu pada Item Kerja.

Nama Jenis Deskripsi
commentId

integer

Id yang ditetapkan untuk komentar.

createdInRevision

integer

[Internal] Revisi item kerja tempat komentar ini awalnya ditambahkan.

isDeleted

boolean

[Internal] Menentukan apakah komentar telah dihapus.

text

string

[Internal] Teks komentar.

url

string

version

integer

nomor versi.

WorkItemExpand

Parameter perluas untuk atribut item kerja. Opsi yang mungkin adalah { None, Relations, Fields, Links, All }

Nama Jenis Deskripsi
all

string

Memperluas semua.

fields

string

Item kerja bidang diperluas.

links

string

Item kerja tautan diperluas.

none

string

Perilaku default.

relations

string

Item kerja hubungan diperluas.

WorkItemRelation

Nama Jenis Deskripsi
attributes

object

Kumpulan atribut tautan.

rel

string

Jenis relasi.

url

string

Tautkan url.