Projects - Get Project Properties

  • Referenz
Service:
Core
API Version:
7.1-preview.1

Rufen Sie eine Sammlung von Teamprojekteigenschaften ab.

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

Name In Erforderlich Typ Beschreibung
organization
 path True

string

Der Name der Azure DevOps-Organisation.
projectId
 path True

string

uuid

Die Teamprojekt-ID.
api-version
 query True

string

Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.
keys
 query

string

array (string)

Eine durch Trennzeichen getrennte Zeichenfolge von Teamprojekteigenschaftennamen. Die Wildcardzeichen ("?" und "*") werden unterstützt. Wenn kein Schlüssel angegeben ist, werden alle Eigenschaften zurückgegeben.

Antworten

Name Typ Beschreibung
200 OK

ProjectProperty[]

Erfolgreicher Vorgang

Sicherheit

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 Beschreibung
vso.profile Gewährt die Möglichkeit, Ihr Profil, Ihre Konten, Sammlungen, Projekte, Teams und andere Organisationsartefakte auf oberster Ebene zu lesen.
vso.project Gewährt die Möglichkeit, Projekte und Teams zu lesen.

Beispiele

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

Definitionen

ProjectProperty

Ein benannter Wert, der einem Projekt zugeordnet ist.

Name Typ Beschreibung
name

string

Den Namen der Eigenschaft.
value

object

Der Wert der Eigenschaft.