Pola niestandardowe

Pola niestandardowe w portalu wymagań i systemów - dokumentacja API

Wprowadzenie

W portalu Requirements & Systems Portal pola niestandardowe stanowią potężny sposób na rozszerzenie funkcjonalności platformy, umożliwiając użytkownikom tworzenie dodatkowych pól powiązanych z wymaganiami i przebiegami testów. Pola te mogą przechowywać różne typy danych, takie jak daty, tekst i wybory. Niniejsza dokumentacja API przedstawia proces tworzenia, aktualizowania i zarządzania polami niestandardowymi i ich opcjami programistycznie.

Definicja pól niestandardowych

Pola niestandardowe w portalu wymagań i systemów można tworzyć za pomocą punktu końcowego /data/custom-field/ z następującą składnią:

CustomField{
  "projects": [uniqueItems: true integer],
  "target_content_type": liczba całkowita,
  "name": string
  "type": liczba całkowita
  "multi": boolean
}

• projects: Lista unikalnych identyfikatorów projektów, w których pole niestandardowe powinno być dostępne.

• target_content_type: Docelowy typ zawartości dla pola niestandardowego. Użyj 120 dla wymagań i 291 dla testów.

• name: Nazwa pola niestandardowego.

• type: Użyj 0 dla Tekstu, 1 dla Wyboru i 2 dla Daty.

• multi: Ustaw na true dla wielokrotnego wyboru podczas definiowania typu Selection.

Tworzenie pól niestandardowych

Aby utworzyć pole niestandardowe, należy użyć metody PUT dla punktu końcowego /data/custom-field/. Na przykład:

{
  "projects": [136],
  "target_content_type": 120,
  "name": "New Selection Column",
  "type": 1
}

Definicja opcji pola niestandardowego

Podczas tworzenia pól niestandardowych typu Selection należy również zdefiniować dostępne opcje za pomocą punktu końcowego /data/custom-field-options/ z następującym modelem:

CustomFieldOption{
  "custom_field": liczba całkowita,
  "titlename": string,
  "position": liczba
}

• custom_field: Unikalny identyfikator pola niestandardowego, dla którego tworzona jest opcja.

• titlename: Nazwa opcji.

• position: Opcjonalne pole określające pozycję opcji na liście opcji.

Tworzenie niestandardowych opcji pola

Aby utworzyć niestandardową opcję pola, należy użyć metody PUT dla punktu końcowego /data/custom-field-options/. Na przykład:

{
  "custom_field": 58,
  "name": "New Option"
}

Dodawanie danych do pól niestandardowych

Aby dodać dane do pola niestandardowego, należy użyć punktu końcowego /data/custom-field-row/ z następującym modelem:

CustomFieldRow{
  "referenced_object_id": liczba całkowita,
  "custom_field": liczba całkowita
  "value": string
}

• referenced_object_id: Unikalny identyfikator obiektu (wymagania lub przebiegu testowego), do którego należą dane.

• custom_field: Unikalny identyfikator pola niestandardowego, do którego dodawane są dane.

• value: Dane do dodania. W przypadku opcji Text należy użyć dowolnego ciągu tekstowego; w przypadku opcji Single Selection należy użyć identyfikatora opcji; w przypadku opcji Multiple Selection należy użyć listy identyfikatorów opcji; w przypadku opcji Date należy użyć daty w formacie ciągu znaków.

Dodawanie danych do pól niestandardowych - wprowadzanie po raz pierwszy

Aby po raz pierwszy wprowadzić dane do pola niestandardowego danego obiektu, należy użyć metody POST dla punktu końcowego /data/custom-field-row/bulk-create/. Na przykład:

{
  "referenced_object_id": 33803,
  "custom_field": 58,
  "value": 29
}

Aktualizacja danych w polach niestandardowych

Aby zaktualizować istniejące dane dla pola niestandardowego danego obiektu, należy użyć metody POST dla punktu końcowego /data/custom-field-row/bulk-update/. Na przykład:

{
  "614": {
    "value": 30
  }
}

Usuwanie danych z pól niestandardowych

Aby usunąć dane powiązane z danym polem niestandardowym i obiektem, należy użyć tej samej metody bulk-update z "value": null. Na przykład:

{
  "614": {
    "value": null
  }
}

Wnioski

Pola niestandardowe w Requirements & Systems Portal pozwalają rozszerzyć możliwości platformy i dostosować ją do konkretnych potrzeb projektu. Korzystając z udostępnionych punktów końcowych API, można tworzyć pola niestandardowe, definiować opcje i programowo dodawać dane, dzięki czemu Requirements & Systems Portal jest wszechstronnym narzędziem do zarządzania projektami i wymagań analitycznych.