Projects - Get Project Properties

  • Ссылка
Service:
Core
API Version:
7.1-preview.1

Получение коллекции свойств командного проекта.

GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/properties?api-version=7.1-preview.1
With optional parameters: 
GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/properties?keys={keys}&api-version=7.1-preview.1

Параметры URI

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

string

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

string

uuid

Идентификатор командного проекта.
api-version
 query True

string

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

string

array (string)

Строка с разделителями-запятыми имен свойств командного проекта. Поддерживаются подстановочные знаки ("?" и "*"). Если ключ не указан, будут возвращены все свойства.

Ответы

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

ProjectProperty[]

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

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

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.profile Предоставляет возможность читать профиль, учетные записи, коллекции, проекты, команды и другие артефакты организации верхнего уровня.
vso.project Предоставляет возможность читать проекты и команды.

Примеры

Get all team project properties
Get specific team project properties

Get all team project properties

Sample Request

GET https://dev.azure.com/fabrikam/_apis/projects/{projectId}/properties?api-version=7.1-preview.1

Sample Response

Status code:
200 
{
  "count": 8,
  "value": [
    {
      "name": "System.CurrentProcessTemplateId",
      "value": "2dc3221a-2d39-4138-a4e1-fc4d20d8912d"
    },
    {
      "name": "System.OriginalProcessTemplateId",
      "value": "2dc3221a-2d39-4138-a4e1-fc4d20d8912d"
    },
    {
      "name": "System.ProcessTemplateType",
      "value": "adcc42ab-9882-485e-a3ed-7678f01f66bc"
    },
    {
      "name": "System.Process Template",
      "value": "Agile"
    },
    {
      "name": "System.Microsoft.TeamFoundation.Team.Default",
      "value": "9b7ae5b9-826f-4353-99d6-daaa5cd94ec6"
    },
    {
      "name": "System.SourceControlCapabilityFlags",
      "value": "2"
    },
    {
      "name": "System.SourceControlGitEnabled",
      "value": "True"
    },
    {
      "name": "System.SourceControlGitPermissionsInitialized",
      "value": "True"
    }
  ]
}

Get specific team project properties

Sample Request

GET https://dev.azure.com/fabrikam/_apis/projects/{projectId}/properties?keys=System.CurrentProcessTemplateId,*SourceControl*&api-version=7.1-preview.1

Sample Response

Status code:
200 
{
  "count": 4,
  "value": [
    {
      "name": "System.CurrentProcessTemplateId",
      "value": "2dc3221a-2d39-4138-a4e1-fc4d20d8912d"
    },
    {
      "name": "System.SourceControlCapabilityFlags",
      "value": "2"
    },
    {
      "name": "System.SourceControlGitEnabled",
      "value": "True"
    },
    {
      "name": "System.SourceControlGitPermissionsInitialized",
      "value": "True"
    }
  ]
}

Определения

ProjectProperty

Именованное значение, связанное с проектом.

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

string

Имя свойства.
value

object

Значение свойства.