Templates - List

Ruft die Vorlage ab

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/templates?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/templates?workitemtypename={workitemtypename}&api-version=7.1-preview.1

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
path True

string

Der Name der Azure DevOps-Organisation.

project
path True

string

Projekt-ID oder Projektname

team
path True

string

Team-ID oder Teamname

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.

workitemtypename
query

string

Optional: Wenn angegeben gibt Vorlagen für den angegebenen Arbeitselementtyp zurück.

Antworten

Name Typ Beschreibung
200 OK

WorkItemTemplateReference[]

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.work Ermöglicht das Lesen von Arbeitselementen, Abfragen, Boards, Bereichs- und Iterationspfaden und anderen Metadaten zur Nachverfolgung von Arbeitselementen. Außerdem können Sie Abfragen ausführen, Arbeitselemente durchsuchen und Benachrichtigungen über Arbeitselementereignisse über Diensthaken empfangen.

Beispiele

Gets templates

Sample Request

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/templates?api-version=7.1-preview.1

Sample Response

{
  "count": 9,
  "value": [
    {
      "id": "5dbed2c3-1534-4894-aff4-0234fa3ae56d",
      "name": "Test Template",
      "description": "",
      "workItemTypeName": "Feature",
      "_links": {
        "workItemType": {
          "href": "https://dev.azure.com/fabrikamm0652/00487116-45c8-4be1-a19b-ae0de259e618/_apis/wit/workItemTypes/Feature"
        },
        "self": {
          "href": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/5dbed2c3-1534-4894-aff4-0234fa3ae56d"
        }
      },
      "url": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/5dbed2c3-1534-4894-aff4-0234fa3ae56d"
    },
    {
      "id": "2564ee23-9824-4cde-a42d-3036adaf50e7",
      "name": "Test Template",
      "description": "",
      "workItemTypeName": "Feature",
      "_links": {
        "workItemType": {
          "href": "https://dev.azure.com/fabrikamm0652/00487116-45c8-4be1-a19b-ae0de259e618/_apis/wit/workItemTypes/Feature"
        },
        "self": {
          "href": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/2564ee23-9824-4cde-a42d-3036adaf50e7"
        }
      },
      "url": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/2564ee23-9824-4cde-a42d-3036adaf50e7"
    },
    {
      "id": "05132b3a-41d6-430f-8738-42b20b34a601",
      "name": "Test Template",
      "description": "Template to be created",
      "workItemTypeName": "Feature",
      "_links": {
        "workItemType": {
          "href": "https://dev.azure.com/fabrikamm0652/00487116-45c8-4be1-a19b-ae0de259e618/_apis/wit/workItemTypes/Feature"
        },
        "self": {
          "href": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/05132b3a-41d6-430f-8738-42b20b34a601"
        }
      },
      "url": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/05132b3a-41d6-430f-8738-42b20b34a601"
    },
    {
      "id": "40ca92a6-0e32-4b44-8e57-664127faa0be",
      "name": "Test Template",
      "description": "",
      "workItemTypeName": "Feature",
      "_links": {
        "workItemType": {
          "href": "https://dev.azure.com/fabrikamm0652/00487116-45c8-4be1-a19b-ae0de259e618/_apis/wit/workItemTypes/Feature"
        },
        "self": {
          "href": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/40ca92a6-0e32-4b44-8e57-664127faa0be"
        }
      },
      "url": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/40ca92a6-0e32-4b44-8e57-664127faa0be"
    },
    {
      "id": "9363ac38-9e16-44b2-8a76-76480f366e2f",
      "name": "Test Template",
      "description": "Template to be created",
      "workItemTypeName": "Feature",
      "_links": {
        "workItemType": {
          "href": "https://dev.azure.com/fabrikamm0652/00487116-45c8-4be1-a19b-ae0de259e618/_apis/wit/workItemTypes/Feature"
        },
        "self": {
          "href": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/9363ac38-9e16-44b2-8a76-76480f366e2f"
        }
      },
      "url": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/9363ac38-9e16-44b2-8a76-76480f366e2f"
    },
    {
      "id": "2e703f7c-b028-4bf3-883d-7e641758a1f2",
      "name": "Test Template",
      "description": "",
      "workItemTypeName": "Feature",
      "_links": {
        "workItemType": {
          "href": "https://dev.azure.com/fabrikamm0652/00487116-45c8-4be1-a19b-ae0de259e618/_apis/wit/workItemTypes/Feature"
        },
        "self": {
          "href": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/2e703f7c-b028-4bf3-883d-7e641758a1f2"
        }
      },
      "url": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/2e703f7c-b028-4bf3-883d-7e641758a1f2"
    },
    {
      "id": "72608fee-226d-4c34-821a-82edeef99dbf",
      "name": "Test Template",
      "description": "",
      "workItemTypeName": "Feature",
      "_links": {
        "workItemType": {
          "href": "https://dev.azure.com/fabrikamm0652/00487116-45c8-4be1-a19b-ae0de259e618/_apis/wit/workItemTypes/Feature"
        },
        "self": {
          "href": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/72608fee-226d-4c34-821a-82edeef99dbf"
        }
      },
      "url": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/72608fee-226d-4c34-821a-82edeef99dbf"
    },
    {
      "id": "88c9ab05-74cc-45ff-a39d-a4400ff70796",
      "name": "Test Template",
      "description": "",
      "workItemTypeName": "Feature",
      "_links": {
        "workItemType": {
          "href": "https://dev.azure.com/fabrikamm0652/00487116-45c8-4be1-a19b-ae0de259e618/_apis/wit/workItemTypes/Feature"
        },
        "self": {
          "href": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/88c9ab05-74cc-45ff-a39d-a4400ff70796"
        }
      },
      "url": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/88c9ab05-74cc-45ff-a39d-a4400ff70796"
    },
    {
      "id": "d1e32bd5-98f6-4ad6-b035-e131aa1b4cdb",
      "name": "Test Template",
      "description": "",
      "workItemTypeName": "Feature",
      "_links": {
        "workItemType": {
          "href": "https://dev.azure.com/fabrikamm0652/00487116-45c8-4be1-a19b-ae0de259e618/_apis/wit/workItemTypes/Feature"
        },
        "self": {
          "href": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/d1e32bd5-98f6-4ad6-b035-e131aa1b4cdb"
        }
      },
      "url": "https://dev.azure.com/fabrikamm0652/Test%20Project/3481fbc6-b38e-4a68-ae98-53720872d5db/_apis/wit/templates/d1e32bd5-98f6-4ad6-b035-e131aa1b4cdb"
    }
  ]
}

Definitionen

Name Beschreibung
ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

WorkItemTemplateReference

Beschreibt einen flachen Verweis auf eine Arbeitselementvorlage.

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

WorkItemTemplateReference

Beschreibt einen flachen Verweis auf eine Arbeitselementvorlage.

Name Typ Beschreibung
_links

ReferenceLinks

Verknüpfen Sie Verweise auf verwandte REST-Ressourcen.

description

string

Die Beschreibung der Arbeitselementvorlage.

id

string

Der Bezeichner der Arbeitselementvorlage.

name

string

Der Name der Arbeitselementvorlage.

url

string

workItemTypeName

string

Der Name des Arbeitselementtyps.