Plans - Create

Ссылка

Service:: Work

API Version:: 7.1-preview.1

Добавление нового плана для команды

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.

Текст запроса

Имя	Тип	Описание
description	string	Описание плана
name	string	Имя создаваемого плана.
properties	object	Свойства плана.
type	PlanType	Тип создаваемого плана.

Ответы

Имя	Тип	Описание
200 OK	Plan	успешная операция

Безопасность

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

Имя	Описание
vso.work_write	Предоставляет возможность читать, создавать и обновлять рабочие элементы и запросы, обновлять метаданные доски, пути к областям чтения и итерациям других связанных метаданных отслеживания рабочих элементов, выполнять запросы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Имя

Описание

vso.work_write

Предоставляет возможность читать, создавать и обновлять рабочие элементы и запросы, обновлять метаданные доски, пути к областям чтения и итерациям других связанных метаданных отслеживания рабочих элементов, выполнять запросы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Определения

Имя	Описание
CreatePlan
IdentityRef
Plan	Контракт данных для определения плана
PlanType	Тип создаваемого плана.
PlanUserPermissions	Битовый флаг, указывающий набор разрешений, которые пользователь имеет для плана.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.

CreatePlan

Имя	Тип	Описание
description	string	Описание плана
name	string	Имя создаваемого плана.
properties	object	Свойства плана.
type	PlanType	Тип создаваемого плана.

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое — можно получить запрос пользователя Graph, на который ссылается запись self словаря IdentityRef _links.
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string	Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Нерекомендуемое — можно получить запрос к состоянию членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links".
isAadIdentity	boolean	Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Не рекомендуется — не используется в большинстве уже существовающих реализаций ToIdentityRef
uniqueName	string	Не рекомендуется использовать вместо него домен+principalName.
url	string	Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа.

Plan

Контракт данных для определения плана

Имя	Тип	Описание
createdByIdentity	IdentityRef	Удостоверение, создающее этот план. По умолчанию используется значение NULL для записей перед обновлением до ScaledAgileViewComponent4.
createdDate	string	Дата создания плана
description	string	Описание плана
id	string	Идентификатор плана
lastAccessed	string	Дата последнего доступа к плану. Значением по умолчанию является NULL.
modifiedByIdentity	IdentityRef	Удостоверение, изменяющее этот план в последний раз. По умолчанию используется значение NULL для записей перед обновлением до ScaledAgileViewComponent4.
modifiedDate	string	Дата последнего изменения плана. По умолчанию используется значение CreatedDate при первом создании плана.
name	string	Имя плана
properties	object	Экземпляр PlanPropertyCollection, связанный с планом. Они зависят от типа плана. Например, DeliveryTimelineView, он будет иметь тип DeliveryViewPropertyCollection.
revision	integer	Пересмотр плана. Используется для защиты пользователей от перезаписи изменений друг друга.
type	PlanType	Тип плана
url	string	URL-адрес ресурса для поиска плана с помощью REST API
userPermissions	PlanUserPermissions	Битовый флаг, указывающий набор разрешений, которые пользователь имеет для плана.

PlanType

Тип создаваемого плана.

Имя	Тип	Описание
deliveryTimelineView	string

PlanUserPermissions

Битовый флаг, указывающий набор разрешений, которые пользователь имеет для плана.

Имя	Тип	Описание
allPermissions	string	Разрешение на полный доступ для этого плана.
delete	string	Разрешение на удаление этого плана.
edit	string	Разрешение на обновление этого плана.
manage	string	Разрешение на управление этим планом.
none	string	Нет
view	string	Разрешение на просмотр этого плана.

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

Поделиться через