Types - Get

  • Reference
Service:
Policy
API Version:
5.0

Retrieve a specific policy type by ID.

GET https://{instance}/{collection}/{project}/_apis/policy/types/{typeId}?api-version=5.0

URI Parameters

Name In Required Type Description
collection
 path True

string

The name of the Azure DevOps collection.
instance
 path True

string

Azure DevOps server name ({server:port})
project
 path True

string

Project ID or project name
typeId
 path True

string

uuid

The policy ID.
api-version
 query True

string

Version of the API to use. This should be set to '5.0' to use this version of the api.

Responses

Name Type Description
200 OK

PolicyType

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.code Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks.

Definitions

Name Description
PolicyType

User-friendly policy type with description (used for querying policy types).
ReferenceLinks

The class to represent a collection of REST reference links.

PolicyType

User-friendly policy type with description (used for querying policy types).

Name Type Description
_links

ReferenceLinks

The links to other objects related to this object.
description

string

Detailed description of the policy type.
displayName

string

Display name of the policy type.
id

string

The policy type ID.
url

string

The URL where the policy type can be retrieved.

The class to represent a collection of REST reference links.

Name Type Description
links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.