### Sample Request for Installed Extension Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions/get?view=azure-devops-rest-7.1 An example HTTP GET request to retrieve information about a specific installed extension. Replace placeholders with your organization, publisher, and extension details. ```HTTP GET https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensionsbyname/ms/samples-contributions-guide?api-version=7.1-preview.1 ``` -------------------------------- ### Sample Request to Install Extension Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions/install-extension-by-name?view=azure-devops-rest-7.1 This is an example of an HTTP POST request to install the 'samples-contributions-guide' extension published by 'ms'. ```http POST https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensionsbyname/ms/samples-contributions-guide?api-version=7.1-preview.1 ``` -------------------------------- ### Sample Request to List Installed Extensions Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions/list?view=azure-devops-rest-7.1 A practical example demonstrating how to call the API to list installed extensions for a specific organization. Replace 'fabrikam' with your organization name. ```HTTP GET https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensions?api-version=7.1-preview.1 ``` -------------------------------- ### Attachments API - Start Chunked Upload Example Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/attachments/create?view=azure-devops-rest-7.1 Example of how to initiate a chunked upload for a large file. ```APIDOC ## POST /_apis/wit/attachments (Chunked Upload Start) ### Description Initiates a chunked upload process for large files. ### Method POST ### Endpoint https://dev.azure.com/{organization}/{project}/_apis/wit/attachments?fileName={fileName}&uploadType=chunked&api-version=7.1 ### Request Example ```http POST https://dev.azure.com/fabrikam/_apis/wit/attachments?fileName=largefile.zip&uploadType=chunked&api-version=7.1 ``` ### Response Example (201 Created) ```json { "id": "de471719-27b2-40ab-ac40-4890f3eb1443", "url": "https://dev.azure.com/fabrikam/_apis/wit/attachments/de471719-27b2-40ab-ac40-4890f3eb1443?fileName=test.txt" } ``` ``` -------------------------------- ### GET System Controls Sample Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/processes/system-controls/list?view=azure-devops-rest-7.1 An example of a GET request to the System Controls API, demonstrating the structure with a sample process ID. ```http GET https://dev.azure.com/{organization}/_apis/work/processes/D7E1C086-907B-4705-A3AB-BB35117661CC/workItemTypes/{witRefName}/layout/systemcontrols?api-version=7.1 ``` -------------------------------- ### Sample Request for Get Release Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/release/releases/get-release?view=azure-devops-rest-7.1 An example of an HTTP GET request to retrieve a release. Replace '{releaseId}' with the actual ID of the release you want to fetch. ```http GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases/{releaseId}?api-version=7.1 ``` -------------------------------- ### Sample Request for Get Import Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/import-requests/get?view=azure-devops-rest-7.1 An example of an HTTP GET request to retrieve a specific import request. ```HTTP GET https://dev.azure.com/fabrikam/Test/_apis/git/repositories/0eb02d2e-fff9-4990-bd45-2f7503f5aae5/importRequests/2?api-version=7.1 ``` -------------------------------- ### Sample Request: Get Repository by Repository ID Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/repositories/get-repository?view=azure-devops-rest-7.1 This example demonstrates an HTTP GET request to retrieve a repository using its unique repository ID. Ensure the 'api-version' is set correctly. ```HTTP GET https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6?api-version=7.1 ``` -------------------------------- ### Sample Request for Test Configuration Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/testplan/configurations/get?view=azure-devops-rest-7.1 An example of an HTTP GET request to fetch a test configuration. Ensure you substitute '{project}' and '{testConfigurationId}' with actual values. ```http GET https://dev.azure.com/fabrikam/{project}/_apis/testplan/configurations/{testConfigurationId}?api-version=7.1 ``` -------------------------------- ### Get Project with Optional Parameters Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/core/projects/get?view=azure-devops-rest-7.1 This example shows how to retrieve project details while including optional parameters such as capabilities and history. Set includeCapabilities to true to get details like source control, and includeHistory to search within renamed projects. ```HTTP GET https://dev.azure.com/{organization}/_apis/projects/{projectId}?includeCapabilities={includeCapabilities}&includeHistory={includeHistory}&api-version=7.1 ``` -------------------------------- ### Sample Response for Successful Extension Installation Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions/install-extension-by-name?view=azure-devops-rest-7.1 A successful installation returns a 200 OK status code with details about the installed extension, including its ID, name, publisher, version, and installation state. ```json { "extensionId": "samples-contributions-guide", "extensionName": "Contributions Guide", "publisherId": "ms-samples", "publisherName": "Microsoft", "version": "0.1.35", "installState": { "flags": "none", "lastUpdated": "2017-11-30T21:38:02.463Z" }, "lastPublished": "2017-01-19T13:28:00.85Z" } ``` -------------------------------- ### Sample Request to List Repositories Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/repositories/list?view=azure-devops-rest-7.1 An example of an HTTP GET request to list repositories for the 'fabrikam' organization and a specific project. This demonstrates the basic structure of the request. ```HTTP GET https://dev.azure.com/fabrikam/_apis/git/repositories?api-version=7.1 ``` -------------------------------- ### Sample Request for Get Release Revision Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/release/releases/get-release-revision?view=azure-devops-rest-7.1 This is an example of a complete HTTP GET request to fetch a release revision. It includes a specific value for definitionSnapshotRevision. ```HTTP GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?definitionSnapshotRevision=1&api-version=7.1 ``` -------------------------------- ### Sample request to get list metadata Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/processes/lists/get?view=azure-devops-rest-7.1 This is an example of an HTTP GET request to retrieve the metadata for a specific picklist within an Azure DevOps organization. ```http GET https://dev.azure.com/fabrikam/_apis/work/processes/lists/{listId}?api-version=7.1 ``` -------------------------------- ### Get Installed Extension by Name (Basic) Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions/get?view=azure-devops-rest-7.1 Use this endpoint to retrieve details of an installed extension by specifying the publisher and extension names. No optional parameters are included. ```HTTP GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}?api-version=7.1-preview.1 ``` -------------------------------- ### Sample Request to List Projects Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/core/projects/list?view=azure-devops-rest-7.1 This is an example of a GET request to list projects for a specific organization. Ensure you replace 'fabrikam' with your actual organization name. ```HTTP GET https://dev.azure.com/fabrikam/_apis/projects?api-version=7.1 ``` -------------------------------- ### Sample HTTP GET Request for Widget Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/dashboard/widgets/get-widget?view=azure-devops-rest-7.1 An example of an HTTP GET request to retrieve a specific widget. This sample uses 'fabrikam' as the organization and includes specific IDs for the project, dashboard, and widget. ```http GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf?api-version=7.1-preview.2 ``` -------------------------------- ### Sample Request for Getting Templates Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/templates/list?view=azure-devops-rest-7.1 An example HTTP GET request to list work item templates. Replace placeholders like {organization}, {project}, and {team} with your specific Azure DevOps details. ```http GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/templates?api-version=7.1 ``` -------------------------------- ### Get Process Behavior - Sample Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/processes/behaviors/get?view=azure-devops-rest-7.1 A concrete example of a GET request to fetch a process behavior. This sample uses specific values for organization, process ID, and behavior reference name. ```http GET https://dev.azure.com/fabrikam/_apis/work/processes/906c7065-2a04-4f61-aac1-b5da9cef040b/behaviors/System.RequirementBacklogBehavior?api-version=7.1 ``` -------------------------------- ### Sample GET Service Principal Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/graph/service-principals/get?view=azure-devops-rest-7.1 An example of a GET request to retrieve a service principal. This includes a sample organization and service principal descriptor. ```http GET https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz?api-version=7.1-preview.1 ``` -------------------------------- ### List Projects (Basic) Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/core/projects/list?view=azure-devops-rest-7.1 Use this endpoint to get all projects in the organization that the authenticated user has access to. No specific setup is required beyond authentication. ```HTTP GET https://dev.azure.com/{organization}/_apis/projects?api-version=7.1 ``` -------------------------------- ### Sample Request for Test Suite Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/testplan/test-suites/get?view=azure-devops-rest-7.1 Example of an HTTP GET request to retrieve a test suite, including the 'Children' expansion and API version. ```HTTP GET https://dev.azure.com/fabrikam/{project}/_apis/testplan/Plans/{planId}/suites/{suiteId}?expand=Children&api-version=7.1 ``` -------------------------------- ### Sample Request for Listing Policy Configurations Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/policy/configurations/list?view=azure-devops-rest-7.1 A concrete example of an HTTP GET request to list policy configurations for a specific Azure DevOps organization and project. This sample uses 'fabrikam' for both. ```http GET https://dev.azure.com/fabrikam/fabrikam-fiber-git/_apis/policy/configurations?api-version=7.1 ``` -------------------------------- ### Sample Manual Intervention Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/release/manual-interventions/get?view=azure-devops-rest-7.1 An example of a GET request to fetch a manual intervention, demonstrating the structure with sample values for organization, project, and IDs. ```http GET https://vsrm.dev.azure.com/fabrikam/A13d3daac-03b8-4a23-9cc4-2c3de65dab63/_apis/Release/releases/{releaseId}/manualinterventions/{manualInterventionId}?api-version=7.1 ``` -------------------------------- ### Sample Request: Get Repository by Remote URL Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/repositories/get-repository?view=azure-devops-rest-7.1 This is an example of an HTTP GET request to retrieve a repository using its remote URL. Replace '{repositoryId}' with the actual repository identifier. ```HTTP GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}?api-version=7.1 ``` -------------------------------- ### Sample Request - By Repository ID Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/import-requests/query?view=azure-devops-rest-7.1 An example of a GET request to retrieve import requests for a specific repository using its ID. ```HTTP GET https://dev.azure.com/fabrikam/Test/_apis/git/repositories/0eb02d2e-fff9-4990-bd45-2f7503f5aae5/importRequests?api-version=7.1 ``` -------------------------------- ### Get available board rows in a project (Sample Request) Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/work/boardrows/list?view=azure-devops-rest-7.1 Sample HTTP request for the Boardrows - List API. This example uses 'fabrikam' for both organization and project. ```http GET https://dev.azure.com/fabrikam/fabrikam/_apis/work/boardrows?api-version=7.1 ``` -------------------------------- ### Installed Extensions - Get by Name Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions/get?view=azure-devops-rest-7.1 Retrieves a specific installed extension by its publisher and extension name. This endpoint allows you to get details about an extension that is already installed in your Azure DevOps organization. ```APIDOC ## GET /_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName} ### Description Get an installed extension by its publisher and extension name. ### Method GET ### Endpoint https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName} ### Parameters #### Path Parameters - **organization** (string) - Required - The name of the Azure DevOps organization. - **publisherName** (string) - Required - Name of the publisher. Example: "fabrikam". - **extensionName** (string) - Required - Name of the extension. Example: "ops-tools". #### Query Parameters - **assetTypes** (string array) - Optional - Determines which files are returned in the files array. Provide the wildcard '*' to return all files, or a colon separated list to retrieve files with specific asset types. - **api-version** (string) - Required - Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api. ### Request Example ```http GET https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensionsbyname/ms/samples-contributions-guide?api-version=7.1-preview.1 ``` ### Response #### Success Response (200) - **InstalledExtension** (object) - successful operation #### Response Example ```json { "extensionId": "samples-contributions-guide", "extensionName": "Contributions Guide", "publisherId": "ms-samples", "publisherName": "Microsoft", "version": "0.1.35", "manifestVersion": 1, "baseUri": "https://ms-samples.gallerycdn.vsassets.io/extensions/ms-samples/samples-contributions-guide/0.1.35/1484832479380", "fallbackBaseUri": "https://ms-samples.gallery.vsassets.io/_apis/public/gallery/publisher/ms-samples/extension/samples-contributions-guide/0.1.35/assetbyname", "scopes": [], "installState": { "flags": "none", "lastUpdated": "2017-11-30T21:38:02.463Z" }, "contributionTypes": [], "lastPublished": "2017-01-19T13:28:00.85Z", "files": [] } ``` ### Security #### 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.extension_manage**: Grants the ability to install, uninstall, and perform other administrative actions on installed extensions. ``` -------------------------------- ### Sample Request for Listing Dashboards Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/dashboard/dashboards/list?view=azure-devops-rest-7.1 An example of an HTTP GET request to list dashboards. This sample uses 'fabrikam' as the organization and a placeholder for the project. ```http GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards?api-version=7.1-preview.3 ``` -------------------------------- ### Create Example Policy Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/policy/configurations/create?view=azure-devops-rest-7.1 This HTTP POST request configures an example policy, likely for enforcing specific code review requirements. It includes settings for required reviewers, filename patterns, and scope. ```http POST https://dev.azure.com/fabrikam/fabrikam-fiber-git/_apis/policy/configurations?api-version=7.1 { "isEnabled": true, "isBlocking": true, "type": { "id": "fd2167ab-b0be-447a-8ec8-39368250530e" }, "settings": { "requiredReviewerIds": [ "1d1dad71-f27c-4370-810d-838ec41efd41" ], "filenamePatterns": [ "*/API*.cs" ], "addedFilesOnly": false, "scope": [ { "repositoryId": null, "refName": "refs/heads/master", "matchKind": "exact" }, { "repositoryId": null, "refName": "refs/heads/releases/", "matchKind": "prefix" } ] } } ``` -------------------------------- ### Get a specific Shelveset with a comment length limit Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/tfvc/shelvesets/get?view=azure-devops-rest-7.1 This example demonstrates how to retrieve a specific shelveset while limiting the length of the comments included in the response. Replace 'My first shelveset' and the GUID with your actual shelveset name and ID. ```HTTP GET https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets?shelvesetId=My first shelveset;d6245f20-2af8-44f4-9451-8107cb2767db&api-version=7.1 ``` -------------------------------- ### Get Package Details (With Optional Parameters) Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/artifacts/artifact-details/get-package?view=azure-devops-rest-7.1 This endpoint allows retrieval of package details with optional parameters to filter the response. For example, includeAllVersions can be set to true to get all versions of the package. ```HTTP GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/Feeds/{feedId}/packages/{packageId}?includeAllVersions={includeAllVersions}&includeUrls={includeUrls}&isListed={isListed}&isRelease={isRelease}&includeDeleted={includeDeleted}&includeDescription={includeDescription}&api-version=7.1 ``` -------------------------------- ### Get Installed Extension Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions?view=azure-devops-rest-7.1 Retrieves details of a specific installed extension by its publisher and extension name. ```APIDOC ## GET /_apis/extensionManagement/installedextensions/{publisherName}/{extensionName} ### Description Gets an installed extension by its publisher and extension name. ### Method GET ### Endpoint /_apis/extensionManagement/installedextensions/{publisherName}/{extensionName} ### Parameters #### Path Parameters - **publisherName** (string) - Required - The name of the extension publisher. - **extensionName** (string) - Required - The name of the extension. ### Response #### Success Response (200) - **extensionId** (string) - The unique identifier for the extension. - **extensionName** (string) - The name of the extension. - **version** (string) - The version of the extension. - **publisher** (object) - Information about the extension publisher. - **publisherId** (string) - The unique identifier for the publisher. - **displayName** (string) - The display name of the publisher. - **installState** (string) - The current installation state of the extension. - **isSystemExtension** (boolean) - Indicates if the extension is a system extension. - **public** (boolean) - Indicates if the extension is publicly available. - **flags** (string) - Flags associated with the extension. - **scopes** (array) - The scopes the extension has access to. - **contributions** (array) - Contributions made by the extension. - **links** (object) - Links related to the extension. #### Response Example ```json { "extensionId": "example-publisher.example-extension", "extensionName": "ExampleExtension", "version": "1.0.0", "publisher": { "publisherId": "example-publisher", "displayName": "Example Publisher" }, "installState": "installed", "isSystemExtension": false, "public": true, "flags": "enabled", "scopes": ["vso.extension.data_write"], "contributions": [], "links": { "self": {"href": "..."} } } ``` ``` -------------------------------- ### Sample Request for Listing Test Cases Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/test/test-suites/list?view=azure-devops-rest-7.1 An example of an HTTP GET request to list test cases in a specific suite. This demonstrates the structure with actual values for organization, project, plan, and suite IDs. ```http GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/suites/1/testcases?api-version=7.1 ``` -------------------------------- ### GET /_apis/wit/queries/{query} - Example: Deleted query by ID Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/queries/get?view=azure-devops-rest-7.1 Example of how to retrieve a deleted query by its ID. ```APIDOC ## GET /_apis/wit/queries/{query} - Example: Deleted query by ID ### Request Example ```http GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$includeDeleted=true&api-version=7.1 ``` ``` -------------------------------- ### List Policy Configurations (With Optional Parameters) Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/policy/configurations/list?view=azure-devops-rest-7.1 This example demonstrates how to list policy configurations with optional query parameters for filtering and pagination. The 'scope' parameter is for legacy compatibility only. ```http GET https://dev.azure.com/{organization}/{project}/_apis/policy/configurations?scope={scope}&$top={$top}&continuationToken={continuationToken}&policyType={policyType}&api-version=7.1 ``` -------------------------------- ### Sample Request for Listing Subscriptions Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/list?view=azure-devops-rest-7.1 An example of an HTTP GET request to list subscriptions for the 'fabrikam' organization using API version 7.1. ```HTTP GET https://dev.azure.com/fabrikam/_apis/hooks/subscriptions?api-version=7.1 ``` -------------------------------- ### Sample Request to Create a Subscription Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/replace-subscription?view=azure-devops-rest-7.1 This sample demonstrates how to create a new subscription for build completion events. It specifies the publisher, event type, resource version, consumer, and input details for both the publisher and consumer. The consumer input includes a URL to receive webhook notifications. ```http PUT https://dev.azure.com/fabrikam/_apis/hooks/subscriptions?api-version=7.1 { "publisherId": "tfs", "eventType": "build.complete", "resourceVersion": "1.0-preview.1", "consumerId": "webHooks", "consumerActionId": "httpRequest", "publisherInputs": { "buildStatus": "Failed", "definitionName": "MyWebSite CI", "projectId": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c" }, "consumerInputs": { "url": "https://myservice/myhookeventreceiver" } } ``` -------------------------------- ### Sample Request to List Check Configurations Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/approvalsandchecks/check-configurations/list?view=azure-devops-rest-7.1 This sample demonstrates how to list check configurations for a specific resource type ('queue') and resource ID ('1'). ```HTTP GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations?resourceType=queue&resourceId=1&api-version=7.1-preview.1 ``` -------------------------------- ### Create Test Plan with All Details Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/testplan/test-plans/create?view=azure-devops-rest-7.1 Use this example to create a test plan with comprehensive details, including dates, owner, build information, and outcome settings. The owner field can be set to null if not specified. ```HTTP POST https://dev.azure.com/fabrikam/{project}/_apis/testplan/plans?api-version=7.1 { "name": "newCreatedPlan2", "areaPath": "sampleProject\Team1", "description": "description of the test plan", "startDate": "2018-08-19T20:49:15.8884886+05:30", "endDate": "2018-08-26T20:49:15.8884886+05:30", "iteration": "sampleProject\Iteration 2", "owner": null, "state": "Inactive", "buildId": 3, "buildDefinition": { "id": 2, "name": "" }, "releaseEnvironmentDefinition": { "definitionId": 1, "environmentDefinitionId": 1 }, "testOutcomeSettings": { "syncOutcomeAcrossSuites": true } } ``` -------------------------------- ### Get Classification Nodes by IDs Example Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/classification-nodes/get-classification-nodes?view=azure-devops-rest-7.1 This example demonstrates how to retrieve classification nodes by providing a comma-separated list of node IDs. ```http GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/classificationnodes?ids=1,3&api-version=7.1 ``` -------------------------------- ### Sample Request for Listing Pull Request Reviewers Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-reviewers/list?view=azure-devops-rest-7.1 An example of a GET request to list reviewers for a pull request. This sample uses specific IDs for demonstration. ```HTTP GET https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers?api-version=7.1 ``` -------------------------------- ### Sample Annotated Tag Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/annotated-tags/get?view=azure-devops-rest-7.1 An example of a GET request to retrieve an annotated tag, demonstrating the structure with specific placeholders. ```http GET https://dev.azure.com/fabrikam/c34d5807-1734-4541-ad1c-d16e9ac1faca/_apis/git/repositories/{repositoryId}/annotatedtags/{objectId}?api-version=7.1 ``` -------------------------------- ### Sample Request for Work Item Links Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/reporting-work-item-links/get?view=azure-devops-rest-7.1 An example HTTP GET request to the work item links API, demonstrating how to specify the organization and project. ```http GET https://dev.azure.com/fabrikam/_apis/wit/reporting/workitemlinks?api-version=7.1 ``` -------------------------------- ### Sample Response for Installed Extension Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed-extensions/get?view=azure-devops-rest-7.1 A successful (200 OK) response containing details of an installed extension, including its ID, name, version, and publishing information. ```JSON { "extensionId": "samples-contributions-guide", "extensionName": "Contributions Guide", "publisherId": "ms-samples", "publisherName": "Microsoft", "version": "0.1.35", "manifestVersion": 1, "baseUri": "https://ms-samples.gallerycdn.vsassets.io/extensions/ms-samples/samples-contributions-guide/0.1.35/1484832479380", "fallbackBaseUri": "https://ms-samples.gallery.vsassets.io/_apis/public/gallery/publisher/ms-samples/extension/samples-contributions-guide/0.1.35/assetbyname", "scopes": [], "installState": { "flags": "none", "lastUpdated": "2017-11-30T21:38:02.463Z" }, "contributionTypes": [], "lastPublished": "2017-01-19T13:28:00.85Z", "files": [] } ``` -------------------------------- ### Get Work Item Example Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/work-items/get-work-item?view=azure-devops-rest-7.1 This is a sample request demonstrating how to get a specific work item with ID 12 from the Fabrikam-Fiber-Git project. ```http GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/12?api-version=7.1 ``` -------------------------------- ### Sample request for Consumers - Get API Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/hooks/consumers/get?view=azure-devops-rest-7.1 An example of a GET request to retrieve consumer information for a specific organization and consumer ID. ```HTTP GET https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk?api-version=7.1 ``` -------------------------------- ### POST /api/policy/configurations (Example Policy) Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/policy/configurations/create?view=azure-devops-rest-7.1 Creates a new policy configuration for a repository, demonstrating the structure for an example policy with required reviewers and filename patterns. ```APIDOC ## POST /api/policy/configurations (Example Policy) ### Description Creates a new policy configuration for a repository, demonstrating the structure for an example policy with required reviewers and filename patterns. ### Method POST ### Endpoint https://dev.azure.com/{organization}/{project}/_apis/policy/configurations?api-version=7.1 ### Request Body - **isEnabled** (boolean) - Required - Whether the policy is enabled. - **isBlocking** (boolean) - Required - Whether the policy is blocking. - **type** (object) - Required - The type of policy. - **id** (string) - Required - The ID of the policy type. - **settings** (object) - Required - The settings for the policy. - **requiredReviewerIds** (array) - Required - List of reviewer IDs for required reviewer policies. - **filenamePatterns** (array) - Required - List of filename patterns for path-based policies. - **addedFilesOnly** (boolean) - Optional - Whether the policy applies only to added files. - **scope** (array) - Required - The scope to which the policy applies. - **repositoryId** (string) - Optional - The ID of the repository. - **refName** (string) - Required - The name of the branch reference. - **matchKind** (string) - Required - The kind of match (e.g., Exact, Prefix). ### Request Example ```json { "isEnabled": true, "isBlocking": true, "type": { "id": "fd2167ab-b0be-447a-8ec8-39368250530e" }, "settings": { "requiredReviewerIds": [ "1d1dad71-f27c-4370-810d-838ec41efd41" ], "filenamePatterns": [ "*/API*.cs" ], "addedFilesOnly": false, "scope": [ { "repositoryId": null, "refName": "refs/heads/master", "matchKind": "exact" }, { "repositoryId": null, "refName": "refs/heads/releases/", "matchKind": "prefix" } ] } } ``` ``` -------------------------------- ### Sample Request for Iterations Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/test/iterations/list?view=azure-devops-rest-7.1 An example HTTP GET request to retrieve test iterations. Replace placeholders with your specific organization, project, and result IDs. ```http GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/results/Results/{testCaseResultId}/iterations?api-version=7.1 ``` -------------------------------- ### Sample Request for Get Favorite By Id Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/favorite/favorites/get-favorite-by-id?view=azure-devops-rest-7.1 An example of a GET request to retrieve a favorite item, specifying artifact scope and type. ```HTTP GET https://dev.azure.com/{organization}/_apis/favorite/favorites/{favoriteId}?artifactScopeType=Project&artifactType=Microsoft.TeamFoundation.Build.Definition&artifactScopeId=ee27e18d-f04c-456d-af1e-d335a6ecff2e&api-version=7.1-preview.1 ``` -------------------------------- ### Sample Request - Include Abandoned Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/import-requests/query?view=azure-devops-rest-7.1 An example GET request to retrieve import requests, specifically including abandoned ones by setting the 'includeAbandoned' query parameter to 'true'. ```HTTP GET https://dev.azure.com/fabrikam/Test/_apis/git/repositories/0eb02d2e-fff9-4990-bd45-2f7503f5aae5/importRequests?includeAbandoned=true&api-version=7.1 ``` -------------------------------- ### Sample Request for Build Code Coverage Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/test/code-coverage/get-build-code-coverage?view=azure-devops-rest-7.1 Example of an HTTP GET request to fetch code coverage for build ID 363 with flags set to 7. ```http GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-TFVC/_apis/test/codecoverage?buildId=363&flags=7&api-version=7.1 ``` -------------------------------- ### Sample Request for Listing Test Sessions Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/test/session/list?view=azure-devops-rest-7.1 An example of a GET request to list test sessions for a specific Azure DevOps organization, project, and team. ```HTTP GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-TFVC/Fabrikam-Fiber-TFVC Team/_apis/test/session?api-version=7.1 ``` -------------------------------- ### Sample Request for Listing Test Configurations Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/testplan/configurations/list?view=azure-devops-rest-7.1 An example HTTP request to list test configurations. Replace '{project}' with your actual project name or ID. ```HTTP GET https://dev.azure.com/fabrikam/{project}/_apis/testplan/configurations?api-version=7.1 ``` -------------------------------- ### Sample User Entitlement GET Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user-entitlements/get?view=azure-devops-rest-7.1 An example of a GET request to retrieve a specific user's entitlement from the Azure DevOps API. ```http GET https://vsaex.dev.azure.com/fabrikam/_apis/userentitlements/fe2f1bdb-9779-491a-a6f6-c6e9322cfb00?api-version=7.1 ``` -------------------------------- ### Sample Request for Notification Subscription Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/notification/subscriptions/get?view=azure-devops-rest-7.1 An example of an HTTP GET request to retrieve a specific notification subscription. This demonstrates the expected URL format. ```HTTP GET https://dev.azure.com/fabrikam/_apis/notification/subscriptions/114711?api-version=7.1 ``` -------------------------------- ### Sample Request for Listing Statuses Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-iteration-statuses/list?view=azure-devops-rest-7.1 An example of an HTTP GET request to list pull request iteration statuses. Replace placeholders with your specific IDs. ```HTTP GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/statuses?api-version=7.1 ``` -------------------------------- ### List Repository Refs with Optional Parameters Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/refs/list?view=azure-devops-rest-7.1 This example demonstrates how to use optional parameters to filter and control the output when listing repository refs. Parameters like 'filter', 'includeLinks', and 'continuationToken' can refine the results. ```HTTP GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&includeLinks={includeLinks}&includeStatuses={includeStatuses}&includeMyBranches={includeMyBranches}&latestStatusesOnly={latestStatusesOnly}&peelTags={peelTags}&filterContains={filterContains}&$top={$top}&continuationToken={continuationToken}&api-version=7.1 ``` -------------------------------- ### Builds - Get Build Log Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/build/builds/get-build-log?view=azure-devops-rest-7.1 Retrieves an individual log file for a build. You can specify start and end lines to get a portion of the log. ```APIDOC ## GET /_apis/build/builds/{buildId}/logs/{logId} ### Description Gets an individual log file for a build. ### Method GET ### Endpoint https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/logs/{logId} ### Parameters #### Path Parameters - **organization** (string) - Required - The name of the Azure DevOps organization. - **project** (string) - Required - Project ID or project name. - **buildId** (integer) - Required - The ID of the build. - **logId** (integer) - Required - The ID of the log file. #### Query Parameters - **startLine** (integer) - Optional - The start line. - **endLine** (integer) - Optional - The end line. - **api-version** (string) - Required - Version of the API to use. This should be set to '7.1' to use this version of the api. ### Response #### Success Response (200) - (string) - successful operation Media Types: "application/zip", "application/json", "text/plain" #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Sample Export Process Template Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/processadmin/processes/export-process-template?view=azure-devops-rest-7.1 An example of a GET request to export a process template from the 'fabrikam' organization. Replace '{id}' with the actual process ID. ```http GET https://dev.azure.com/fabrikam/_apis/work/processadmin/processes/export/{id}?api-version=7.1 ``` -------------------------------- ### Sample Request to Get Test Case Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/test/test-suites/get?view=azure-devops-rest-7.1 This is an example of an HTTP GET request to retrieve a specific test case from a test suite in Azure DevOps. ```HTTP GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/suites/1/testcases/39?api-version=7.1 ``` -------------------------------- ### List Check Configurations (Basic) Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/approvalsandchecks/check-configurations/list?view=azure-devops-rest-7.1 Use this GET request to list all check configurations for a given project. Ensure you replace placeholders with your organization and project details. ```HTTP GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations?api-version=7.1-preview.1 ``` -------------------------------- ### Sample Request to Create Subscription Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/create?view=azure-devops-rest-7.1 This sample demonstrates how to construct the JSON request body to create a subscription. It specifies the publisher, event type, consumer, and relevant inputs for both. ```HTTP POST https://dev.azure.com/fabrikam/_apis/hooks/subscriptions?api-version=7.1 { "publisherId": "tfs", "eventType": "build.complete", "resourceVersion": "1.0-preview.1", "consumerId": "webHooks", "consumerActionId": "httpRequest", "publisherInputs": { "buildStatus": "Failed", "definitionName": "MyWebSite CI", "projectId": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c" }, "consumerInputs": { "url": "https://myservice/newreceiver" } } ``` -------------------------------- ### Sample Project Creation Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/core/projects/create?view=azure-devops-rest-7.1 This sample shows how to construct the JSON request body to create a new project named 'FabrikamTravel'. It includes the project name, description, and specifies capabilities like version control (Git) and a process template. ```http POST https://dev.azure.com/fabrikam/_apis/projects?api-version=7.1 { "name": "FabrikamTravel", "description": "Frabrikam travel app for Windows Phone", "capabilities": { "versioncontrol": { "sourceControlType": "Git" }, "processTemplate": { "templateTypeId": "6b724908-ef14-45cf-84f8-768b5384da45" } } } ``` -------------------------------- ### Sample request for a folder and its children Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/tfvc/items/list?view=azure-devops-rest-7.1 This sample shows how to retrieve a folder and its immediate children using the 'recursionLevel=OneLevel' parameter. ```http GET https://dev.azure.com/fabrikam/_apis/tfvc/items?scopePath=$/Fabrikam-Fiber-TFVC/AuthSample&recursionLevel=OneLevel&api-version=7.1 ``` -------------------------------- ### Sample Request for Deployment Group Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/distributedtask/deploymentgroups/get?view=azure-devops-rest-7.1 An example HTTP GET request to retrieve a deployment group. This sample uses 'fabrikam' as the organization and includes placeholders for project and deployment group ID. ```http GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=7.1 ``` -------------------------------- ### Sample Response for Listing All Suite Entries Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/testplan/test-suite-entry/list?view=azure-devops-rest-7.1 Example JSON response when retrieving all entries from a test suite, showing a count and a list of suite and test case entries. ```JSON { "count": 8, "value": [ { "suiteId": 2, "sequenceNumber": 0, "id": 7, "suiteEntryType": "suite" }, { "suiteId": 2, "sequenceNumber": 1, "id": 6, "suiteEntryType": "suite" }, { "suiteId": 2, "sequenceNumber": 2, "id": 4, "suiteEntryType": "suite" }, { "suiteId": 2, "sequenceNumber": 3, "id": 3, "suiteEntryType": "suite" }, { "suiteId": 2, "sequenceNumber": 4, "id": 8, "suiteEntryType": "testCase" }, { "suiteId": 2, "sequenceNumber": 5, "id": 9, "suiteEntryType": "testCase" }, { "suiteId": 2, "sequenceNumber": 6, "id": 10, "suiteEntryType": "testCase" }, { "suiteId": 2, "sequenceNumber": 7, "id": 11, "suiteEntryType": "testCase" } ] } ``` -------------------------------- ### Sample Get Blob API Request Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/git/blobs/get-blob?view=azure-devops-rest-7.1 An example of a GET request to retrieve a blob, demonstrating the structure with placeholder values for organization, repository, and SHA1. ```http GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/blobs/{sha1}?api-version=7.1 ``` -------------------------------- ### Sample Response: Paginated Deployment Targets Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/distributedtask/targets/list?view=azure-devops-rest-7.1 This response demonstrates paginated results for deployment targets. The `x-MS-ContinuationToken` header in the HTTP response should be used to retrieve subsequent pages of results. ```http x-MS-ContinuationToken: demoTarget2 ``` ```json { "count": 2, "value": [ { "tags": [ "web" ], "id": 5, "agent": { "_links": { "self": { "href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/5" }, "web": { "href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=5" } }, "maxParallelism": 1, "createdOn": "2018-02-19T09:19:41.053Z", "id": 5, "name": "demoTarget1", "version": "2.127.0", "osDescription": "Microsoft Windows 10.0.14393 ", "enabled": true, "status": "online" } }, { "tags": [ "db", "web" ], "id": 7, "agent": { "_links": { "self": { "href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/7" }, "web": { "href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=7" } }, "maxParallelism": 1, "createdOn": "2018-02-19T09:26:48.11Z", "id": 7, "name": "demoTarget11", "version": "2.127.0", "osDescription": "Microsoft Windows 10.0.14393 ", "enabled": true, "status": "offline" } } ] } ``` -------------------------------- ### Sample Request for Get Favorite By Owner Id Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/favorite/favorites/get-favorite-of-owner-by-id?view=azure-devops-rest-7.1 An example of a GET request to retrieve a favorite item, specifying owner and artifact scopes and types. ```HTTP GET https://dev.azure.com/{organization}/_apis/favorite/favorites/{favoriteId}?ownerScopeType=User&ownerScopeId=df1a0816-9fa8-6752-86bb-ddc55c149629&artifactScopeType=Project&artifactType=Microsoft.TeamFoundation.Build.Definition&artifactScopeId=ee27e18d-f04c-456d-af1e-d335a6ecff2e&api-version=7.1-preview.1 ``` -------------------------------- ### Sample Response for Listing All Deployment Groups Source: https://learn.microsoft.com/en-us/rest/api/azure/devops/distributedtask/deploymentgroups/list?view=azure-devops-rest-7.1 This JSON object shows a sample response when listing all deployment groups. It includes the total count and details for each deployment group found in the project. ```json { "count": 3, "value": [ { "machineCount": 0, "description": "This deployment group is created to demnostrate the client usage", "id": 11, "project": { "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c", "name": "DeploymentGroupRESTSample" }, "name": "MyDeploymentGroup1", "pool": { "id": 6, "scope": "86088ab1-30d8-4526-9663-3406752b8bc6", "name": "DeploymentGroupRESTSample-MyDeploymentGroup1", "isHosted": false, "poolType": "deployment", "size": 0 } }, { "machineCount": 0, "description": "This deployment group is created to demnostrate the client usage", "id": 12, "project": { "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c", "name": "DeploymentGroupRESTSample" }, "name": "MyDeploymentGroup10", "pool": { "id": 7, "scope": "86088ab1-30d8-4526-9663-3406752b8bc6", "name": "DeploymentGroupRESTSample-MyDeploymentGroup10", "isHosted": false, "poolType": "deployment", "size": 0 } }, { "machineCount": 0, "description": "This deployment group is created to demnostrate the client usage", "id": 13, "project": { "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c", "name": "DeploymentGroupRESTSample" }, "name": "MyDeploymentGroup11", "pool": { "id": 8, "scope": "86088ab1-30d8-4526-9663-3406752b8bc6", "name": "DeploymentGroupRESTSample-MyDeploymentGroup11", "isHosted": false, "poolType": "deployment", "size": 0 } } ] } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.