Work Item Type Categories - Get

Référence

Service:: Work Item Tracking

API Version:: 5.0

Obtenez une catégorie de type d’élément de travail spécifique par nom.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypecategories/{category}?api-version=5.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
category	path	True	string	Nom de la catégorie
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 5.0 » pour utiliser cette version de l’API.

Réponses

Nom	Type	Description
200 OK	WorkItemTypeCategory	opération réussie

Sécurité

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

Nom	Description
vso.work	Accorde la possibilité de lire des éléments de travail, des requêtes, des tableaux, des chemins d’accès de zone et d’itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité d’exécuter des requêtes, de rechercher des éléments de travail et de recevoir des notifications sur les événements d’élément de travail via des hooks de service.

Nom

Description

vso.work

Accorde la possibilité de lire des éléments de travail, des requêtes, des tableaux, des chemins d’accès de zone et d’itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité d’exécuter des requêtes, de rechercher des éléments de travail et de recevoir des notifications sur les événements d’élément de travail via des hooks de service.

Exemples

Get category by name

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypecategories/{category}?api-version=5.0

Sample Response

Status code:: 200

{
  "name": "Requirement Category",
  "referenceName": "Microsoft.RequirementCategory",
  "defaultWorkItemType": {
    "name": "Product Backlog Item",
    "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Product%20Backlog%20Item"
  },
  "workItemTypes": [
    {
      "name": "Product Backlog Item",
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Product%20Backlog%20Item"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.RequirementCategory"
}

Définitions

Nom	Description
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
WorkItemTypeCategory	Décrit une catégorie de type d’élément de travail.
WorkItemTypeReference	Référence à un type d’élément de travail.

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

WorkItemTypeCategory

Décrit une catégorie de type d’élément de travail.

Nom	Type	Description
_links	ReferenceLinks	Lier des références à des ressources REST associées.
defaultWorkItemType	WorkItemTypeReference	Obtient ou définit le type par défaut de l’élément de travail.
name	string	Nom de la catégorie.
referenceName	string	Nom de référence de la catégorie.
url	string
workItemTypes	WorkItemTypeReference[]	Types d’éléments de travail qui correspondent à la catégorie.

WorkItemTypeReference

Référence à un type d’élément de travail.

Nom	Type	Description
name	string	Nom du type d’élément de travail.
url	string

Partager via