Bagikan melalui

Work Items - Get Work Item

  • Referensi
Service:
Work Item Tracking
API Version:
4.1

Mengembalikan satu item kerja.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
id
 path True

integer

int32

Id item kerja
organization
 path True

string

Nama organisasi Azure DevOps.
project
 path

string

ID proyek atau nama proyek
api-version
 query True

string

Versi API yang akan digunakan. Ini harus diatur ke '4.1' untuk menggunakan versi api ini.
$expand
 query

WorkItemExpand

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

string

date-time

String waktu tanggal AsOf UTC
fields
 query

string

array (string)

Daftar bidang yang diminta yang dipisahkan koma

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 Memberikan kemampuan untuk membaca item kerja, kueri, papan, jalur area dan iterasi, dan metadata terkait pelacakan item kerja lainnya. Juga memberikan kemampuan untuk menjalankan kueri dan menerima pemberitahuan tentang peristiwa item kerja melalui kait layanan.

Contoh

Get work item
Get work item with asOf parameter

Get work item

Sample Request

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

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

Definisi

Nama Deskripsi
ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.
WorkItem

Menjelaskan item kerja.
WorkItemExpand

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

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama Jenis Deskripsi
links

object

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

WorkItem

Menjelaskan item kerja.

Nama Jenis Deskripsi
_links

ReferenceLinks

Menautkan referensi ke sumber daya REST terkait.
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

WorkItemExpand

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

Nama Jenis Deskripsi
all

string

fields

string

links

string

none

string

relations

string

WorkItemRelation

Nama Jenis Deskripsi
attributes

object

Kumpulan atribut tautan.
rel

string

Jenis relasi.
url

string

Url tautan.