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

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, kterou chcete vytvořit

api-version
query True

string

Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.3.

$expand
query

WorkItemExpand

Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { None, Relations, Fields, Links, All }.

bypassRules
query

boolean

Nevynucovat pravidla typu pracovní položky u této aktualizace

suppressNotifications
query

boolean

Pro tuto změnu neaktivujte žádná oznámení.

validateOnly
query

boolean

Uveďte, jestli chcete jenom ověřit změny 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řesunu nebo kopírování.

op

Operation

Operace opravy

path

string

Cesta pro operaci. V případě pole lze k určení pozice v matici použít index založený na nule (např. /biscuits/0/name). Znak "-" lze použít místo indexu pro 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

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 Uděluje možnost číst, vytvářet a aktualizovat pracovní položky a dotazy, metadata aktualizačního panelu, oblast čtení a iterace cest k jiným metadatům souvisejícím se sledováním pracovních položek, spouštět dotazy a přijímat oznámení o událostech pracovních položek prostřednictvím zachytávání služeb.

Příklady

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

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

Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { 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řesunu nebo kopírování.

op

Operation

Operace opravy

path

string

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

value

object

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

Operation

Operace opravy

Name Typ Description
add

string

copy

string

move

string

remove

string

replace

string

test

string

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

Name Typ Description
links

object

Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako odkazy 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 pole a hodnot pro pracovní položku

id

integer

ID pracovní položky.

relations

WorkItemRelation[]

Vztahy pracovní položky.

rev

integer

Čí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

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

createdInRevision

integer

[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

Číslo verze.

WorkItemExpand

Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { None, Relations, Fields, Links, All }

Name Typ Description
all

string

Rozbalí vše.

fields

string

Rozbalí se pracovní položka Pole.

links

string

Odkazy pracovní položku rozbalí.

none

string

Výchozí chování.

relations

string

Rozbalení pracovní položky relace

WorkItemRelation

Name Typ Description
attributes

object

Kolekce atributů odkazu.

rel

string

Typ relace.

url

string

Adresa URL odkazu.