Plans - Create

Usługa:

Work

Wersja interfejsu API:

6.0

Dodawanie nowego planu dla zespołu

POST https://dev.azure.com/{organization}/{project}/_apis/work/plans?api-version=6.0

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "6.0", aby używać tej wersji interfejsu API.

Treść żądania

Nazwisko	Typ	Opis
description	string	Opis planu
name	string	Nazwa planu do utworzenia.
properties	object	Planowanie właściwości.
type	PlanType	Typ planu do utworzenia.

Odpowiedzi

Nazwisko	Typ	Opis
200 OK	Plan	operacja zakończona powodzeniem

Zabezpieczenia

accessToken

Osobisty token dostępu. Użyj dowolnej wartości nazwy użytkownika i tokenu jako hasła.

Typ: basic

Definicje

Nazwisko	Opis
CreatePlan
IdentityRef
Plan	Kontrakt danych dla definicji planu
PlanType	Typ planu do utworzenia.
PlanUserPermissions	Flaga bitowa wskazująca zestaw uprawnień, które użytkownik ma do planu.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.

CreatePlan

Objekt

Nazwisko	Typ	Opis
description	string	Opis planu
name	string	Nazwa planu do utworzenia.
properties	object	Planowanie właściwości.
type	PlanType	Typ planu do utworzenia.

IdentityRef

Objekt

Nazwisko	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwoływanie się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string	Przestarzałe — można je pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji elementu ToIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

Plan

Objekt

Kontrakt danych dla definicji planu

Nazwisko	Typ	Opis
createdByIdentity	IdentityRef	Tożsamość, która utworzyła ten plan. Wartość domyślna to null dla rekordów przed uaktualnieniem do elementu ScaledAgileViewComponent4.
createdDate	string	Data utworzenia planu
description	string	Opis planu
id	string	Identyfikator planu
modifiedByIdentity	IdentityRef	Tożsamość, która ostatnio zmodyfikowała ten plan. Wartość domyślna to null dla rekordów przed uaktualnieniem do elementu ScaledAgileViewComponent4.
modifiedDate	string	Data ostatniej modyfikacji planu. Wartość domyślna to CreatedDate podczas pierwszego utworzenia planu.
name	string	Nazwa planu
properties	object	Wystąpienie PlanPropertyCollection skojarzone z planem. Są one zależne od typu planu. Na przykład DeliveryTimelineView będzie to typ DeliveryViewPropertyCollection.
revision	integer	Zmiana planu. Służy do ochrony użytkowników przed zastępowaniem zmian.
type	PlanType	Typ planu
url	string	Adres URL zasobu do lokalizowania planu za pośrednictwem interfejsu API REST
userPermissions	PlanUserPermissions	Flaga bitowa wskazująca zestaw uprawnień, które użytkownik ma do planu.

PlanType

Wyliczenie

Typ planu do utworzenia.

Wartość	Opis
deliveryTimelineView

PlanUserPermissions

Wyliczenie

Flaga bitowa wskazująca zestaw uprawnień, które użytkownik ma do planu.

Wartość	Opis
none	Brak
view	Uprawnienie do wyświetlania tego planu.
edit	Uprawnienie do aktualizowania tego planu.
delete	Uprawnienie do usuwania tego planu.
manage	Uprawnienie do zarządzania tym planem.
allPermissions	Uprawnienie pełnej kontroli dla tego planu.

ReferenceLinks

Objekt

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

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