Zasób: Kanał
Kanał powiadomień używany do monitorowania zmian zasobów.
Zapis JSON |
---|
{ "payload": boolean, "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": string, "type": string, "address": string, "params": { string: string, ... }, "kind": string } |
Pola | |
---|---|
payload |
Wartość logiczna wskazująca, czy potrzebny jest ładunek. Opcjonalnie. |
id |
Identyfikator UUID lub podobny unikalny ciąg znaków, który identyfikuje ten kanał. |
resourceId |
Nieprzejrzysty identyfikator identyfikujący zasób, który chcesz oglądać na tym kanale. Stabilna w różnych wersjach interfejsu API. |
resourceUri |
Identyfikator wersji obserwowanego zasobu. |
token |
Dowolny ciąg znaków wysyłany na adres docelowy wraz z każdym powiadomieniem przesłanym na ten kanał. Opcjonalnie. |
expiration |
Data i godzina wygaśnięcia kanału powiadomień w milisekundach, w postaci sygnatury czasowej uniksowej. Opcjonalnie. |
type |
Typ mechanizmu przesyłania używany w tym kanale. Prawidłowe wartości to „web_hook” lub „webhook”. |
address |
Adres, na który są dostarczane powiadomienia dotyczące tego kanału. |
params |
Dodatkowe parametry kontrolujące zachowanie kanału wyświetlania. Opcjonalnie. Obiekt zawierający listę par |
kind |
Określa go jako kanał powiadomień używany do monitorowania zmian w zasobie |
Metody |
|
---|---|
|
Nie będzie już oglądać zasobów na tym kanale. |