QPP NextGen (wersja zapoznawcza)
Quark Publishing Platform (QPP) NextGen to oparty na chmurze system zarządzania zawartością składników (CCMS) umożliwiający automatyzację publikowania wysoce regulowanej zawartości przedsiębiorstwa. Łącznik QPP NextGen pomaga przenosić dane z ekosystemu zawartości w obu kierunkach, aby uprościć procesy i przyspieszyć czas obrotu.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Pomoc techniczna kwark |
| adres URL | https://quarksoftware.my.site.com |
| support_cases@quark.com |
| Metadane łącznika | |
|---|---|
| Publisher | Quark Software Inc. |
| Witryna internetowa | https://www.quark.com/ |
| Zasady ochrony prywatności | https://www.quark.com/privacy-policy |
| Kategorie | Zawartość i pliki; Produktywność |
Quark Publishing Platform (QPP) NextGen to oparty na chmurze system zarządzania zawartością składników (CCMS) umożliwiający automatyzację publikowania wysoce regulowanej zawartości przedsiębiorstwa. Łącznik QPP NextGen pomaga przenosić dane z ekosystemu zawartości w obu kierunkach, aby uprościć procesy i przyspieszyć czas obrotu.
Wymagania wstępne
- Do korzystania z naszego łącznika potrzebne jest środowisko QPP-NG (wersja 3.3 powyżej) i QPP-NG licencje.
- Musisz mieć istniejącego klienta (połączenie), najlepiej oddzielnego, utworzonego w dzierżawach, dla których mają być tworzone akcje i wyzwalacze tego łącznika. Więcej szczegółów można znaleźć w sekcji Uzyskiwanie poświadczeń.
- Dowiedz się, jak używać usługi Power Automate i uzyskiwać wartość przy użyciu zawartości dynamicznej lub z innej odpowiedzi akcji przy użyciu twórcy zapytań.
Jak uzyskać poświadczenia
Podczas tworzenia nowego połączenia z naszym łącznikiem zobaczysz 3 parametry. Szczegóły uzyskiwania poszczególnych z nich są udostępniane poniżej. Tworzenie i tworzenie nowego połączenia z naszym łącznikiem spowoduje, że użytkownicy zobaczą 3 parametry. Szczegóły uzyskiwania poszczególnych z nich są udostępniane poniżej. Tworzenie połączeń QPP-NG i zarządzanie nimi powinno odbywać się przez użytkownika administracyjnego. Skontaktuj się z administratorem środowisk QPP-NG.
Możesz również odpowiednio nazwać swoje poświadczenia, aby łatwo je zidentyfikować później. Przejdź do pozycji Połączenia w usłudze Power Automate, wyszukaj nazwę łącznika i edytuj istniejące połączenie, a następnie podaj odpowiednią nazwę.
- Identyfikator klienta: Możesz przejść do żądanej aplikacji administracyjnej QPP-NG dzierżawców, a następnie przejść do pozycji Połączenia ustawień>. W tym miejscu mogą utworzyć nowe połączenie lub użyć istniejącego. Wprowadź nazwę połączenia dla identyfikatora klienta.
- Klucz tajny klienta: Podobnie jak identyfikator klienta, przejdź do pozycji Połączenia i po prostu wprowadź wpis tajny dla istniejącego połączenia. Wygeneruj ponownie wpis tajny, jeśli go nie masz. Wpisy tajne powinny być przechowywane dla istniejących połączeń bezpiecznie zarządzanych przez administratora. Przed wygenerowaniem wpisu tajnego sprawdź z administratorem.
- Nazwa hosta: Nazwa hosta dzierżawy QPP-NG, którą chcesz utworzyć połączenia w celu interakcji z naszym łącznikiem. przykład (yourtenantname.app.quark.com). Powinien być widoczny adres URL, gdy uzyskujesz dostęp do środowiska QPP-NG.
Po utworzeniu poświadczeń można przetestować poświadczenia, aby sprawdzić, czy poświadczenia są poprawne.
Proste akcje, takie jak getUser, mogą być używane z naszego łącznika w przepływie ręcznym. Przetestuj przepływ przy użyciu pól domyślnych.
Podczas tworzenia połączenia po raz pierwszy niektóre kody błędów, które mogą wystąpić, są następujące:
- Nieprawidłowy adres URL hosta (500): Sprawdź ponownie nazwę hosta dla środowiska QPP-NG, identyfikator klienta i wpis tajny powinny należeć do tego połączenia.
- Brak autoryzacji/unauthorized_client (401): W przypadku nieprawidłowych poświadczeń klienta lub nieprawidłowych poświadczeń klienta upewnij się, że identyfikator klienta i klucz tajny klienta są prawidłowe i należą do używanej nazwy hosta.
Wprowadzenie do usługi QPP-NG Integration Hub
Aby rozpocząć, możesz nasłuchiwać wielu różnych zdarzeń typu zasób, kolekcje itp. z dzierżawy QPP-NG przy użyciu wbudowanego wyzwalacza.
- Utwórz nowy przepływ automatyzacji w usłudze Power Automate.
- Wybierz nasz łącznik QPP-NG, a następnie wybierz wyzwalacz.
- Wypełnij wymagane pola. Zapoznaj się z sekcją Webhook-trigger w dokumentacji narzędzia Readme usługi GitHub.
- Wybierz odpowiednie połączenie dla dzierżawy QPP-NG, w której chcesz zarejestrować element webhook. Możesz również utworzyć nowe połączenia. Postępuj zgodnie z instrukcjami podanymi w sekcji Jak uzyskać poświadczenia .
- Zapisz przepływ. Spowoduje to wykonanie żądania rejestracji z tyłu. Po powrocie do strony szczegółów przepływu (lub kliknięciu przycisku Wstecz) powinien zostać wyświetlony zielony podkreślenie u góry, że wszystko poszło dobrze, a przepływ jest gotowy do wyzwolenia.
- Po uruchomieniu przepływu można uzyskać dalszą odpowiedź elementu webhook na przebieg przepływu i użyć odpowiedzi w celu wygenerowania zawartości dynamicznej. W tym celu można użyć akcji analizy json OOTB.
- Jeśli jest to pierwszy element webhook z tym typem zmiany (zdarzenie) zarejestrowanym w dzierżawie QPP-NG, musisz poczekać 15 minut przed aktywowaniem elementu webhook, a następnie można oczekiwać, że przepływ zostanie wyzwolony.
Jeśli w module sprawdzania przepływu występują błędy z wyzwalaczem elementu webhook, usługa Power Automate będzie wyświetlana na czerwono w module sprawdzania przepływu. Otwórz go i sprawdź błąd. Poniżej przedstawiono niektóre błędy, które mogą wystąpić, oraz kroki ich ograniczenia.
- Element webhook o nazwie już istnieje Podaj unikatową nazwę elementu webhook lub użyj operacji Usuń element webhook z tym samym połączeniem w innym przepływie ręcznym. Wybierz element webhook o tej samej nazwie i usuń go. Więcej informacji na temat elementów webhook można znaleźć w portalu deweloperów kwark.
- Nieprawidłowe żądanie (400) Sprawdź parametry podane zgodnie z dokumentacją i szczegółami błędu.
- Nie znaleziono zasobu (404) i brak nagłówka lokalizacji w żądaniu subskrypcji Usuń przepływ, a następnie utwórz nowy wyzwalacz i przepływ elementu webhook. Jeśli przepływ jest duży, zduplikuj przepływ i podczas włączania przepływu i zapisywania go usługa Power Automate spróbuje wykonać nową rejestrację elementu webhook.
Znane problemy i ograniczenia
- Obecnie nie będzie można zaktualizować parametrów dla już zarejestrowanego wyzwalacza elementu webhook. Aby obejść ten problem, usuń bieżącą operację elementu webhook z przepływu i dodaj nowy wyzwalacz elementu webhook QPP-NG w jego miejscu. Aby usunąć wcześniej zarejestrowany element webhook ze środowiska QPP-NG, utwórz nowy przepływ ręczny z operacją usuwania, wybierz poprzedni element webhook z listy rozwijanej i uruchom przepływ. Jeśli to obejście nie zadziała, a przepływ jest duży, zduplikuj przepływ i po zaktualizowaniu szczegółów elementu webhook zapisz go i włącz. Spowoduje to również pomyślne utworzenie nowej rejestracji elementu webhook.
- Możesz również wyłączyć przepływ przed usunięciem i utworzeniem nowego wyzwalacza. Zapewni to również zarejestrowanie nowego elementu webhook.
- Jeśli usługa QPP-NG elementu webhook nie może wywołać zarejestrowanego wyzwalacza elementu webhook przez 3 razy, element webhook zostanie wyłączony.
- Zapisywanie niektórych akcji bez parametrów podanych (puste) powoduje błąd (oczekiwano pewnej wartości w treści).
- Jeśli jest to pierwszy element webhook z tym typem zmiany (zdarzenie), musisz poczekać 15 minut przed aktywowaniem elementu webhook, a następnie można oczekiwać, że przepływ zostanie wyzwolony.
- Użyj widoku starszego projektanta, aby uzyskać najlepsze środowisko, ponieważ mogą występować problemy z nowym projektantem z powodu trwającego programowania. Takie akcje z problemami z nowym projektantem to CheckOut, SetAttributeValues, InitNewCheckin & CreateQuery.
Typowe błędy i środki zaradcze
- Podczas rejestrowania wyzwalacza elementów webhook jako pierwszego kroku może wystąpić problem podczas rejestracji w naszej usłudze, jeśli szczegóły nie są poprawnie podane. Można to zawęzić po zapisaniu przepływu za pomocą wyzwalacza i powrocie do okna strony Szczegóły przepływu, w którym są wyświetlane przebiegi z ostatnich 28 dni. Jeśli zostanie wyświetlony kolor czerwony, oznacza to, że element webhook nie został poprawnie zarejestrowany. Sprawdź błąd. Jeśli wystąpi błąd z powodu braku nagłówka Lokalizacja lub nie znaleziono zasobu, spróbuj usunąć i utworzyć wyzwalacz ponownie.
- Jeśli przepływy nie są wyzwalane, może to być spowodowane istniejącym elementem webhook, który jest zarejestrowany jako punkt końcowy, który nie istnieje, taki jak usunięty przepływ itp. W takiej sytuacji uruchom interfejs API https://{Host.name}/webhooks/api/v3/registrations z tokenem interfejsu API, aby uzyskać listę wszystkich zarejestrowanych elementów webhook w środowisku QPP-NG i użyj tej odpowiedzi, aby usunąć wszystkie takie elementy webhook przy użyciu akcji usuwania elementów webhook. Należy również upewnić się, że usługa elementów webhook jest prawidłowo skonfigurowana i uruchomiona z poziomu obsługi aplikacji Quark przy użyciu (https://quarksoftware.my.site.com).
- Jeśli nie zostanie wyświetlony użytkownik uprzywilejowany lub jakikolwiek błąd uwierzytelniania, sprawdź, czy nazwa użytkownika podana dla personifikacji ma wystarczające uprawnienia w dzierżawie QPP-NG,
- W przypadku problemów specyficznych dla akcji zapoznaj się z przykładami i dokumentacją udostępnioną w repozytorium open source w witrynie GitHub w Readme.md pliku lub zapoznaj się z portalem deweloperów quark , aby uzyskać więcej informacji na temat punktów końcowych i funkcji.
Często zadawane pytania
Czy mogę używać akcji i wyzwalaczy z różnymi środowiskami QPP-NG?
Tak, jest to możliwe. Wystarczy podać parametr nazwy hosta zgodnie ze środowiskiem i użyć odpowiednich połączeń z tym środowiskiem.
Czy możesz nam pomóc, jeśli utkniemy w czymś lub masz wątpliwości?
Naturalnie. Wystarczy wysłać wiadomość e-mail [chronioną pocztą e-mail] (https://quarksoftware.my.site.com) i upewnić się, że podczas opisywania problemu wspomniano o łączniku usługi Microsoft Power Automate.
Gdzie można uzyskać więcej informacji na temat akcji i punktów końcowych?
Więcej informacji na temat różnych interfejsów API kwark można znaleźć tutaj. Wystarczy przejść do karty Platforma zawartości. Ponieważ ten łącznik zawiera tylko podzbiór rzeczywistego interfejsu API możliwego dla platformy QPP-NG, ta witryna może służyć do eksplorowania i żądania większej liczby akcji i punktów końcowych za pośrednictwem rejestrowania żądania funkcji pod adresem [email protected].
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: Wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja Power App zostanie udostępniona innemu użytkownikowi, inny użytkownik zostanie poproszony o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Identyfikator klienta (clientId) | ciąg | Określ identyfikator klienta z poświadczeń usługi. | Prawda |
| Klucz tajny klienta (clientSecret) | securestring | Określ klucz tajny klienta z poświadczeń usługi. | Prawda |
| Nazwa hosta | ciąg | Określ nazwę hosta | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie mapowania atrybutów dla typu zawartości |
Zaktualizuj mapowanie atrybutów typów zawartości i elementów podrzędnych przy użyciu określonej mapy atrybutów w treści żądania. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Czy użytkownik jest członkiem grupy |
To żądanie zwróci wartość true lub false, że użytkownik jest członkiem grupy specyficznej dla identyfikatora userId. |
| Inicjowanie zaewidencjonuj i zaktualizuj |
Żądanie zaewidencjonuje i zaktualizuje już istniejący zasób w QPPNG. Zasób musi zostać wyewidencjonowany przed przekazaniem. Użyj akcji wyewidencjonowania przed. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi github. |
| Kasa |
Oznacza zasób za pomocą podanego identyfikatora assetId jako wyewidencjonowany. Szczegółowe informacje można znaleźć w dokumentacji usługi GitHub. |
| Pobieranie (obiekt blob) |
To żądanie służy do pobierania pliku przez strumień wejściowy z adresu URL pobierania. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Pobieranie atrybutów według nazwy |
Zwraca wszystkie istniejące atrybuty z metadanymi na serwerze QPPNG dla określonych nazw. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Pobieranie członków grupy |
To żądanie zwróci listę użytkowników i wszystkie metadane specyficzne dla identyfikatora grupy. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Pobieranie grup dla kolekcji |
To żądanie zwraca tablicę odpowiednich grup routingów dla danej kolekcji dla określonego przepływu pracy i stanu. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi GitHub. |
| Pobieranie grupy według nazwy |
To żądanie zwróci grupę specyficzną dla nazwy grupy. |
| Pobieranie informacji o pobieraniu zasobów |
Żądanie zwróci informacje o pobieraniu elementów zawartości, których można użyć razem z akcją Pobierania obiektu blob w celu pobrania strumienia zasobów. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi GitHub. |
| Pobieranie informacji o typach zawartości według nazwy |
To żądanie służy do pobierania informacji o typie zawartości według nazwy typu zawartości. Aby uzyskać szczegółowe informacje, zobacz Github Docs. |
| Pobieranie metadanych elementów zawartości |
Pobierz dane zasobu dla danego identyfikatora zasobu. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi Github. |
| Pobieranie przepływu pracy według nazwy |
To żądanie zwraca wszystkie metadane określonego przepływu pracy według nazwy. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi Github. |
| Pobieranie relacji zasobów podrzędnych |
Pobierz relacje zasobów podrzędnych dla nadaj identyfikatorowi elementu zawartości nadrzędnej. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi Github. |
| Pobieranie użytkownika według identyfikatora |
To żądanie służy do pobierania metadanych określonego użytkownika. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Pobieranie użytkownika według nazwy |
To żądanie zwróci metadane użytkownika specyficzne dla nazwy użytkownika. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Pobieranie wartości atrybutów według nazwy |
Pobierz wartości atrybutów dla nazw rozdzielonych przecinkami. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Pobieranie wartości atrybutów z identyfikatorów |
Pobierz wartości atrybutów dla identyfikatorów rozdzielonych przecinkami. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi Github. |
| Pobieranie wszystkich użytkowników |
To żądanie służy do pobierania wszystkich użytkowników. Aby uzyskać szczegółowe informacje, zapoznaj się z dokumentacją usługi GitHub. |
| Pobieranie wszystkich zapytań |
To żądanie zwróci wszystkie zapytanie z definicją. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi Github. |
| Pobieranie wyników zapytania podzielonego na strony przy użyciu filtrów |
To żądanie zwraca element zapytania podzielonego na strony i szczegóły zapytania przechowywanego w systemie z określonym filtrem w zapytaniu. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi GitHub. |
| Przekazywanie (obiekt blob) |
To żądanie służy do przekazywania pliku przez strumień wejściowy. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Publikowanie zasobu asynchronicznego |
Zwraca identyfikator kontekstu dla publikowanego elementu zawartości. Użyj polecenia z pobieraniem stanu publikowania. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Tworzenie zapytania |
Utwórz zapytanie z definicją i szczegółami w treści żądania. Szczegółowe informacje można znaleźć w dokumentacji usługi GitHub. |
| Tworzy nowy atrybut |
Tworzy nowy atrybut i zwraca jego identyfikator wraz z komunikatem o powodzeniu. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Tworzy nowy atrybut Listy |
Tworzy nowy atrybut i zwraca jego identyfikator po pomyślnym utworzeniu komunikatu atrybutu. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi github. |
| Ustawianie wartości atrybutów |
Ustaw wartości atrybutów dla platformy QPP. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi Github. |
| Usuwa element webhook |
Usuwa już istniejący element webhook dla danego zdarzenia i typ zmiany. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi github. |
| Uzyskiwanie relacji zasobów nadrzędnych |
To żądanie zwróci listę relacji dla relacji elementu nadrzędnego elementu zawartości. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Uzyskiwanie stanu publikowania |
Pobierz stan publikowania dla danego zasobu. Szczegółowe informacje można znaleźć w dokumentacji usługi GitHub. |
| Uzyskiwanie tokenu zgodnie z typem dotacji |
To żądanie pobiera token dla danej nazwy użytkownika i hasła dla QPPNG. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
| Zainicjuj nowe zaewidencjonuj |
Żądanie zaewidencjonuje plik lokalny, zgodnie z daną tablicą wartości atrybutów Qpp, na przykład wymagane wartości atrybutów to nazwa, kolekcja, rozszerzenie itp., aby zaewidencjonować zasób do QPPNG. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi github. |
Aktualizowanie mapowania atrybutów dla typu zawartości
Zaktualizuj mapowanie atrybutów typów zawartości i elementów podrzędnych przy użyciu określonej mapy atrybutów w treści żądania. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator atrybutu
|
attributeId | True | integer |
Identyfikatory atrybutów, które należy zamapować. |
|
Identyfikatory typów zawartości
|
contentTypeIds | True | string |
Typy zawartości, do których należy zamapować te atrybuty. |
Czy użytkownik jest członkiem grupy
To żądanie zwróci wartość true lub false, że użytkownik jest członkiem grupy specyficznej dla identyfikatora userId.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator użytkownika QPPNG
|
userId | True | integer |
Identyfikator użytkownika QPPNG. |
|
Identyfikator grupy w QPPNG
|
groupId | True | integer |
Identyfikator grupy w QPPNG. |
Inicjowanie zaewidencjonuj i zaktualizuj
Żądanie zaewidencjonuje i zaktualizuje już istniejący zasób w QPPNG. Zasób musi zostać wyewidencjonowany przed przekazaniem. Użyj akcji wyewidencjonowania przed. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Tworzenie wersji pomocniczej
|
createMinorVersion | True | boolean |
Zmienna createMinorVersion powinna odwoływać się do wartości true lub false w celu utworzenia wersji do sprawdzenia. |
|
Identyfikator zasobu
|
assetId | integer |
Identyfikator zasobu do zaewidencjonowania. |
Zwraca
- Body
- AssetUploadInfo
Kasa
Oznacza zasób za pomocą podanego identyfikatora assetId jako wyewidencjonowany. Szczegółowe informacje można znaleźć w dokumentacji usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator zasobu
|
assetId | True | integer |
Zmienny assetId powinien odwoływać się do zasobu serwera QPP. |
|
Identyfikator atrybutu
|
attributeId | integer |
Identyfikator atrybutu. |
|
|
Typ
|
type | integer |
Typ atrybutu. |
|
|
Wartość
|
attributeValue | object |
Wartość. |
Zwraca
- Body
- Asset
Pobieranie (obiekt blob)
To żądanie służy do pobierania pliku przez strumień wejściowy z adresu URL pobierania. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Token uwierzytelniania
|
authTokenforHeader | True | string |
Token uwierzytelniania wymagany tutaj oddzielnie. Akcja TokenFromAuthWrapper może służyć tutaj do pobierania tokenu. |
|
Identyfikator pliku
|
fileIdentifier | True | string |
Identyfikator pliku odnosi się do typu pliku. |
|
Identyfikator kontekstu
|
contextId | True | string |
Identyfikator kontekstu odwołuje się do informacji o zasobie. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ zawartości
|
$content-type | string |
Typ zawartości dokumentu, np. application/pdf. |
|
Content
|
$content | byte |
Zawartość dokumentu w kodowaniu Base64. |
Pobieranie atrybutów według nazwy
Zwraca wszystkie istniejące atrybuty z metadanymi na serwerze QPPNG dla określonych nazw. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Nazwy atrybutów
|
attributeNames | True | string |
Nazwa atrybutu powinna odwoływać się do nazwy atrybutu serwera QPP (rozdzielone przecinkami, jeśli wiele). |
Zwraca
- response
- array of Attribute
Pobieranie członków grupy
To żądanie zwróci listę użytkowników i wszystkie metadane specyficzne dla identyfikatora grupy. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator grupy
|
groupId | True | integer |
Identyfikator grupy powinien odwoływać się do grupy QPPNG. |
Zwraca
- response
- array of User
Pobieranie grup dla kolekcji
To żądanie zwraca tablicę odpowiednich grup routingów dla danej kolekcji dla określonego przepływu pracy i stanu. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator kolekcji QPPNG
|
collectionId | True | integer |
Identyfikator kolekcji zmiennych powinien odwoływać się do identyfikatora kolekcji QPPNG. |
Zwraca
Pobieranie grupy według nazwy
To żądanie zwróci grupę specyficzną dla nazwy grupy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Nazwa grupy
|
groupName | True | string |
Nazwa grupy zmiennych powinna odwoływać się do nazwy grupy serwerów QPP. |
Zwraca
- Body
- Group
Pobieranie informacji o pobieraniu zasobów
Żądanie zwróci informacje o pobieraniu elementów zawartości, których można użyć razem z akcją Pobierania obiektu blob w celu pobrania strumienia zasobów. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator zasobu
|
assetId | True | integer |
AssetId powinien odwoływać się do zasobu serwera QPP. |
|
Wersja pomocnicza
|
minorVersion | integer |
Wersja pomocnicza powinna odwoływać się do wymaganej wersji pomocniczej zasobu. Podaj wartość 0, aby pobrać metadane najnowszej wersji. |
|
|
Wersja główna
|
majorVersion | integer |
Wersja główna powinna odwoływać się do wersji głównej wymaganego zasobu. Podaj wartość null, aby pobrać metadane najnowszej wersji. |
Zwraca
- Body
- AssetDownloadInfo
Pobieranie informacji o typach zawartości według nazwy
To żądanie służy do pobierania informacji o typie zawartości według nazwy typu zawartości. Aby uzyskać szczegółowe informacje, zobacz Github Docs.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Nazwa typu zawartości
|
contentTypeName | True | string |
Nazwa typu zawartości. |
Zwraca
- response
- array of ContentTypeInfo
Pobieranie metadanych elementów zawartości
Pobierz dane zasobu dla danego identyfikatora zasobu. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi Github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator zasobu
|
assetId | True | integer |
Identyfikator zasobu na platformie QPPNG wskazywany. |
Zwraca
- Body
- Asset
Pobieranie przepływu pracy według nazwy
To żądanie zwraca wszystkie metadane określonego przepływu pracy według nazwy. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi Github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Nazwa przepływu pracy
|
workflowName | True | string |
Nazwa przepływu pracy, dla którego należy pobrać metadane. |
Zwraca
Szczegóły przepływu pracy.
- Workflow
- Workflow
Pobieranie relacji zasobów podrzędnych
Pobierz relacje zasobów podrzędnych dla nadaj identyfikatorowi elementu zawartości nadrzędnej. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi Github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator elementu zawartości nadrzędnej
|
parentAssetId | True | integer |
Nadrzędny identyfikator zasobu powinien odwoływać się do nadrzędnego zasobu serwera QPP. |
Zwraca
- response
- array of AssetRelation
Pobieranie użytkownika według identyfikatora
To żądanie służy do pobierania metadanych określonego użytkownika. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator użytkownika QPPNG
|
userId | True | integer |
Identyfikator użytkownika QPPNG. |
Zwraca
- Body
- User
Pobieranie użytkownika według nazwy
To żądanie zwróci metadane użytkownika specyficzne dla nazwy użytkownika. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Nazwa użytkownika QPPNG
|
userName | True | string |
Odnosi się to do nazwy użytkownika QPPNG. |
Zwraca
- Body
- User
Pobieranie wartości atrybutów według nazwy
Pobierz wartości atrybutów dla nazw rozdzielonych przecinkami. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator zasobu
|
assetId | True | integer |
AssetId powinien odwoływać się do zasobu serwera QPP. |
|
Nazwy atrybutów
|
attributes | True | string |
Ciąg nazw atrybutów powinien odwoływać się do nazw atrybutów serwera QPPNG, rozdzielonych przecinkami, jeśli wiele. |
Zwraca
- response
- array of AttributeValue
Pobieranie wartości atrybutów z identyfikatorów
Pobierz wartości atrybutów dla identyfikatorów rozdzielonych przecinkami. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi Github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator zasobu
|
assetId | True | integer |
Identyfikator zasobu na platformie QPPNG wskazywany. |
|
Identyfikatory atrybutów QPPNG
|
attributeIds | True | string |
Identyfikatory atrybutów powinny odwoływać się do identyfikatorów atrybutów serwera QPP. |
Zwraca
- response
- array of AttributeValue
Pobieranie wszystkich użytkowników
To żądanie służy do pobierania wszystkich użytkowników. Aby uzyskać szczegółowe informacje, zapoznaj się z dokumentacją usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
Zwraca
Element odpowiedzi do wyświetlania listy użytkowników.
- Wyświetlanie listy użytkowników odpowiedzi
- ListResponseUser
Pobieranie wszystkich zapytań
To żądanie zwróci wszystkie zapytanie z definicją. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi Github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
Zwraca
- response
- array of QueryDefinition
Pobieranie wyników zapytania podzielonego na strony przy użyciu filtrów
To żądanie zwraca element zapytania podzielonego na strony i szczegóły zapytania przechowywanego w systemie z określonym filtrem w zapytaniu. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Istniejący identyfikator zapytania QPPNG
|
queryId | True | integer |
Odnosi się to do istniejącego identyfikatora zapytania QPPNG. |
|
Identyfikator zapytania
|
queryId | integer |
Unikatowy identyfikator zapytania. |
|
|
Nazwa zapytania
|
queryName | string |
Nazwa zapytania. |
|
|
Identyfikator właściciela
|
ownerId | integer |
Identyfikator właściciela zapytania. |
|
|
Sparametryzowana
|
parameterized | boolean |
Wskazuje, czy zapytanie jest sparametryzowane. |
|
|
Identyfikator kolumny
|
columnId | True | integer |
Identyfikator kolumny wyświetlania. |
|
Szerokość
|
width | True | integer |
Szerokość kolumny wyświetlania. |
|
Kolumna atrybutu
|
attributeColumn | True | boolean |
Wskazuje, czy kolumna jest kolumną atrybutu. |
|
Identyfikator kolumny
|
columnId | integer |
Identyfikator kolumny do sortowania. |
|
|
Malejąco
|
descending | boolean |
Wskazuje, czy sortowanie jest w kolejności malejącej. |
|
|
Kolumna atrybutu
|
attributeColumn | boolean |
Wskazuje, czy posortowana kolumna jest kolumną atrybutu. |
|
|
Tryb wyświetlania
|
displayMode | True | integer |
Ustawienie trybu wyświetlania. |
|
Identyfikator atrybutu
|
attributeId | integer |
Identyfikator atrybutu do grupowania. |
|
|
Malejąco
|
descending | boolean |
Wskazuje, czy grupowanie jest w kolejności malejącej. |
|
|
Tryb eksplorowania
|
exploreMode | integer |
Ustawienie trybu eksplorowania. |
|
|
Operator logiczny
|
logicalOperator | True | integer |
Operator logiczny warunku. |
|
Operator porównania
|
comparisonOperator | True | integer |
Operator porównania warunku. |
|
Zanegowane
|
negated | True | boolean |
Wskazuje, czy warunek jest negowany. |
|
Sparametryzowana
|
parameterized | True | boolean |
Wskazuje, czy warunek jest sparametryzowany. |
|
Typ
|
type | True | integer |
Typ warunku. |
|
Identyfikator atrybutu
|
attributeId | True | integer |
Identyfikator atrybutu wyszukiwania. |
|
Wartość do wyszukiwania względem
|
value | True | string |
wartość , aby wyszukać. |
|
Typ zawartości
|
contentType | integer |
Identyfikator typu zawartości kontekstu zapytania. |
|
|
Collections
|
collections | array of integer |
Lista identyfikatorów kolekcji dla kontekstu zapytania. |
|
|
Cykliczne
|
recursive | boolean |
Wskazuje, czy kontekst zapytania jest rekursywny. |
|
|
Uwzględnij wszystkie wersje
|
includeAllVersions | boolean |
Wskazuje, czy wszystkie wersje są uwzględnione w kontekście zapytania. |
|
|
Uwzględnij gałęzie
|
includeBranches | boolean |
Wskazuje, czy gałęzie są uwzględniane w kontekście zapytania. |
|
|
queryResults
|
queryResults |
Zwraca
Element odpowiedzi do wyświetlania listy wyników zapytania.
- List Response Query Result, element
- ListResponseQueryResultElement
Przekazywanie (obiekt blob)
To żądanie służy do przekazywania pliku przez strumień wejściowy. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator pliku
|
fileIdentifier | True | string |
Identyfikator pliku odnosi się do typu pliku. |
|
identyfikator kontekstu
|
contextId | True | string |
Identyfikator kontekstu odwołuje się do informacji o zasobie. |
|
Zasób strumienia wejściowego
|
InputStreamResource | True |
Strumień wejściowy dla zasobu wymaga danych binarnych. |
Publikowanie zasobu asynchronicznego
Zwraca identyfikator kontekstu dla publikowanego elementu zawartości. Użyj polecenia z pobieraniem stanu publikowania. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator zasobu
|
assetId | True | string |
Zmienny assetId powinien odwoływać się do zasobu serwera QPP. |
|
Identyfikator kanału publikowania
|
publishingChannelId | True | string |
variable channelId powinien odwoływać się do identyfikatora kanału, który ma być używany. |
Zwraca
Identyfikator kontekstu dla publikowanego elementu zawartości. Użyj polecenia z pobieraniem stanu publikowania, aby sprawdzić stan publikowania.
- Identyfikator kontekstu
- string
Tworzenie zapytania
Utwórz zapytanie z definicją i szczegółami w treści żądania. Szczegółowe informacje można znaleźć w dokumentacji usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Liczba atrybutów do pominięcia
|
_skiptoken | True | integer |
Liczba atrybutów do pominięcia z listy rozwijanej atrybutów. |
|
Nazwa zapytania
|
queryName | True | string |
Nazwa zapytania. |
|
Sparametryzowana
|
parameterized | boolean |
Wskazuje, czy zapytanie jest sparametryzowane. |
|
|
Identyfikator atrybutu
|
attributeId | integer |
Identyfikator atrybutu wyszukiwania. |
|
|
Typ atrybutu
|
type | integer |
Typ atrybutu wybranego dla warunku. |
|
|
Operator porównania
|
comparisonOperator | integer |
Operator porównania warunku. |
|
|
Zanegowane
|
negated | boolean |
Wskazuje, czy warunek jest negowany. |
|
|
Wartość do wyszukiwania względem
|
value | string |
wartość , aby wyszukać. |
|
|
Operator logiczny
|
logicalOperator | integer |
Operator logiczny i OR dla warunku. |
|
|
Identyfikator kolumny
|
columnId | True | integer |
Identyfikator kolumny wyświetlania. |
|
Szerokość
|
width | True | integer |
Szerokość kolumny wyświetlania. |
|
Kolumna atrybutu
|
attributeColumn | True | boolean |
Wskazuje, czy kolumna jest kolumną atrybutu. |
|
Tryb wyświetlania
|
displayMode | True | integer |
Ustawienie trybu wyświetlania. |
Zwraca
Nowo utworzony identyfikator zapytania.
- Nowo utworzony identyfikator zapytania
- integer
Tworzy nowy atrybut
Tworzy nowy atrybut i zwraca jego identyfikator wraz z komunikatem o powodzeniu. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Name
|
name | True | string |
Nazwa atrybutu. |
|
Typ atrybutu
|
valueType | True | integer |
Typ atrybutu. |
Zwraca
Szczegóły atrybutu skojarzonego z jednostką.
- Attribute
- CreateAttributeSchema
Tworzy nowy atrybut Listy
Tworzy nowy atrybut i zwraca jego identyfikator po pomyślnym utworzeniu komunikatu atrybutu. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Liczba domen do pokazania
|
_skiptoken | True | integer |
Liczba domen do pominięcia z listy rozwijanej Identyfikator domeny. |
|
Name
|
name | True | string |
Nazwa atrybutu. |
|
Typ atrybutu
|
valueType | True | integer |
Typ atrybutu powinien być listą typu listy. |
|
Wielowartościowe
|
multiValued | boolean |
Wskazuje, czy atrybut może przechowywać wiele wartości. |
|
|
Ograniczony dostęp
|
limitedAccess | boolean |
Dotyczy tylko typu listy (wskazuje, czy atrybut ma ograniczony dostęp do konfigurowania ról dla tego wcześniej). |
|
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny skojarzony z istniejącą listą źródło danych/domena. Użyj tokenu pomijania, aby przejść do 20 elementów na liście rozwijanej. |
Zwraca
Szczegóły atrybutu skojarzonego z jednostką.
- Attribute
- CreateAttributeSchema
Ustawianie wartości atrybutów
Ustaw wartości atrybutów dla platformy QPP. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi Github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator zasobu
|
assetId | True | string |
Identyfikator zasobu platformy QPP. |
|
Identyfikator atrybutu
|
attributeId | integer |
Identyfikator atrybutu. |
|
|
Typ
|
type | integer |
Typ atrybutu. |
|
|
Wielowartościowe
|
multiValued | boolean |
Wskazuje, czy atrybut jest wielowarty. |
|
|
Wartość
|
attributeValue | object |
Wartość. |
Usuwa element webhook
Usuwa już istniejący element webhook dla danego zdarzenia i typ zmiany. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Nazwa lub identyfikator
|
nameOrId | True | string |
Nazwa lub identyfikator istniejącego elementu webhook w środowisku. |
Zwraca
Uzyskiwanie relacji zasobów nadrzędnych
To żądanie zwróci listę relacji dla relacji elementu nadrzędnego elementu zawartości. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator zasobu podrzędnego
|
childAssetId | True | integer |
Zmienna childAssetId powinna odwoływać się do zasobu podrzędnego serwera QPP, który ma relację z elementem nadrzędnym i dla którego relacje nadrzędne muszą być dowiedzieć się. |
Zwraca
- response
- array of AssetRelation
Uzyskiwanie stanu publikowania
Pobierz stan publikowania dla danego zasobu. Szczegółowe informacje można znaleźć w dokumentacji usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Identyfikator kontekstu
|
contextId | True | string |
Identyfikator kontekstu |
Zwraca
- Body
- PublishingStatusInfo
Uzyskiwanie tokenu zgodnie z typem dotacji
To żądanie pobiera token dla danej nazwy użytkownika i hasła dla QPPNG. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa użytkownika
|
username | True | string |
Wprowadź nazwę użytkownika środowiska QPPNG, dla którego musisz uzyskać token. |
|
Hasło
|
password | True | string |
Wprowadź hasło dla nazwy użytkownika. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Token dostępu
|
access_token | string |
Token, który udziela dostępu do chronionych zasobów. |
|
Wygasa w
|
expires_in | integer |
Czas trwania (w sekundach), dla którego token dostępu jest prawidłowy. |
|
Odświeżanie wygasa
|
refresh_expires_in | integer |
Czas trwania (w sekundach), dla którego token odświeżania jest prawidłowy. |
|
Typ tokenu
|
token_type | string |
Typ tokenu (np. elementu nośnego). |
|
Nie przed zasadami
|
not-before-policy | integer |
Czas (w sekundach), przed którym nie można użyć tokenu. |
|
Scope
|
scope | string |
Zakres tokenu dostępu. |
Zainicjuj nowe zaewidencjonuj
Żądanie zaewidencjonuje plik lokalny, zgodnie z daną tablicą wartości atrybutów Qpp, na przykład wymagane wartości atrybutów to nazwa, kolekcja, rozszerzenie itp., aby zaewidencjonować zasób do QPPNG. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją usługi github.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Liczba atrybutów/domen do pominięcia
|
_skiptoken | True | integer |
Liczba atrybutów/domen do pominięcia. |
|
Tworzenie wersji pomocniczej
|
createMinorVersion | True | boolean |
Zmienna createMinorVersion powinna odwoływać się do wartości true lub false w celu utworzenia wersji do sprawdzenia. |
|
Identyfikator atrybutu
|
attributeId | integer |
Identyfikator atrybutu. |
|
|
Typ atrybutu
|
type | integer |
Typ atrybutu. |
|
|
Wielowartościowe
|
multiValued | boolean |
Wskazuje, czy atrybut jest wielowarty. |
|
|
Id
|
id | integer |
Identyfikator odpowiadający nazwie, na przykład dla kolekcji głównej o identyfikatorze 1, jest pobierany. |
|
|
Name
|
name | string |
Nazwa atrybutu, na przykład nazwa typu zawartości lub nazwa kolekcji. |
|
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny skojarzony z istniejącą listą źródło danych/domena. Jego identyfikator domeny. |
|
|
Wartość
|
value | string |
Wartość atrybutu do ustawienia. |
|
|
Identyfikator wartości domeny
|
id | integer |
Identyfikator wartości domeny, na przykład Identyfikator wartości domeny dla użytkownika będzie identyfikatorem użytkownika, ponieważ lista Użytkownicy jest domeną. |
Zwraca
- Body
- AssetUploadInfo
Wyzwalacze
| Wyzwala, gdy wystąpi zdarzenie dla już zarejestrowanego elementu webhook |
Rejestruje element webhook dla danego zdarzenia i typ zmiany. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub. |
Wyzwala, gdy wystąpi zdarzenie dla już zarejestrowanego elementu webhook
Rejestruje element webhook dla danego zdarzenia i typ zmiany. Aby uzyskać szczegółowe informacje, zobacz Dokumentację usługi GitHub.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Personifikacja użytkownika
|
user_name | True | string |
Nazwa użytkownika QPPNG, który musi być personifikowany. |
|
Nazwa elementu webhook
|
name | True | string |
Unikatowa nazwa opisujący przeznaczenie i znaczenie elementów webhook. |
|
Typ elementu webhook
|
type | True | string |
Opisz typ elementu webhook, który będzie nasłuchiwany, taki jak zdarzenie itp. |
|
Object
|
object | True | string |
Opisuje typ obiektu do nasłuchiwania takich jak zasób itp. |
|
Zmień typ
|
changeType | True | array of string | |
|
Kryteria filtrowania
|
filter | string |
Kryteria filtru można zdefiniować w celu filtrowania typu zdarzenia. |
|
|
Używana wersja
|
version | True | string |
Wersja używana jako usługa elementu webhook na platformie QPPNG. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Używana wersja
|
version | string |
Wersja używana jako usługa elementu webhook na platformie QPPNG. |
|
Typ elementu webhook
|
webhookInfo.type | string |
Opisz typ elementu webhook, który będzie nasłuchiwany, taki jak zdarzenie itp. |
|
Identyfikator elementu webhook
|
webhookInfo.id | string |
Identyfikator elementu webhook. |
|
Nazwa elementu webhook
|
webhookInfo.name | string |
Unikatowa nazwa opisujący przeznaczenie i znaczenie elementów webhook. |
|
AuxData
|
webhookInfo.auxData | string |
AuxData, jeśli został podany podczas rejestrowania. |
Definicje
PublishingOutputDownloadInfo
Definiuje informacje o pobieraniu danych wyjściowych publikowania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
attributesMap
|
attributesMap | object | |
|
Pobieranie bezpośrednie
|
directDownload | boolean |
Określa, czy pobieranie bezpośrednie jest dozwolone. |
|
Adres URL pobierania
|
downloadUrl | string |
Udostępnia adres URL pobierania, którego można użyć z akcją pobierania obiektu blob do pobrania z lokalizacji obiektu blob. |
Element webhookSuccessResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Definiuje identyfikator odpowiedzi powodzenia elementu webhook. |
|
Status
|
status | string |
Definiuje stan odpowiedzi dotyczącej powodzenia elementu webhook. |
|
Message
|
message | string |
Definiuje komunikat dotyczący odpowiedzi na powodzenie elementu webhook. |
|
wersja
|
version | string |
Definiuje wersję odpowiedzi dotyczącej powodzenia elementu webhook. |
AttributeValue
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator atrybutu
|
attributeId | integer |
Definiuje identyfikator atrybutu dla atrybutu QPPNG. |
|
Nazwa atrybutu
|
attributeName | string |
Definiuje nazwę atrybutu QPPNG. |
|
Typ
|
type | integer |
Definiuje typ atrybutu QPPNG. |
|
Wielowartościowe
|
multiValued | boolean |
Określa, czy atrybut jest wielowarty. |
|
Wartość
|
attributeValue | Value |
Wartość. |
AssetUploadInfo
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator kontekstu
|
contextId | string |
Definiuje identyfikator kontekstu przekazywania zasobu. |
|
Przekaż adres URL
|
uploadUrl | string |
Definiuje adres URL przekazywania elementu zawartości. |
Aktywa
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zasobu
|
assetId | integer |
Definiuje identyfikator zasobu dla elementu zawartości QPPNG. |
|
assetVersion
|
assetVersion | AssetVersion | |
|
attributeValues (Wartości atrybutów)
|
attributeValues | array of AttributeValue |
User
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator użytkownika. |
|
Name
|
name | string |
Nazwa użytkownika. |
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny użytkownika. |
|
Dokumentacja źródłowa
|
sourceReference | string |
Dokumentacja źródłowa użytkownika. |
|
Wartości domeny podrzędnej
|
childDomainValues | array of DomainValue |
Tablica wartości domeny podrzędnej. |
|
Ma elementy podrzędne
|
hasChildren | boolean |
Wskazuje, czy użytkownik ma elementy podrzędne. |
|
Jest usuwany
|
isDeleted | boolean |
Wskazuje, czy użytkownik zostanie usunięty. |
|
Czy użytkownik
|
user | boolean |
Wskazuje, czy jednostka jest użytkownikiem. |
|
Identyfikator profilu LDAP
|
ldapProfileId | integer |
Identyfikator profilu LDAP dla użytkownika. |
|
Domyślny identyfikator klasy użytkownika
|
defaultUserClassId | integer |
Domyślny identyfikator klasy użytkownika. |
|
Adres e-mail
|
emailAddress | string |
Adres e-mail użytkownika. |
|
Jest usuwany
|
deleted | boolean |
Wskazuje, czy użytkownik zostanie usunięty. |
|
Nazwa wyróżniająca LDAP
|
ldapDistinguishedName | string |
Nazwa wyróżniająca LDAP dla użytkownika. |
|
Natywne powiernik
|
nativeTrustee | boolean |
Wskazuje, czy użytkownik jest natywnym powiernikiem. |
|
Imię
|
firstName | string |
Imię użytkownika. |
|
Nazwisko
|
lastName | string |
Nazwisko użytkownika. |
|
Numer telefonu
|
phoneNumber | string |
Numer telefonu użytkownika. |
|
Jest włączona
|
enabled | boolean |
Wskazuje, czy użytkownik jest włączony. |
|
Uwierzytelnione zewnętrznie
|
externallyAuthenticated | boolean |
Wskazuje, czy użytkownik jest uwierzytelniany zewnętrznie. |
|
Nazwa uwierzytelniania
|
nameForAuthentication | string |
Nazwa uwierzytelniania. |
ListResponseCollectionGroup
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
get_count | integer |
Liczba elementów w odpowiedzi. |
|
Następny link
|
get_nextLink | string |
Adres URL następnego zestawu wyników. |
|
Wartość
|
get_value | array of CollectionGroup |
Tablica grup kolekcji. |
Wartość
Wartość.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
object |
Wartość. |
AssetVersion
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wersja główna
|
majorVersion | integer |
Wersja główna elementu zawartości. |
|
Wersja pomocnicza
|
minorVersion | integer |
Wersja pomocnicza elementu zawartości. |
|
Identyfikator gałęzi
|
branchId | integer |
Identyfikator wersji gałęzi. |
|
Nazwa systemu
|
systemName | string |
Nazwa systemu dla wersji elementu zawartości. |
DomainValue
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator wartości domeny. |
|
Name
|
name | string |
Nazwa wartości domeny. |
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny wartości domeny. |
|
Dokumentacja źródłowa
|
sourceReference | string |
Odwołanie źródłowe wartości domeny. |
|
Wartości domeny podrzędnej
|
childDomainValues | string |
Tablica wartości domeny podrzędnej. |
|
Ma elementy podrzędne
|
hasChildren | boolean |
Wskazuje, czy wartość domeny ma elementy podrzędne. |
|
Jest usuwany
|
isDeleted | boolean |
Wskazuje, czy wartość domeny została usunięta. |
KolekcjaGrupa
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator grupy
|
groupId | integer |
Identyfikator grupy kolekcji. |
|
groupInfo
|
groupInfo | GroupInfo | |
|
Zastąpiony identyfikator klasy użytkownika
|
overriddenUserClassId | integer |
Identyfikator zastąpionej klasy użytkownika. |
Informacje o grupie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator grupy. |
|
Name
|
name | string |
Nazwa grupy. |
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny grupy. |
|
Dokumentacja źródłowa
|
sourceReference | string |
Odwołanie źródłowe grupy. |
|
Wartości domeny podrzędnej
|
childDomainValues | array of DomainValue |
Tablica wartości domeny podrzędnej. |
|
Ma elementy podrzędne
|
hasChildren | boolean |
Wskazuje, czy grupa ma elementy podrzędne. |
|
Jest usuwany
|
isDeleted | boolean |
Wskazuje, czy grupa została usunięta. |
|
Czy użytkownik
|
user | boolean |
Wskazuje, czy grupa reprezentuje użytkownika. |
|
Identyfikator profilu LDAP
|
ldapProfileId | integer |
Identyfikator profilu LDAP. |
|
Domyślny identyfikator klasy użytkownika
|
defaultUserClassId | integer |
Identyfikator domyślnej klasy użytkownika. |
|
Adres e-mail
|
emailAddress | string |
Adres e-mail grupy. |
|
Usunięte
|
deleted | boolean |
Wskazuje, czy grupa została usunięta. |
|
Nazwa wyróżniająca LDAP
|
ldapDistinguishedName | string |
Nazwa wyróżniająca grupy LDAP. |
|
Natywne powiernik
|
nativeTrustee | boolean |
Wskazuje, czy grupa jest natywnym powiernikiem. |
AssetDownloadInfo
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator kontekstu
|
contextId | string |
Identyfikator kontekstu. |
|
Adres URL pobierania
|
downloadUrl | string |
Adres URL pobierania elementu zawartości. |
Workflow
Szczegóły przepływu pracy.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Unikatowy identyfikator przepływu pracy. |
|
Name
|
name | string |
Nazwa przepływu pracy. |
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny skojarzonej z przepływem pracy. |
|
Dokumentacja źródłowa
|
sourceReference | string |
Odwołanie skojarzone ze źródłem przepływu pracy. |
|
Wartości domeny podrzędnej
|
childDomainValues | array of DomainValue |
Lista podrzędnych wartości domeny skojarzonych z przepływem pracy. |
|
Ma elementy podrzędne
|
hasChildren | boolean |
Wskazuje, czy przepływ pracy ma elementy podrzędne. |
|
Jest usuwany
|
isDeleted | boolean |
Wskazuje, czy przepływ pracy został oznaczony jako usunięty. |
|
Statusy
|
statuses | array of Status |
Lista stanów w przepływie pracy. |
|
Stworzone przez
|
createdBy | integer |
Identyfikator użytkownika twórcy przepływu pracy. |
|
Data utworzenia
|
created | string |
Data utworzenia przepływu pracy. |
|
Ostatnia modyfikacja wykonana przez
|
lastModifiedBy | integer |
Identyfikator użytkownika ostatniej modyfikacji przepływu pracy. |
|
Data ostatniej modyfikacji
|
lastModified | string |
Data ostatniej modyfikacji przepływu pracy. |
|
Przejście stanu ograniczonego
|
constrainedStatusTransition | boolean |
Określa, czy przejście stanu jest ograniczone. |
|
Klasy użytkowników routingu stanu
|
statusRoutingUserclasses | array of StatusRoutingUserClasses |
Lista klas użytkowników routingu stanu. |
|
Przejścia stanu
|
statusTransitions | array of StatusTransition |
Lista przejść stanu. |
Status
Reprezentuje stan.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Unikatowy identyfikator stanu. |
|
Name
|
name | string |
Nazwa stanu. |
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny dla stanu. |
|
Dokumentacja źródłowa
|
sourceReference | string |
Odwołanie do źródła stanu. |
|
Wartości domeny podrzędnej
|
childDomainValues | array of DomainValue |
Tablica wartości domeny podrzędnej. |
|
Ma elementy podrzędne
|
hasChildren | boolean |
Wskazuje, czy stan ma stan podrzędny. |
|
Jest usuwany
|
isDeleted | boolean |
Wskazuje, czy stan został usunięty. |
|
Identyfikator przepływu pracy
|
workflowId | integer |
Identyfikator przepływu pracy skojarzonego ze stanem. |
|
Kolor czerwony
|
colorRed | integer |
Czerwony składnik koloru stanu. |
|
Kolor zielony
|
colorGreen | integer |
Zielony składnik koloru stanu. |
|
Kolor niebieski
|
colorBlue | integer |
Niebieski składnik koloru stanu. |
|
Position
|
position | integer |
Pozycja stanu. |
StatusRoutingUserClasses
Mapowanie stanu na klasy użytkowników na potrzeby routingu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator stanu
|
statusId | integer |
Identyfikator stanu routingu. |
|
Identyfikatory klas użytkowników routingu
|
routingUserClassIds | array of integer |
Tablica identyfikatorów klas użytkowników na potrzeby routingu. |
|
Routing oparty na klasach użytkowników
|
userClassBasedRouting | boolean |
Wskazuje, czy routing oparty na klasach użytkownika jest włączony. |
StatusTransition
Szczegóły przejścia stanu w przepływie pracy.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator stanu
|
statusId | integer |
Identyfikator przejścia stanu. |
|
Stan inicjowania przepływu pracy
|
workflowInitiatingStatus | boolean |
Wskazuje, czy przejście jest inicjowane przez przepływ pracy. |
|
Następne możliwe identyfikatory stanu
|
nextPossibleStatusIds | array of integer |
Identyfikatory kolejnych możliwych stanów po tym przejściu. |
ZasóbRelacja
Szczegóły relacji między elementami zawartości.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Unikatowy identyfikator relacji zasobu. |
|
Identyfikator elementu zawartości nadrzędnej
|
parentAssetId | integer |
Identyfikator elementu zawartości nadrzędnej w relacji. |
|
parentAssetVersion
|
parentAssetVersion | AssetVersion | |
|
Identyfikator zasobu podrzędnego
|
childAssetId | integer |
Identyfikator elementu zawartości podrzędnej w relacji. |
|
childAssetVersion
|
childAssetVersion | AssetVersion | |
|
Identyfikator typu relacji
|
relationTypeId | integer |
Identyfikator typu relacji. |
|
Stan relacji
|
relationState | integer |
Stan relacji. |
|
Zablokowane do wersji podrzędnej
|
lockedToChildVersion | boolean |
Flaga wskazująca, czy relacja jest zablokowana w wersji podrzędnej. |
|
Blokowanie do bieżącej wersji
|
freezeToCurrentVersion | boolean |
Flaga wskazująca, czy relacja jest zamrożona do bieżącej wersji. |
|
Atrybuty relacji
|
relationAttributes | array of AttributeValue |
Atrybuty skojarzone z relacją. |
Attribute
Szczegóły atrybutu skojarzonego z jednostką.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Unikatowy identyfikator atrybutu. |
|
Name
|
name | string |
Nazwa atrybutu. |
|
Typ wartości:
|
valueType | integer |
Typ wartości przechowywanej przez atrybut. |
|
Zdefiniowane przez użytkownika
|
userDefined | boolean |
Wskazuje, czy atrybut jest zdefiniowany przez użytkownika. |
|
Możliwość wykonywania zapytań
|
queryable | boolean |
Wskazuje, czy atrybut jest możliwy do wykonywania zapytań. |
|
Wielowartościowe
|
multiValued | boolean |
Wskazuje, czy atrybut może przechowywać wiele wartości. |
|
Poziom modyfikacji
|
modificationLevel | integer |
Poziom modyfikacji atrybutu. |
|
Data utworzenia
|
created | string |
Data utworzenia atrybutu. |
|
Data ostatniej modyfikacji
|
lastModified | string |
Data ostatniej modyfikacji atrybutu. |
|
Kreator
|
creator | integer |
Identyfikator użytkownika, który utworzył atrybut. |
|
Ostatni modyfikator
|
lastModifier | integer |
Identyfikator użytkownika, który ostatnio zmodyfikował atrybut. |
|
Wyświetlanej
|
displayable | boolean |
Wskazuje, czy atrybut jest wyświetlany. |
|
Ograniczony dostęp
|
limitedAccess | boolean |
Wskazuje, czy atrybut ma ograniczony dostęp. |
|
Ograniczony dostęp do zmian
|
limitedAccessChangeable | boolean |
Wskazuje, czy można zmienić ustawienie ograniczonego dostępu. |
|
Ograniczenia, które można zmienić
|
constraintsChangeable | boolean |
Wskazuje, czy można zmienić ograniczenia atrybutu. |
|
Preferencje wartości, które można zmienić
|
valuePreferencesChangeable | boolean |
Wskazuje, czy można zmienić preferencje wartości. |
|
Preferencje wartości logicznej
|
booleanValuePreferences | BooleanValuePreferences |
Preferencje dotyczące wartości logicznych. |
|
Preferencje wartości liczbowej
|
numericValuePreferences | NumericValuePreferences |
Preferencje dotyczące wartości liczbowych. |
|
Preferencje wartości daty
|
dateValuePreferences | DateValuePreferences |
Preferencje dotyczące wartości daty. |
|
Preferencje wartości daty/godziny
|
dateTimeValuePreferences | DateTimeValuePreferences |
Preferencje dotyczące wartości DateTime. |
|
Preferencje dotyczące wartości czasu
|
timeValuePreferences | TimeValuePreferences |
Preferencje dotyczące wartości czasu. |
|
Preferencje wartości miary
|
measurementValuePreferences | MeasurementValuePreferences |
Preferencje dotyczące wartości pomiarów. |
|
Preferencje wartości tekstowej
|
textValuePreferences | TextValuePreferences |
Preferencje dotyczące wartości tekstowych. |
|
Preferencje listy wartości domeny
|
domainValueListPreferences | DomainValueListPreferences |
Preferencje dotyczące list wartości domeny. |
|
Preferencje wartości domeny
|
domainValuePreferences | DomainValuePreferences |
Preferencje dotyczące wartości domeny. |
CreateAttributeSchema
Szczegóły atrybutu skojarzonego z jednostką.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Unikatowy identyfikator atrybutu. |
|
Name
|
name | string |
Nazwa atrybutu. |
|
Typ wartości:
|
valueType | integer |
Typ wartości, która zawiera atrybut 1 dla typu tekstu itp. |
|
Zdefiniowane przez użytkownika
|
userDefined | boolean |
Wskazuje, czy atrybut jest zdefiniowany przez użytkownika. |
|
Możliwość wykonywania zapytań
|
queryable | boolean |
Wskazuje, czy atrybut jest możliwy do wykonywania zapytań. |
|
Wielowartościowe
|
multiValued | boolean |
Wskazuje, czy atrybut może przechowywać wiele wartości. |
|
Poziom modyfikacji
|
modificationLevel | integer |
Poziom modyfikacji atrybutu. |
|
Data utworzenia
|
created | string |
Data utworzenia atrybutu. |
|
Data ostatniej modyfikacji
|
lastModified | string |
Data ostatniej modyfikacji atrybutu. |
|
Kreator
|
creator | integer |
Identyfikator użytkownika, który utworzył atrybut. |
|
Ostatni modyfikator
|
lastModifier | integer |
Identyfikator użytkownika, który ostatnio zmodyfikował atrybut. |
|
Wyświetlanej
|
displayable | boolean |
Wskazuje, czy atrybut jest wyświetlany. |
|
Ograniczony dostęp
|
limitedAccess | boolean |
Wskazuje, czy atrybut ma ograniczony dostęp. |
|
Ograniczony dostęp do zmian
|
limitedAccessChangeable | boolean |
Wskazuje, czy można zmienić ustawienie ograniczonego dostępu. |
|
Ograniczenia, które można zmienić
|
constraintsChangeable | boolean |
Wskazuje, czy można zmienić ograniczenia atrybutu. |
|
Preferencje wartości, które można zmienić
|
valuePreferencesChangeable | boolean |
Wskazuje, czy można zmienić preferencje wartości. |
|
Preferencje wartości logicznej
|
booleanValuePreferences | BooleanValuePreferences |
Preferencje dotyczące wartości logicznych. |
|
Preferencje wartości liczbowej
|
numericValuePreferences | NumericValuePreferences |
Preferencje dotyczące wartości liczbowych. |
|
Preferencje wartości daty
|
dateValuePreferences | DateValuePreferences |
Preferencje dotyczące wartości daty. |
|
Preferencje wartości daty/godziny
|
dateTimeValuePreferences | DateTimeValuePreferences |
Preferencje dotyczące wartości DateTime. |
|
Preferencje dotyczące wartości czasu
|
timeValuePreferences | TimeValuePreferences |
Preferencje dotyczące wartości czasu. |
|
Preferencje wartości miary
|
measurementValuePreferences | MeasurementValuePreferences |
Preferencje dotyczące wartości pomiarów. |
|
Preferencje wartości tekstowej
|
textValuePreferences | TextValuePreferences |
Preferencje dotyczące wartości tekstowych. |
|
Preferencje listy wartości domeny
|
domainValueListPreferences | DomainValueListPreferences |
Preferencje dotyczące list wartości domeny. |
|
Preferencje wartości domeny
|
domainValuePreferences | DomainValuePreferences |
Preferencje dotyczące wartości domeny. |
ContentTypeInfo
Szczegóły typu zawartości.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Unikatowy identyfikator typu zawartości. |
|
Name
|
name | string |
Nazwa typu zawartości. |
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny skojarzony z typem zawartości. |
|
Dokumentacja źródłowa
|
sourceReference | string |
Odwołanie do źródła typu zawartości. |
|
Wartości domeny podrzędnej
|
childDomainValues | array of DomainValue |
Lista podrzędnych wartości domeny skojarzonych z typem zawartości. |
|
Ma elementy podrzędne
|
hasChildren | boolean |
Wskazuje, czy typ zawartości ma elementy podrzędne. |
|
Jest usuwany
|
isDeleted | boolean |
Wskazuje, czy typ zawartości został usunięty. |
|
Zdefiniowane przez system
|
systemDefined | boolean |
Wskazuje, czy typ zawartości jest zdefiniowany przez system. |
|
Dostępne elementy podrzędne
|
childrenAvailable | boolean |
Wskazuje, czy elementy podrzędne są dostępne dla typu zawartości. |
|
Extensible
|
extensible | boolean |
Wskazuje, czy typ zawartości jest rozszerzalny. |
Wartość logicznaValuePreferences
Preferencje dotyczące wartości logicznych.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość logiczna
|
defaultValue | BooleanValue |
Wartość logiczna. |
Wartość logiczna
Wartość logiczna.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | boolean |
Wartość logiczna. |
NumericValuePreferences
Preferencje dotyczące wartości liczbowych.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość liczbowa
|
minimumPossibleValue | NumericValue |
Wartość liczbowa. |
|
Wartość liczbowa
|
maximumPossibleValue | NumericValue |
Wartość liczbowa. |
|
Wartość liczbowa
|
defaultValue | NumericValue |
Wartość liczbowa. |
Wartość liczbowa
Wartość liczbowa.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | integer |
Wartość liczbowa. |
DateValue
Wartość daty.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | string |
Wartość daty. |
DateValuePreferences
Preferencje dotyczące wartości daty.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość daty
|
minimumPossibleValue | DateValue |
Wartość daty. |
|
Wartość daty
|
maximumPossibleValue | DateValue |
Wartość daty. |
|
Wartość daty
|
defaultValue | DateValue |
Wartość daty. |
DateTimeValue
Wartość daty/godziny.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | string |
Wartość DateTime. |
DateTimeValuePreferences
Preferencje dotyczące wartości DateTime.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość daty/godziny
|
minimumPossibleValue | DateTimeValue |
Wartość daty/godziny. |
|
Wartość daty/godziny
|
maximumPossibleValue | DateTimeValue |
Wartość daty/godziny. |
|
Wartość daty/godziny
|
defaultValue | DateTimeValue |
Wartość daty/godziny. |
TimeValue
Wartość godziny.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | string |
Wartość godziny. |
TimeValuePreferences
Preferencje dotyczące wartości czasu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość godziny
|
minimumPossibleValue | TimeValue |
Wartość godziny. |
|
Wartość godziny
|
maximumPossibleValue | TimeValue |
Wartość godziny. |
|
Wartość godziny
|
defaultValue | TimeValue |
Wartość godziny. |
MeasurementValue
Wartość miary.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | double |
Wartość miary. |
MiaraValuePreferences
Preferencje dotyczące wartości pomiarów.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Jednostka miary
|
measurementUnit | integer |
Jednostka miary. |
|
Zmienialna jest tylko jednostka miary
|
onlyMeasurementUnitChangeable | boolean |
Wskazuje, czy można zmienić tylko jednostkę miary. |
|
Wartość miary
|
minimumPossibleValue | MeasurementValue |
Wartość miary. |
|
Wartość miary
|
maximumPossibleValue | MeasurementValue |
Wartość miary. |
|
Wartość miary
|
defaultValue | MeasurementValue |
Wartość miary. |
TextValue
Wartość tekstowa
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
value | string |
Wartość tekstowa. |
TextValuePreferences
Preferencje dotyczące wartości tekstowych.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość tekstowa
|
defaultValue | TextValue |
Wartość tekstowa |
|
Maksymalna możliwa długość
|
maxLengthPossible | integer |
Maksymalna możliwa długość wartości tekstowej. |
|
Wyszukiwanie tekstu włączone
|
textSearchEnabled | boolean |
Wskazuje, czy wyszukiwanie tekstu jest włączone. |
DomainValueList
Lista wartości domeny.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartości domeny
|
domainValues | array of DomainValue |
Lista wartości domeny. |
DomainValueListPreferences
Preferencje dotyczące list wartości domeny.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Lista wartości domeny
|
defaultValue | DomainValueList |
Lista wartości domeny. |
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny skojarzony z listą wartości domeny. |
DomainValuePreferences
Preferencje dotyczące wartości domeny.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
defaultValue (wartość domyślna)
|
defaultValue | DomainValue | |
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny skojarzony z wartością domeny. |
ZapytanieDefinition
Definicja zapytania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zapytania
|
queryId | integer |
Unikatowy identyfikator zapytania. |
|
Nazwa zapytania
|
queryName | string |
Nazwa zapytania. |
|
Identyfikator właściciela
|
ownerId | integer |
Identyfikator właściciela zapytania. |
|
Sparametryzowana
|
parameterized | boolean |
Wskazuje, czy zapytanie jest sparametryzowane. |
|
Wyświetlanie zapytania
|
queryDisplay | QueryDisplay |
Wyświetlanie ustawień zapytania. |
|
Warunki zapytania
|
queryConditions | array of QueryCondition |
Lista warunków kwerendy. |
|
Kontekst zapytania
|
queryContext | QueryContext |
Ustawienia kontekstu zapytania. |
|
queryResults
|
queryResults |
QueryDisplay
Wyświetlanie ustawień zapytania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wyświetlanie kolumn
|
displayColumns | array of DisplayColumn |
Lista wyświetlanych kolumn. |
|
Sortowanie
|
sorting | array of SortInfo |
Lista ustawień sortowania. |
|
Tryb wyświetlania
|
displayMode | integer |
Ustawienie trybu wyświetlania. |
|
Atrybuty grupowania
|
groupingAttributes | array of GroupingInfo |
Lista atrybutów grupowania. |
|
Tryb eksplorowania
|
exploreMode | integer |
Ustawienie trybu eksplorowania. |
ZapytanieCondition
Warunek zapytania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Operator logiczny
|
logicalOperator | integer |
Operator logiczny warunku. |
|
Operator porównania
|
comparisonOperator | integer |
Operator porównania warunku. |
|
Zanegowane
|
negated | boolean |
Wskazuje, czy warunek jest negowany. |
|
Sparametryzowana
|
parameterized | boolean |
Wskazuje, czy warunek jest sparametryzowany. |
|
Typ
|
type | integer |
Typ warunku. |
|
Identyfikator atrybutu
|
attributeId | integer |
Identyfikator atrybutu wyszukiwania. |
|
Wartość do wyszukiwania względem
|
value | string |
wartość , aby wyszukać. |
ZapytanieKontekst
Ustawienia kontekstu zapytania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ zawartości
|
contentType | integer |
Identyfikator typu zawartości kontekstu zapytania. |
|
Collections
|
collections | array of integer |
Lista identyfikatorów kolekcji dla kontekstu zapytania. |
|
Cykliczne
|
recursive | boolean |
Wskazuje, czy kontekst zapytania jest rekursywny. |
|
Uwzględnij wszystkie wersje
|
includeAllVersions | boolean |
Wskazuje, czy wszystkie wersje są uwzględnione w kontekście zapytania. |
|
Uwzględnij gałęzie
|
includeBranches | boolean |
Wskazuje, czy gałęzie są uwzględniane w kontekście zapytania. |
Kolumna wyświetlania
Kolumna do wyświetlenia w zapytaniu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator kolumny
|
columnId | integer |
Identyfikator kolumny wyświetlania. |
|
Szerokość
|
width | integer |
Szerokość kolumny wyświetlania. |
|
Kolumna atrybutu
|
attributeColumn | boolean |
Wskazuje, czy kolumna jest kolumną atrybutu. |
Informacje o sortowaniu
Sortowanie ustawień zapytania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator kolumny
|
columnId | integer |
Identyfikator kolumny do sortowania. |
|
Malejąco
|
descending | boolean |
Wskazuje, czy sortowanie jest w kolejności malejącej. |
|
Kolumna atrybutu
|
attributeColumn | boolean |
Wskazuje, czy posortowana kolumna jest kolumną atrybutu. |
GroupingInfo
Ustawienia grupowania dla zapytania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator atrybutu
|
attributeId | integer |
Identyfikator atrybutu do grupowania. |
|
Malejąco
|
descending | boolean |
Wskazuje, czy grupowanie jest w kolejności malejącej. |
ListResponseQueryResultElement
Element odpowiedzi do wyświetlania listy wyników zapytania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
get_count | integer |
Liczba wyników w odpowiedzi listy. |
|
Następny link
|
get_nextLink | string |
Link do następnej strony z wynikami. |
|
Wartość
|
get_value | array of QueryResultElement |
Tablica elementów wyników zapytania. |
QueryResultElement
Element w wyniku zapytania.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Unikatowy identyfikator elementu. |
|
Dostępne podrzędne
|
childAvailable | boolean |
Wskazuje, czy są dostępne elementy podrzędne. |
|
Typ elementu
|
elementType | integer |
Typ elementu. |
ListResponseUser
Element odpowiedzi do wyświetlania listy użytkowników.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
get_count | integer |
Liczba użytkowników w odpowiedzi na listę. |
|
Następny link
|
get_nextLink | string |
Link do następnej strony z wynikami. |
|
Wartość
|
get_value | array of User |
Tablica elementów użytkownika. |
PublishingStatusInfo
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
PublikowanieFailedException
|
publishingFailedException | PublishingFailedException |
Wyjątek zgłaszany podczas publikowania kończy się niepowodzeniem |
|
publishingOutputDownloadInfo
|
publishingOutputDownloadInfo | array of PublishingOutputDownloadInfo | |
|
Stan publikowania
|
publishingStatus | string |
Stan publikowania elementu zawartości, Możliwe wartości zwracane są PUBLISHING_IN_PROGESS, PUBLISHING_FAILED, PUBLISHING_COMPLETED |
PublikowanieFailedException
Wyjątek zgłaszany podczas publikowania kończy się niepowodzeniem
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dodatkowe informacje
|
additionalInfo | array of string |
Dodatkowe informacje związane z wyjątkiem |
|
Możliwość zgłaszania
|
cause | Throwable |
Klasa bazowa dla wyjątków i błędów |
|
Kod wyjątku
|
exceptionCode | string |
Kod skojarzony z wyjątkiem |
|
Zlokalizowany komunikat
|
localizedMessage | string |
Zlokalizowany komunikat opisujący wyjątek |
|
Message
|
message | string |
Komunikat opisujący wyjątek |
|
stackTrace
|
stackTrace | array of StackTraceElement | |
|
Pomijane
|
suppressed | array of Throwable |
Możliwość zgłaszania
Klasa bazowa dla wyjątków i błędów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przyczyna
|
cause | string |
Przyczyna zgłaszania |
|
Zlokalizowany komunikat
|
localizedMessage | string |
Zlokalizowany komunikat opisujący zgłaszany komunikat |
|
Message
|
message | string |
Komunikat opisujący zgłaszany komunikat |
|
stackTrace
|
stackTrace | array of StackTraceElement | |
|
Pomijane
|
suppressed | array of string |
Inne rzuty pomijane przez ten zgłaszany |
StackTraceElement
Element reprezentujący pojedynczą ramkę stosu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa klasy
|
className | string |
Nazwa klasy zawierającej punkt wykonywania |
|
Nazwa pliku
|
fileName | string |
Nazwa pliku zawierającego punkt wykonywania |
|
Numer wiersza
|
lineNumber | integer |
Numer wiersza w pliku zawierającym punkt wykonywania |
|
Nazwa metody
|
methodName | string |
Nazwa metody zawierającej punkt wykonywania |
|
Native, metoda
|
nativeMethod | boolean |
Wskazuje, czy metoda jest metodą natywną |
Grupa
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
childDomainValues
|
childDomainValues | array of DomainValue | |
|
Domyślny identyfikator klasy użytkownika
|
defaultUserClassId | integer |
Domyślny identyfikator klasy użytkownika dla grupy. |
|
Usunięte
|
deleted | boolean |
Wskazuje, czy grupa została usunięta. |
|
Identyfikator domeny
|
domainId | integer |
Identyfikator domeny, do której należy grupa. |
|
Adres e-mail
|
emailAddress | string |
Adres e-mail skojarzony z grupą. |
|
Ma elementy podrzędne
|
hasChildren | boolean |
Wskazuje, czy grupa ma elementy podrzędne. |
|
identyfikator
|
id | integer |
Identyfikator grupy. |
|
Jest usuwany
|
isDeleted | boolean |
Wskazuje, czy grupa została usunięta. |
|
Nazwa wyróżniająca LDAP
|
ldapDistinguishedName | string |
Nazwa wyróżniająca w protokole LDAP dla grupy. |
|
Identyfikator profilu LDAP
|
ldapProfileId | integer |
Identyfikator profilu LDAP dla grupy. |
|
Identyfikatory elementów członkowskich
|
memberIds | array of integer |
Tablica identyfikatorów elementów członkowskich skojarzonych z grupą. |
|
Name
|
name | string |
Nazwa grupy. |
|
Natywne powiernik
|
nativeTrustee | boolean |
Wskazuje, czy grupa jest natywnym powiernikiem. |
|
Dokumentacja źródłowa
|
sourceReference | string |
Odwołanie źródłowe dla grupy. |
|
User
|
user | boolean |
Wskazuje, czy grupa jest użytkownikiem. |
liczba całkowita
Jest to podstawowy typ danych "liczba całkowita".
ciąg
Jest to podstawowy typ danych "string".