API: Pobieranie danych

Dotyczy : TBM Studio v11.x, v12.0, v12.1, v12.2 i nowszych wersji

Za pomocą interfejsu API można pobierać surowe tabele, a także przekształcać tabele w zakładce „Dane”. Można również pobrać dane z tabel i wykresów zawartych w raportach. Dane można pobrać w formacie Excel (plik.xls lub.xlsx). W przypadku dużych plików można skorzystać z formatu TSV (.TSV).

Uwierzytelnianie

Więcej informacji można znaleźć pod linkiem społecznościowym „Uwierzytelnianie użytkowników za pomocą interfejsów API

Pobieranie adresów URL interfejsów API dla tabel

Przejdź do tabeli w TBM Studio. Wybierz kartę „Strona główna ”, kliknij opcję „Eksportuj” w menu rozwijanym, a następnie wybierz opcję „Pokaż API” URL.

pobieranie adresów URL interfejsów API

Pojawi się okno dialogowe, w którym można wybrać i skopiować odpowiedni plik „ URL ”:

pobieranie adresów URL interfejsów API

Pobieranie adresów URL interfejsów API dla elementów raportowania

Kliknij prawym przyciskiem myszy na dole tabeli, w dowolnym miejscu wykresu lub skorzystaj z menu rozwijanego w lewym górnym rogu elementów raportu (jeśli jest dostępne), a pojawi się menu kontekstowe, w którym możesz wybrać opcję „Pokaż API” URL :

pobieranie żądań API dla elementów raportu

pobieranie wyników API Curl dotyczących trendów elementów raportów

Pojawi się okno dialogowe, w którym można wybrać i skopiować odpowiedni plik „ URL ”:

okno dialogowe

Zmiana separatora

W niektórych przypadkach może zaistnieć potrzeba zmiany separatora. W tym celu można użyć argumentu „delimiter” w następujący sposób, podając wartość kodowania znaków w systemie szesnastkowym (aby sprawdzić kodowania znaków, zajrzyj na tę stronę Wikipedii ).

https://HOST/biit/api/v2/domains/DOMAIN/projects/PROJECT_NAME/tables/TABLE_NAME/dates/TIME_PERIOD.tsv?delimiter=ENCODED_CHARACTER

Na przykład, jeśli chcesz zmienić separator na znak pionowej kreski „|”, musisz najpierw uzyskać format TSV URL, jak pokazano wcześniej w tym dokumencie, a następnie określić separator jako “%7C”, co jest szesnastkowym kodowaniem znaku pionowej kreski, podobnym do poniższego:

https://customer.apptio.com/biit/api/v2/domains/customer.com/projects/Cost Przejrzystość/tabele/Test Table/dates/Jan:FY2020.tsv?delimiter=%7C

Czasami dane mogą zawierać znak rozdzielający, którego chcesz użyć. Weźmy na przykład następującą tabelę:

zmiana separatora

Chcesz jednak użyć znaku rury jako separatora. Należy zwrócić uwagę, że w trzecim wierszu wartości zawierają znaki rury. Aby poprawnie użyć znaku rury, należy zastąpić go innym znakiem w wartościach danych. W poniższym przykładzie znaki rury ( %7C ) zostaną zastąpione przecinkami ( %2C ):

https://customer.apptio.com/biit/api/v2/domains/customer.com/projects/Cost Przejrzystość/tabele/Test Table/dates/Jan:FY2020.tsv?delimiter=%7C&delimiterReplacement=%2C

Pobierany plik będzie wyglądał następująco:

ColumnA|ColumnB

ValueA1|ValueB1

ValueA2|ValueB2

ValueA,3|ValueB,3

Pobieranie za pośrednictwem API

Więcej informacji na temat korzystania z interfejsu API w celu zainicjowania pobierania znajdziesz w jednym z poniższych artykułów: