Dela via

Projects - Get Project Properties

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

Get a collection of team project properties.

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 Parameters

Name In Required Type Description
organization
 path True

string

The name of the Azure DevOps organization.
projectId
 path True

string

uuid

The team project ID.
api-version
 query True

string

Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.
keys
 query

string

array (string)

A comma-delimited string of team project property names. Wildcard characters ("?" and "*") are supported. If no key is specified, all properties will be returned.

Responses

Name Type Description
200 OK

ProjectProperty[]

successful operation

Security

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 Description
vso.profile Grants the ability to read your profile, accounts, collections, projects, teams, and other top-level organizational artifacts.
vso.project Grants the ability to read projects and teams.

Examples

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

Definitions

ProjectProperty

A named value associated with a project.

Name Type Description
name

string

The name of the property.
value

object

The value of the property.