Sdílet prostřednictvím


Work Items - Create

Vytvoří jednu pracovní položku.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
organization
path True

string

Název organizace Azure DevOps.

project
path True

string

ID projektu nebo název projektu

type
path True

string

Typ pracovní položky pracovní položky, kterou chcete vytvořit

api-version
query True

string

Verze rozhraní API, která se má použít. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.

$expand
query

WorkItemExpand

Parametry rozbalení pro atributy pracovní položky Možné možnosti: { None, Relations, Fields, Links, All }.

bypassRules
query

boolean

V této aktualizaci nevynucujte pravidla typů pracovních položek.

suppressNotifications
query

boolean

Neaktivujte žádná oznámení pro tuto změnu

validateOnly
query

boolean

Uveďte, jestli chcete změny ověřit pouze bez uložení pracovní položky.

Text požadavku

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

Name Typ Description
from

string

Cesta, ze které se má kopírovat pro operaci Přesunout/kopírovat.

op

Operation

Operace opravy

path

string

Cesta pro operaci. V případě pole lze k určení pozice v matici použít nulový index (např. /biscuits/0/name). Znak "-" lze použít místo indexu k vložení na konec pole (např. /biscuits/-).

value

object

Hodnota operace. Toto je buď primitivní, nebo JToken.

Odpovědi

Name Typ Description
200 OK

WorkItem

úspěšná operace

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name Description
vso.work_write Uděluje možnost číst, vytvářet a aktualizovat pracovní položky a dotazy, metadata aktualizačního panelu, oblast čtení a iterace cesty k jiným metadatům souvisejícím se sledováním pracovních položek, spouštění dotazů a přijímání oznámení o událostech pracovních položek prostřednictvím volání služeb.

Příklady

Create work item

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
JsonPatchDocument

Model JSON pro operace oprav JSON

Operation

Operace opravy

ReferenceLinks

Třída představující kolekci odkazů REST.

WorkItem

Popisuje pracovní položku.

WorkItemCommentVersionRef

Představuje odkaz na konkrétní verzi komentáře k pracovní položce.

WorkItemExpand

Parametry rozbalení pro atributy pracovní položky Možné možnosti: { None, Relations, Fields, Links, All }

WorkItemRelation

JsonPatchDocument

Model JSON pro operace oprav JSON

Name Typ Description
from

string

Cesta, ze které se má kopírovat pro operaci Přesunout/kopírovat.

op

Operation

Operace opravy

path

string

Cesta pro operaci. V případě pole lze k určení pozice v matici použít nulový index (např. /biscuits/0/name). Znak "-" lze použít místo indexu k vložení na konec pole (např. /biscuits/-).

value

object

Hodnota operace. Toto je buď primitivní, nebo JToken.

Operation

Operace opravy

Hodnota Description
add
copy
move
remove
replace
test

Třída představující kolekci odkazů REST.

Name Typ Description
links

object

Jen pro čtení odkazů. Vzhledem k tomu, že odkazy odkazy jsou jen pro čtení, chceme je zveřejnit jen pro čtení.

WorkItem

Popisuje pracovní položku.

Name Typ Description
_links

ReferenceLinks

Odkazy na související prostředky REST

commentVersionRef

WorkItemCommentVersionRef

Odkaz na konkrétní verzi komentáře přidaného, upraveného nebo odstraněného v této revizi

fields

object

Mapa polí a hodnot pro pracovní položku

id

integer (int32)

ID pracovní položky.

relations

WorkItemRelation[]

Vztahy pracovní položky

rev

integer (int32)

Číslo revize pracovní položky

url

string

WorkItemCommentVersionRef

Představuje odkaz na konkrétní verzi komentáře k pracovní položce.

Name Typ Description
commentId

integer (int32)

ID přiřazené k komentáři.

createdInRevision

integer (int32)

[Interní] Revize pracovní položky, do které byl tento komentář původně přidán.

isDeleted

boolean

[Interní] Určuje, jestli byl komentář odstraněn.

text

string

[Interní] Text komentáře.

url

string

version

integer (int32)

Číslo verze.

WorkItemExpand

Parametry rozbalení pro atributy pracovní položky Možné možnosti: { None, Relations, Fields, Links, All }

Hodnota Description
all

Rozbalí vše.

fields

Rozbalení pracovní položky pole

links

Odkazy na rozbalení pracovní položky

none

Výchozí chování

relations

Rozbalení pracovní položky vztahů

WorkItemRelation

Name Typ Description
attributes

object

Kolekce atributů propojení

rel

string

Typ relace.

url

string

Adresa URL odkazu.