Processes - List

Получение списка всех процессов, включая системные и унаследованные.

GET https://dev.azure.com/{organization}/_apis/work/processes?api-version=7.1-preview.2
GET https://dev.azure.com/{organization}/_apis/work/processes?$expand={$expand}&api-version=7.1-preview.2

Параметры URI

Имя В Обязательно Тип Описание
organization
path True

string

Название организации Azure DevOps.

api-version
query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.2.

$expand
query

GetProcessExpandLevel

Ответы

Имя Тип Описание
200 OK

ProcessInfo[]

успешная операция

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

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 Предоставляет возможность чтения рабочих элементов, запросов, досок, путей областей и итераций, а также других метаданных, связанных с отслеживанием рабочих элементов. Также предоставляет возможность выполнять запросы, искать рабочие элементы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Примеры

Get the list of processes

Sample Request

GET https://dev.azure.com/{organization}/_apis/work/processes?api-version=7.1-preview.2

Sample Response

{
  "count": 14,
  "value": [
    {
      "typeId": "adcc42ab-9882-485e-a3ed-7678f01f66bc",
      "referenceName": null,
      "name": "Agile",
      "description": "This template is flexible and will work great for most teams using Agile planning methods, including those practicing Scrum.",
      "parentProcessTypeId": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "isDefault": true,
      "customizationType": "System"
    },
    {
      "typeId": "27450541-8e31-4150-9947-dc59f998fc01",
      "referenceName": null,
      "name": "CMMI",
      "description": "This template is for more formal projects requiring a framework for process improvement and an auditable record of decisions.",
      "parentProcessTypeId": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "isDefault": false,
      "customizationType": "System"
    },
    {
      "typeId": "6b724908-ef14-45cf-84f8-768b5384da45",
      "referenceName": null,
      "name": "Scrum",
      "description": "This template is for teams who follow the Scrum framework.",
      "parentProcessTypeId": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "isDefault": false,
      "customizationType": "System"
    },
    {
      "typeId": "e31fd6e1-c6af-44bb-925e-dfa71f551463",
      "referenceName": null,
      "name": "CustomProcess",
      "description": "This template is flexible and will work great for most teams using Agile planning methods, including those practicing Scrum.",
      "parentProcessTypeId": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "isDefault": false,
      "customizationType": "Inherited"
    }
  ]
}

Определения

Имя Описание
CustomizationType

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

GetProcessExpandLevel
ProcessInfo

Обработка.

ProjectReference

Определяет класс ссылки проекта.

CustomizationType

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

Имя Тип Описание
custom

string

Тип настройки имеет значение Custom, если только что созданный тип рабочего элемента настроен.

inherited

string

Тип настройки наследуется, если настроен существующий рабочий тип наследуемого процесса.

system

string

Тип настройки — System, если — это созданный системой тип рабочего элемента.

GetProcessExpandLevel

Имя Тип Описание
none

string

Уровень развертывания отсутствует.

projects

string

Уровень развертывания проектов.

ProcessInfo

Обработка.

Имя Тип Описание
customizationType

CustomizationType

Указывает тип настройки этого процесса. Системный процесс — это процесс по умолчанию. Наследуемый процесс — это измененный процесс, который ранее был системным процессом.

description

string

Описание процесса.

isDefault

boolean

Процесс по умолчанию.

isEnabled

boolean

Включен ли процесс.

name

string

Имя процесса.

parentProcessTypeId

string

Идентификатор родительского процесса.

projects

ProjectReference[]

Проекты в этом процессе, на которые подписан пользователь.

referenceName

string

Имя ссылки на процесс.

typeId

string

Идентификатор процесса.

ProjectReference

Определяет класс ссылки проекта.

Имя Тип Описание
description

string

Описание проекта

id

string

Идентификатор проекта

name

string

Имя проекта.

url

string

URL-адрес проекта