Work Items - Create

Odwołanie

Service:: Work Item Tracking

API Version:: 7.1-preview.3

Tworzy pojedynczy element roboczy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
type	path	True	string	Typ elementu roboczego elementu roboczego do utworzenia
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "7.1-preview.3", aby używać tej wersji interfejsu API.
$expand	query		WorkItemExpand	Parametry rozwijania atrybutów elementu roboczego. Możliwe opcje to { None, Relations, Fields, Links, All }.
bypassRules	query		boolean	Nie wymuszaj reguł typów elementów roboczych w tej aktualizacji
suppressNotifications	query		boolean	Nie uruchamiaj żadnych powiadomień dotyczących tej zmiany
validateOnly	query		boolean	Wskaż, czy chcesz tylko zweryfikować zmiany bez zapisywania elementu roboczego

Treść żądania

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

Nazwa	Typ	Opis
from	string	Ścieżka do skopiowania dla operacji Przenoszenia/kopiowania.
op	Operation	Operacja stosowania poprawek
path	string	Ścieżka operacji. W przypadku tablicy można użyć indeksu opartego na zera, aby określić pozycję w tablicy (np. /biscuits/0/name). Znak "-" można użyć zamiast indeksu do wstawienia na końcu tablicy (np. /biscuits/-).
value	object	Wartość operacji. Jest to element pierwotny lub token JToken.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkItem	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.work_write	Umożliwia odczytywanie, tworzenie i aktualizowanie elementów roboczych i zapytań, aktualizowanie metadanych tablicy, ścieżki obszaru odczytu i iteracji innych metadanych powiązanych z elementami roboczymi, wykonywanie zapytań i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Przykłady

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

Definicje

Nazwa	Opis
JsonPatchDocument	Model JSON dla operacji poprawek JSON
Operation	Operacja stosowania poprawek
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
WorkItem	Opisuje element roboczy.
WorkItemCommentVersionRef	Reprezentuje odwołanie do określonej wersji komentarza dotyczącego elementu roboczego.
WorkItemExpand	Parametry rozwijania atrybutów elementu roboczego. Możliwe opcje to { None, Relations, Fields, Links, All }
WorkItemRelation

JsonPatchDocument

Model JSON dla operacji poprawek JSON

Nazwa	Typ	Opis
from	string	Ścieżka do skopiowania dla operacji Przenoszenia/kopiowania.
op	Operation	Operacja stosowania poprawek
path	string	Ścieżka operacji. W przypadku tablicy można użyć indeksu opartego na zera, aby określić pozycję w tablicy (np. /biscuits/0/name). Znak "-" można użyć zamiast indeksu do wstawienia na końcu tablicy (np. /biscuits/-).
value	object	Wartość operacji. Jest to element pierwotny lub token JToken.

Operation

Operacja stosowania poprawek

Nazwa	Typ	Opis
add	string
copy	string
move	string
remove	string
replace	string
test	string

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

WorkItem

Opisuje element roboczy.

Nazwa	Typ	Opis
_links	ReferenceLinks	Linki do powiązanych zasobów REST.
commentVersionRef	WorkItemCommentVersionRef	Odwołanie do określonej wersji komentarza dodanego/edytowanego/usuniętego w tej wersji.
fields	object	Mapa pól i wartości elementu roboczego.
id	integer	Identyfikator elementu roboczego.
relations	WorkItemRelation[]	Relacje elementu roboczego.
rev	integer	Numer poprawki elementu roboczego.
url	string

WorkItemCommentVersionRef

Reprezentuje odwołanie do określonej wersji komentarza dotyczącego elementu roboczego.

Nazwa	Typ	Opis
commentId	integer	Identyfikator przypisany do komentarza.
createdInRevision	integer	[Wewnętrzne] Poprawka elementu roboczego, w której ten komentarz został pierwotnie dodany.
isDeleted	boolean	[Wewnętrzne] Określa, czy komentarz został usunięty.
text	string	[Wewnętrzne] Tekst komentarza.
url	string
version	integer	Numer wersji.

WorkItemExpand

Parametry rozwijania atrybutów elementu roboczego. Możliwe opcje to { None, Relations, Fields, Links, All }

Nazwa	Typ	Opis
all	string	Rozwija wszystko.
fields	string	Rozwiń element roboczy Pola.
links	string	Umożliwia rozwinięcie elementu roboczego łączy.
none	string	Domyślne zachowanie.
relations	string	Rozwiń element roboczy Relacje.

WorkItemRelation

Nazwa	Typ	Opis
attributes	object	Kolekcja atrybutów łącza.
rel	string	Typ relacji.
url	string	Adres URL łącza.