Udostępnij za pośrednictwem

Śledzenie elementów roboczych

  • Artykuł

Zasoby śledzenia elementów roboczych

Pobieranie, tworzenie i aktualizacja usterek, zadań i innych elementów roboczych dla Twojego zespołu. Zapytania umożliwiają używanie pełnego zakresu języka zapytań o elementy robocze do wyszukiwania i filtrowania elementów roboczych. Języka zapytań o elementy robocze możesz użyć, aby pobrać każdy element roboczy, który spełnia warunki zapytania. Elementy robocze zachowują pełną historię i możesz uzyskać pełną wersję elementu roboczego lub tylko aktualizacji, które zostały wprowadzone w każdej wersji. Elementom roboczym można również przypisywać tagi.

Typowe zadania

Pobieranie elementów roboczych przy użyciu zapytania

  1. Wyszukaj zapytanie , którego chcesz użyć.
  2. Pobierz wyniki dla tego zapytania.
  3. Pobierz elementy robocze według identyfikatora.

Aktualizowanie elementów roboczych w partii

Użyj interfejsu API aktualizacji elementu roboczego usługi Batch , aby zaktualizować elementy robocze w partii.

Aktualizowanie pól elementu roboczego

  1. Pobierz identyfikator elementu roboczego , który chcesz zaktualizować.
  2. Zaktualizuj pola elementu roboczego.
  1. Pobierz identyfikator elementów roboczych , które chcesz połączyć.
  2. Dodaj łącze między elementami roboczymi.

Użyj polecenia create a work item (Tworzenie elementu roboczego ) i dodaj interfejsy API linku w wywołaniu wsadowym.

Dołączanie pliku do elementu roboczego

  1. Pobierz identyfikator elementu roboczego , który chcesz zaktualizować.
  2. Przekaż załącznik do magazynu załączników.
  3. Dodaj załącznik do elementu roboczego.

Tworzenie elementu roboczego

Utwórz element roboczy. Upewnij się, że podajesz co najmniej tytuł. Niektóre typy elementów roboczych będą wymagać wartości dla innych pól.

Pobieranie pełnej historii elementu roboczego

  1. Pobierz identyfikator elementu roboczego.
  2. Pobierz listę aktualizacji wprowadzonych do elementu roboczego.
  3. Pobierz cały element roboczy, który pojawił się w dowolnej wersji.

Usuwanie elementu roboczego

  1. Pobierz identyfikator elementu roboczego.
  2. Usuń element roboczy.

Pobieranie pól używanych w projekcie zespołowym

  1. Pobieranie typów elementów roboczych używanych w projekcie zespołowym.
  2. Pobierz każdy typ elementu roboczego , aby wyświetlić używane pola. (Pomiń obok elementu xmlform do fieldinstances).

Pobieranie kategorii elementów roboczych

Użyj kategorii elementów roboczych , aby uzyskać typy elementów roboczych używanych w projekcie zespołowym dla różnych funkcji. Aby na przykład wyświetlić elementy robocze wyświetlane na liście prac, pobierz kategorię wymagań.

Pobieranie obszarów i iteracji

Pobierz hierarchię obszarów lub hierarchię iteracji dla projektu zespołowego.

Pobieranie typów relacji elementów roboczych

Pobierz dostępne typy łączy elementów roboczych , które są dostępne w kolekcji projektów.

Zasoby metadanych elementu roboczego

Elementy robocze podlegają metadanym. Niektóre metadane są ograniczone do określonego projektu zespołowego, a inne metadane są ograniczone do kolekcji projektów (na przykład domyślnej kolekcji konta Azure DevOps Services).

Metadane o zakresie projektu

Projekt zespołowy zawiera zestaw typów elementów roboczych. Każdy typ elementu roboczego może należeć do kategorii , takiej jak "wymaganie" lub "usterka", aby zdefiniować jego rolę w projekcie. Węzły klasyfikacji definiują zestaw wartości, które mogą być używane w obszarze i polach iteracji dla elementów roboczych w projekcie zespołowym.

Metadane o zakresie kolekcji

Typy elementów roboczych współdzielą pola i typy relacji (linki i załączniki) z innymi typami elementów roboczych.

Interfejs API aktualizacji partii elementu roboczego

Wykonuje wiele żądań aktualizacji elementów roboczych. Odpowiedź zawiera poszczególne odpowiedzi dla każdego żądania w partii. Żądania, które zakończyły się niepowodzeniem, nie wpływają na kolejne żądania w partii.

SEMANTYKA INTERFEJSU API REST

PATCH https://dev.azure.com/{organization}/_apis/wit/$batch?api-version=6.1

Parametry identyfikatora URI

Nazwa W Wymagany Typ Opis
Organizacji Ścieżka True ciąg Nazwa organizacji usługi Azure DevOps.
api-version query ciąg Wersja interfejsu API do użycia.
bypassRules query boolean Nie wymuszaj reguł typów elementów roboczych w tej aktualizacji.
suppressNotifications query boolean Nie uruchamiaj żadnych powiadomień dotyczących tej zmiany.

Treść żądania

Treść żądania składa się z listy żądań aktualizacji elementów roboczych. Każdy element z tej listy będzie conatin wszystkie informacje o pojedynczym żądaniu aktualizacji, w tym metodę REST, ścieżkę, nagłówki i treść.

Aby uzyskać szczegółowe informacje na temat pojedynczego żądania, możesz zapoznać się z dokumentacją aktualizacji elementów roboczych .

Przykład aktualizacji usługi Batch

Żądanie

PATCH https://dev.azure.com/fabrikam/_apis/wit/$batch?api-version=6.1

Treść żądania

[
  {
    // Add priority and test rev on work item with id 1
    "method": "PATCH",
    "uri": "/_apis/wit/workitems/1?api-version=6.1",
    "headers": {
      "Content-Type": "application/json-patch+json"
    },
    "body": [
      {
        "op": "test",
        "path": "/rev",
        "value": 3
      },
      {
        "op": "add",
        "path": "/fields/Microsoft.VSTS.Common.Priority",
        "value": "1"
      }
    ]
  },
  {
    // Replace tags on work item with id 299x   
    "method": "PATCH",
    "uri": "/_apis/wit/workitems/299?api-version=6.1",
    "headers": {
      "Content-Type": "application/json-patch+json"
    },
    "body": [
      {
        "op": "replace",
        "path": "/fields/System.Tags",
        "value": "Tag1; Tag2"
      }
    ]
  },
  {
    // You can also use Work Item Create format
    "method": "PATCH",
    "uri": "/mytestprojectname/_apis/wit/workitems/$Bug?api-version=4.1",
    "headers": {
        "Content-Type": "application/json-patch+json"
    },
    "body": [
        {
            "op": "add",
            "path": "/id",
            "value": "-1"
        },
        {
            "op": "add",
            "path": "/fields/System.Title",
            "from": null,
            "value": "Sample 1"
        }
    ]
  },
]

Odpowiedź

Odpowiedź składa się z poszczególnych odpowiedzi dla każdego żądania aktualizacji wsadowej.

  • count : liczba zwróconych wsadowych odpowiedzi aktualizacji
  • value : lista obiektów odpowiedzi z kodem odpowiedzi, nagłówkami i treścią
{
  "count": 2,
  "value": [
    {
      "code": 200,
      "headers": {
        "Content-Type": "application/json; charset=utf-8"
      },
      "body": "{work item object}"
    },
    {
      "code": 200,
      "headers": {
        "Content-Type": "application/json; charset=utf-8"
      },
      "body": "{work item object}"
    }
  ]
}