Menu dokumentacji

API wysyłek#

API wysyłek steruje konfiguracjami utworzonymi już w Supernova. Operacje odczytu wymagają akceptowanego zakresu odczytu wysyłek; podgląd, uruchomienie, wstrzymanie i wznowienie wymagają dostępu do zapisu wysyłek.

Odczyt konfiguracji#

GET/sends

Zwraca najwyżej 100 konfiguracji wraz z ostatnim uruchomieniem.

GET/sends/{id}

Zwraca miejsce docelowe, model, typ obiektu, regułę dopasowania, mapowania, politykę tworzenia, harmonogram i 5 ostatnich uruchomień.

GET/sends/{id}/runs

Zwraca najwyżej 100 zasobów uruchomień ze stanem, dry_run, needs_confirmation, znacznikami czasu, statystykami i kategoriami błędów najwyższego poziomu.

Podgląd i uruchomienie#

POST/sends/{id}/preview

Rozpoczyna próbę na sucho. Nigdy nie zapisuje i nie zmienia stanu bazowego różnic.

POST/sends/{id}/run

Rozpoczyna uruchomienie z zapisem. Flagi treści mogą zażądać confirm po sprawdzeniu podglądu albo full, aby wyczyścić wcześniejszy stan bazowy różnic. 409 send_paused oznacza, że najpierw trzeba wznowić. 409 send_in_progress oznacza, że istniejąca praca jest już właścicielem konfiguracji.

Wstrzymywanie i wznawianie#

POST/sends/{id}/pause

POST/sends/{id}/resume

Wstrzymanie zapobiega nowym zaplanowanym uruchomieniom; nie obiecuje wycofania zapisów docelowych, które już potwierdzono.

Przeglądanie uruchomienia#

GET /sends/{id}/runs/{runId}/preview zwraca ograniczone próbki podglądu. GET /sends/{id}/runs/{runId}/errors zwraca najwyżej 500 błędów wierszy bez wartości wraz ze statystykami. GET /sends/{id}/stream śledzi bieżący postęp.

Zarówno brakujące identyfikatory, jak i identyfikatory z innej organizacji zwracają 404 send_not_found.