{ "components" : { "schemas" : { "account" : { "additionalProperties" : true, "properties" : { "disable_legacy_notifications" : { "default" : false, "description" : "Wyłącza \"stare\" powiadomienia dla wszystkich usług na koncie, niezależnie od ich konfiguracji. Nie wyłącza powiadomień generowanych przez eskalacje", "type" : "boolean" }, "id" : { "description" : "Identyfikator konta", "minimum" : 1, "type" : "integer" }, "is_activated" : { "default" : true, "description" : "Określa, czy konto zostało aktywowane", "type" : "boolean" }, "is_blocked" : { "description" : "Określa, czy konto zostało zablokowane", "type" : "boolean" }, "is_read_only" : { "default" : false, "description" : "Określa, czy konto jest tylko do odczytu", "type" : "boolean" }, "language_id" : { "default" : "pl", "description" : "Identyfikator języka raportów okresowych i powiadomień (klucz w słowniku `languages`)", "type" : "string" }, "name" : { "description" : "Nazwa konta", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "package_id" : { "description" : "Identyfikator pakietu", "minimum" : 1, "type" : "integer" }, "parent_account_id" : { "description" : "Identyfikator konta nadrzędnego (udostępniającego wszystkie usługi i grupy)", "minimum" : 1, "nullable" : true, "type" : "integer" }, "time_zone_id" : { "default" : "europe_warsaw", "description" : "Identyfikator strefy czasowej dla tygodniowych zawieszeń monitoringu i trybu cichego (klucz w słowniku `time_zones`)", "type" : "string" }, "username" : { "description" : "Login użytkownika", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "type" : "object" }, "account_activation_result" : { "properties" : { "message" : { "type" : "string" } }, "type" : "object" }, "account_create_data" : { "additionalProperties" : false, "properties" : { "custom_activation_uri" : { "description" : "Własny adres URL służący do aktywacji konta. Zostaną do niego dodane parametry GET `token` oraz `account_id`. Powinien aktywować konto za pomocą operacji `GET /accounts/:id/activate`", "maxLength" : 1024, "nullable" : true, "pattern" : "^https?:\\/\\/[^\\/]", "type" : "string" }, "disable_legacy_notifications" : { "default" : false, "description" : "Wyłącza \"stare\" powiadomienia dla wszystkich usług na koncie, niezależnie od ich konfiguracji. Nie wyłącza powiadomień generowanych przez eskalacje", "type" : "boolean" }, "is_read_only" : { "default" : false, "description" : "Określa, czy konto jest tylko do odczytu", "type" : "boolean" }, "language_id" : { "default" : "pl", "description" : "Identyfikator języka raportów okresowych i powiadomień (klucz w słowniku `languages`)", "type" : "string" }, "name" : { "description" : "Nazwa konta", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "package_id" : { "description" : "Identyfikator pakietu", "minimum" : 1, "type" : "integer" }, "parent_account_id" : { "description" : "Identyfikator konta nadrzędnego (udostępniającego wszystkie usługi i grupy)", "minimum" : 1, "nullable" : true, "type" : "integer" }, "password" : { "description" : "Hasło użytkownika", "maxLength" : 1024, "minLength" : 6, "type" : "string" }, "redirect_uri" : { "description" : "Adres URL do przekierowania po poprawnym potwierdzeniu adresu e-mail. Nieużywany jeśli określono `custom_activation_uri`", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "time_zone_id" : { "default" : "europe_warsaw", "description" : "Identyfikator strefy czasowej dla tygodniowych zawieszeń monitoringu i trybu cichego (klucz w słowniku `time_zones`)", "type" : "string" }, "user_data" : { "$ref" : "#/components/schemas/user_data_create_data" }, "username" : { "description" : "Login użytkownika", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "required" : [ "name", "password", "user_data", "username" ], "type" : "object" }, "account_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "account_filters" : { "additionalProperties" : false, "properties" : { "disable_legacy_notifications" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_activated" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_blocked" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_read_only" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "language_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "package_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "parent_account_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.close" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_contact_groups" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_contacts" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_customer_portal_sessions" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_events" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_groups" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_report_templates" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_subaccounts" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_templates" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read_logs" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read_stats" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.setup_2fa" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.share_groups" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "time_zone_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "account_permission" : { "additionalProperties" : true, "properties" : { "close" : { "description" : "Uprawnienia do zamknięcia konta", "type" : "boolean" }, "create_contact_groups" : { "description" : "Uprawnienia do tworzenia grup kontaktów należących do konta", "type" : "boolean" }, "create_contacts" : { "description" : "Uprawnienia do tworzenia kontaktów należących do konta", "type" : "boolean" }, "create_customer_portal_sessions" : { "description" : "Uprawnienia do tworzenia sesji panelu billingowego", "type" : "boolean" }, "create_events" : { "description" : "Uprawnienia do tworzenia zdarzeń należących do konta", "type" : "boolean" }, "create_groups" : { "description" : "Uprawnienia do tworzenia nowych grup przypisanych do konta", "type" : "boolean" }, "create_report_templates" : { "description" : "Uprawnienia do tworzenia nowych harmonogramów raportów przypisanych do konta", "type" : "boolean" }, "create_subaccounts" : { "description" : "Uprawnienia do tworzenia subkont", "type" : "boolean" }, "create_templates" : { "description" : "Uprawnienia do tworzenia szablonów powiadomień należących do konta", "type" : "boolean" }, "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "read_logs" : { "description" : "Uprawnienia do przeglądania logów konta", "type" : "boolean" }, "read_stats" : { "description" : "Uprawnienia do pobrania aktualnych statystyk konta", "type" : "boolean" }, "setup_2fa" : { "description" : "Uprawnienia do konfiguracji 2FA dla konta", "type" : "boolean" }, "share_groups" : { "description" : "Uprawnienia do udostępniania grup użytkownikowi", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "account_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/account_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/account_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "account_sortable_field" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone_id", "username" ], "type" : "string" }, "account_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/account_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "account_stats" : { "additionalProperties" : false, "properties" : { "own_archived_service_steps" : { "description" : "Liczba kroków w archiwalnych usługach należących do konta", "minimum" : 0, "type" : "integer" }, "own_archived_services" : { "description" : "Liczba archiwalnych usług należących do konta", "minimum" : 0, "type" : "integer" }, "own_failure_service_steps" : { "description" : "Liczba kroków w usługach należących do konta, które są w stanie awarii", "minimum" : 0, "type" : "integer" }, "own_failure_services" : { "description" : "Liczba usług należących do konta, które są w stanie awarii", "minimum" : 0, "type" : "integer" }, "own_paused_service_steps" : { "description" : "Liczba kroków w usługach należących do konta, które są wyłączone lub wstrzymane (także archiwalnych)", "minimum" : 0, "type" : "integer" }, "own_paused_services" : { "description" : "Liczba usług należących do konta, które są wyłączone lub wstrzymane (także archiwalnych)", "minimum" : 0, "type" : "integer" }, "own_service_steps" : { "description" : "Liczba kroków w usługach należących do konta", "minimum" : 0, "type" : "integer" }, "own_services" : { "description" : "Liczba usług należących do konta", "minimum" : 0, "type" : "integer" }, "shared_archived_service_steps" : { "description" : "Liczba kroków w archiwalnych usługach udostępnionych kontu", "minimum" : 0, "type" : "integer" }, "shared_archived_services" : { "description" : "Liczba archiwalnych usług udostępnionych kontu", "minimum" : 0, "type" : "integer" }, "shared_failure_service_steps" : { "description" : "Liczba kroków w usługach udostępnionych kontu, które są w stanie awarii", "minimum" : 0, "type" : "integer" }, "shared_failure_services" : { "description" : "Liczba usług udostępnionych kontu, które są w stanie awarii", "minimum" : 0, "type" : "integer" }, "shared_paused_service_steps" : { "description" : "Liczba kroków w usługach udostępnionych kontu, które są wyłączone lub wstrzymane (także archiwalnych)", "minimum" : 0, "type" : "integer" }, "shared_paused_services" : { "description" : "Liczba usług udostępnionych kontu, które są wyłączone lub wstrzymane (także archiwalnych)", "minimum" : 0, "type" : "integer" }, "shared_service_steps" : { "description" : "Liczba kroków w usługach udostępnionych kontu", "minimum" : 0, "type" : "integer" }, "shared_services" : { "description" : "Liczba usług udostępnionych kontu", "minimum" : 0, "type" : "integer" } }, "required" : [ "own_services", "own_paused_services", "own_failure_services", "own_archived_services", "shared_services", "shared_paused_services", "shared_failure_services", "shared_archived_services", "own_service_steps", "own_paused_service_steps", "own_failure_service_steps", "own_archived_service_steps", "shared_service_steps", "shared_paused_service_steps", "shared_failure_service_steps", "shared_archived_service_steps" ], "type" : "object" }, "account_stats_by_service_type_category" : { "additionalProperties" : false, "properties" : { "own_archived_service_steps" : { "description" : "Liczba kroków w archiwalnych usługach danej kategorii należących do konta", "minimum" : 0, "type" : "integer" }, "own_archived_services" : { "description" : "Liczba archiwalnych usług danej kategorii należących do konta", "minimum" : 0, "type" : "integer" }, "own_failure_service_steps" : { "description" : "Liczba kroków w usługach danej kategorii należących do konta, które są w stanie awarii", "minimum" : 0, "type" : "integer" }, "own_failure_services" : { "description" : "Liczba usług danej kategorii należących do konta, które są w stanie awarii", "minimum" : 0, "type" : "integer" }, "own_paused_service_steps" : { "description" : "Liczba kroków w usługach danej kategorii należących do konta, które są wyłączone lub wstrzymane (także archiwalnych)", "minimum" : 0, "type" : "integer" }, "own_paused_services" : { "description" : "Liczba usług danej kategorii należących do konta, które są wyłączone lub wstrzymane (także archiwalnych)", "minimum" : 0, "type" : "integer" }, "own_service_steps" : { "description" : "Liczba kroków w usługach danej kategorii należących do konta", "minimum" : 0, "type" : "integer" }, "own_services" : { "description" : "Liczba usług danej kategorii należących do konta", "minimum" : 0, "type" : "integer" }, "service_type_category" : { "$ref" : "#/components/schemas/service_type_category" }, "shared_archived_service_steps" : { "description" : "Liczba kroków w archiwalnych usługach danej kategorii udostępnionych kontu", "minimum" : 0, "type" : "integer" }, "shared_archived_services" : { "description" : "Liczba archiwalnych usług danej kategorii udostępnionych kontu", "minimum" : 0, "type" : "integer" }, "shared_failure_service_steps" : { "description" : "Liczba kroków w usługach danej kategorii udostępnionych kontu, które są w stanie awarii", "minimum" : 0, "type" : "integer" }, "shared_failure_services" : { "description" : "Liczba usług danej kategorii udostępnionych kontu, które są w stanie awarii", "minimum" : 0, "type" : "integer" }, "shared_paused_service_steps" : { "description" : "Liczba kroków w usługach danej kategorii udostępnionych kontu, które są wyłączone lub wstrzymane (także archiwalnych)", "minimum" : 0, "type" : "integer" }, "shared_paused_services" : { "description" : "Liczba usług danej kategorii udostępnionych kontu, które są wyłączone lub wstrzymane (także archiwalnych)", "minimum" : 0, "type" : "integer" }, "shared_service_steps" : { "description" : "Liczba kroków w usługach danej kategorii udostępnionych kontu", "minimum" : 0, "type" : "integer" }, "shared_services" : { "description" : "Liczba usług danej kategorii udostępnionych kontu", "minimum" : 0, "type" : "integer" } }, "required" : [ "service_type_category", "own_services", "own_paused_services", "own_failure_services", "own_archived_services", "shared_services", "shared_paused_services", "shared_failure_services", "shared_archived_services", "own_service_steps", "own_paused_service_steps", "own_failure_service_steps", "own_archived_service_steps", "shared_service_steps", "shared_paused_service_steps", "shared_failure_service_steps", "shared_archived_service_steps" ], "type" : "object" }, "accounts_scope" : { "properties" : { "all" : { "type" : "boolean" }, "by_id" : { "$ref" : "#/components/schemas/array_of_ids" } }, "type" : "object" }, "admin_account" : { "additionalProperties" : true, "properties" : { "address" : { "description" : "Adres", "maxLength" : 128, "nullable" : true, "type" : "string" }, "comment" : { "default" : "", "description" : "Wewnętrzny komentarz administatora", "type" : "string" }, "contact_person" : { "description" : "Osoba do kontaktu", "maxLength" : 255, "nullable" : true, "type" : "string" }, "email_address" : { "description" : "Adres e-mail", "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "id" : { "description" : "Identyfikator konta", "minimum" : 1, "type" : "integer" }, "is_activated" : { "default" : true, "description" : "Określa, czy konto zostało aktywowane", "type" : "boolean" }, "is_blocked" : { "description" : "Określa, czy konto zostało zablokowane", "type" : "boolean" }, "is_read_only" : { "default" : false, "description" : "Określa, czy konto jest tylko do odczytu", "type" : "boolean" }, "language_id" : { "default" : "pl", "description" : "Identyfikator języka raportów okresowych i powiadomień (klucz w słowniku `languages`)", "type" : "string" }, "name" : { "description" : "Nazwa konta", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "package_id" : { "description" : "Identyfikator pakietu", "minimum" : 1, "type" : "integer" }, "parent_account_id" : { "description" : "Identyfikator konta nadrzędnego (udostępniającego wszystkie usługi i grupy)", "minimum" : 1, "nullable" : true, "type" : "integer" }, "phone_number" : { "description" : "Telefon kontaktowy", "maxLength" : 20, "nullable" : true, "pattern" : "^\\+?[0-9 ]*?$", "type" : "string" }, "tax_identification_number" : { "description" : "NIP", "maxLength" : 10, "nullable" : true, "type" : "string" }, "time_zone_id" : { "default" : "europe_warsaw", "description" : "Identyfikator strefy czasowej dla tygodniowych zawieszeń monitoringu i trybu cichego (klucz w słowniku `time_zones`)", "type" : "string" }, "username" : { "description" : "Login użytkownika", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "type" : "object" }, "admin_account_create_data" : { "additionalProperties" : false, "properties" : { "address" : { "description" : "Adres", "maxLength" : 128, "nullable" : true, "type" : "string" }, "comment" : { "default" : "", "description" : "Wewnętrzny komentarz administatora", "type" : "string" }, "contact_person" : { "description" : "Osoba do kontaktu", "maxLength" : 255, "nullable" : true, "type" : "string" }, "create_notification_addresses" : { "default" : false, "description" : "Określa, czy do grupy domyślnej dodać adresy powiadomień e-mail i SMS na podstawie danych konta", "type" : "boolean" }, "email_address" : { "description" : "Adres e-mail", "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "is_read_only" : { "default" : false, "description" : "Określa, czy konto jest tylko do odczytu", "type" : "boolean" }, "language_id" : { "default" : "pl", "description" : "Identyfikator języka raportów okresowych i powiadomień (klucz w słowniku `languages`)", "type" : "string" }, "name" : { "description" : "Nazwa konta", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "package_id" : { "description" : "Identyfikator pakietu", "minimum" : 1, "type" : "integer" }, "parent_account_id" : { "description" : "Identyfikator konta nadrzędnego (udostępniającego wszystkie usługi i grupy)", "minimum" : 1, "nullable" : true, "type" : "integer" }, "password" : { "description" : "Hasło użytkownika", "maxLength" : 1024, "minLength" : 6, "type" : "string" }, "phone_number" : { "description" : "Telefon kontaktowy", "maxLength" : 20, "nullable" : true, "pattern" : "^\\+?[0-9 ]*?$", "type" : "string" }, "tax_identification_number" : { "description" : "NIP", "maxLength" : 10, "nullable" : true, "type" : "string" }, "time_zone_id" : { "default" : "europe_warsaw", "description" : "Identyfikator strefy czasowej dla tygodniowych zawieszeń monitoringu i trybu cichego (klucz w słowniku `time_zones`)", "type" : "string" }, "username" : { "description" : "Login użytkownika", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "required" : [ "email_address", "name", "package_id", "password", "username" ], "type" : "object" }, "admin_account_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "admin_account_filters" : { "additionalProperties" : false, "properties" : { "address" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "comment" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "contact_person" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "email_address" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_activated" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_blocked" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_read_only" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "language_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "package_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "parent_account_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.block" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.unblock" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "phone_number" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "tax_identification_number" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "time_zone_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "admin_account_permission" : { "additionalProperties" : true, "properties" : { "block" : { "description" : "Uprawnienia do blokowania konta", "type" : "boolean" }, "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "unblock" : { "description" : "Uprawnienia do odblokowania konta", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "admin_account_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "permissions", "permissions.block", "permissions.delete", "permissions.own", "permissions.read", "permissions.unblock", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "address", "comment", "contact_person", "email_address", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "phone_number", "tax_identification_number", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/admin_account_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/admin_account_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "admin_account_sortable_field" : { "enum" : [ "address", "comment", "contact_person", "email_address", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "permissions.block", "permissions.delete", "permissions.own", "permissions.read", "permissions.unblock", "permissions.update", "phone_number", "tax_identification_number", "time_zone_id", "username" ], "type" : "string" }, "admin_account_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/admin_account_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "admin_package" : { "additionalProperties" : true, "properties" : { "available_notification_channel_ids" : { "default" : [ "alerta", "email", "email_dedicated", "email_extended", "email_short", "email_simplified", "gadu_gadu", "hipchat", "jabber", "json_post", "ms_teams", "ms_teams_extended", "pagerduty", "push", "rocketchat", "signal", "slack", "sms", "telephone" ], "description" : "Identyfikatory kanałów powiadomień dostępnych w pakiecie", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "available_service_types" : { "description" : "Dostępne typy usług, razem z ewentualnymi ograniczeniami dla poszczególnych typów", "items" : { "$ref" : "#/components/schemas/package_service_type_limit" }, "type" : "array" }, "can_force_custom_analyses" : { "default" : false, "description" : "Określa, czy konta z tym pakietem mają uprawnienia do wymuszania niestandardowych analiz usług", "type" : "boolean" }, "id" : { "description" : "Identyfikator pakietu", "minimum" : 1, "type" : "integer" }, "is_available_for_new_accounts" : { "description" : "Określa, czy pakiet jest dostępny dla rejestracji nowych kont", "type" : "boolean" }, "maximum_sensors" : { "description" : "Liczba stacji monitorujących, z których usługi mogą być monitorowane jednocześnie", "maximum" : 1000, "minimum" : 1, "type" : "integer" }, "maximum_services" : { "description" : "Liczba usług dostępna w pakiecie", "maximum" : 100000, "minimum" : 0, "type" : "integer" }, "maximum_sms_numbers" : { "description" : "Maksymalna liczba numerów powiadomień SMS zdefiniowanych dla grupy", "maximum" : 1000, "minimum" : 0, "nullable" : true, "type" : "integer" }, "minimum_interval" : { "description" : "Minimalny odstęp pomiędzy sprawdzeniami usług, w sekundach", "maximum" : 86400, "minimum" : 10, "type" : "integer" }, "monthly_reports_limit" : { "description" : "Miesięczny limit wygenerowanych raportów", "maximum" : 1000, "minimum" : 0, "nullable" : true, "type" : "integer" }, "name" : { "description" : "Nazwa pakietu", "maxLength" : 40, "minLength" : 1, "type" : "string" } }, "type" : "object" }, "admin_package_filters" : { "additionalProperties" : false, "properties" : { "can_force_custom_analyses" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_available_for_new_accounts" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "maximum_sensors" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "maximum_services" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "maximum_sms_numbers" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "minimum_interval" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "monthly_reports_limit" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_accounts" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "admin_package_permission" : { "additionalProperties" : true, "properties" : { "create_accounts" : { "description" : "Uprawnienia do tworzenia nowych kont z pakietem", "type" : "boolean" }, "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "admin_package_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "available_notification_channels", "available_notification_channels.description", "available_notification_channels.id", "available_notification_channels.name", "permissions", "permissions.create_accounts", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "available_notification_channel_ids", "available_service_types", "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/admin_package_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/admin_package_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "admin_package_sortable_field" : { "enum" : [ "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name", "permissions.create_accounts", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "admin_package_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/admin_package_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "analysis" : { "additionalProperties" : true, "properties" : { "analysis_id" : { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "error_checks_count" : { "description" : "Liczba sprawdzeń w analizie zakończonych błędem", "minimum" : 0, "type" : "integer" }, "error_tolerance" : { "description" : "Procentowe ustawienie wrażliwości na błędy z momentu wykonania analizy", "minimum" : 0, "type" : "integer" }, "failure" : { "description" : "Określa, czy analiza zakończyła się wykryciem awarii", "type" : "boolean" }, "ok_checks_count" : { "description" : "Liczba sprawdzeń w analizie zakończonych sukcesem", "minimum" : 0, "type" : "integer" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "time" : { "description" : "Czas wykonania analizy", "format" : "dateTime", "type" : "string" }, "unknown_checks_count" : { "description" : "Liczba sprawdzeń w analizie o nieznanym statusie", "minimum" : 0, "type" : "integer" } }, "type" : "object" }, "any" : { "anyOf" : [ { "additionalProperties" : true, "type" : "object" }, { "items" : {}, "type" : "array" }, { "type" : "boolean" }, { "type" : "number" }, { "type" : "string" } ] }, "api_error" : { "additionalProperties" : false, "properties" : { "code" : { "description" : "Szczegółowy kod błędu", "type" : "integer" }, "description" : { "description" : "Opis błędu przeznaczony dla twórcy aplikacji", "type" : "string" }, "error" : { "description" : "Symbol błędu odpowiadający kodowi w `code`", "type" : "string" }, "field" : { "description" : "Adres fragmentu zapytania (`data.*` lub `query.*`), który spowodował błąd", "type" : "string" }, "message" : { "description" : "Komunikat dla użytkownika końcowego", "type" : "string" } }, "required" : [ "code", "message", "error" ], "type" : "object" }, "api_error_response" : { "items" : { "$ref" : "#/components/schemas/api_error" }, "type" : "array" }, "array_of_accounts" : { "items" : { "$ref" : "#/components/schemas/account" }, "type" : "array" }, "array_of_admin_accounts" : { "items" : { "$ref" : "#/components/schemas/admin_account" }, "type" : "array" }, "array_of_admin_packages" : { "items" : { "$ref" : "#/components/schemas/admin_package" }, "type" : "array" }, "array_of_analyses" : { "items" : { "$ref" : "#/components/schemas/analysis" }, "type" : "array" }, "array_of_artifact_types" : { "items" : { "$ref" : "#/components/schemas/artifact_type" }, "type" : "array" }, "array_of_artifacts" : { "items" : { "$ref" : "#/components/schemas/artifact" }, "type" : "array" }, "array_of_authentications" : { "items" : { "$ref" : "#/components/schemas/authentication" }, "type" : "array" }, "array_of_checks" : { "items" : { "$ref" : "#/components/schemas/check" }, "type" : "array" }, "array_of_contact_addresses" : { "items" : { "$ref" : "#/components/schemas/contact_address" }, "type" : "array" }, "array_of_contact_channels" : { "items" : { "$ref" : "#/components/schemas/contact_channel" }, "type" : "array" }, "array_of_contact_groups" : { "items" : { "$ref" : "#/components/schemas/contact_group" }, "type" : "array" }, "array_of_contact_notifications" : { "items" : { "$ref" : "#/components/schemas/contact_notification" }, "type" : "array" }, "array_of_contact_suspensions" : { "items" : { "$ref" : "#/components/schemas/contact_suspension" }, "type" : "array" }, "array_of_contact_weekly_suspensions" : { "items" : { "$ref" : "#/components/schemas/contact_weekly_suspension" }, "type" : "array" }, "array_of_contacts" : { "items" : { "$ref" : "#/components/schemas/contact" }, "type" : "array" }, "array_of_corrections" : { "items" : { "$ref" : "#/components/schemas/correction" }, "type" : "array" }, "array_of_custom_templates" : { "items" : { "$ref" : "#/components/schemas/custom_template" }, "type" : "array" }, "array_of_default_templates" : { "items" : { "$ref" : "#/components/schemas/default_template" }, "type" : "array" }, "array_of_error_type_categories" : { "items" : { "$ref" : "#/components/schemas/error_type_category" }, "type" : "array" }, "array_of_error_types" : { "items" : { "$ref" : "#/components/schemas/error_type" }, "type" : "array" }, "array_of_escalation_statuses" : { "items" : { "$ref" : "#/components/schemas/escalation_status" }, "type" : "array" }, "array_of_escalation_suspensions" : { "items" : { "$ref" : "#/components/schemas/escalation_suspension" }, "type" : "array" }, "array_of_escalation_weekly_suspensions" : { "items" : { "$ref" : "#/components/schemas/escalation_weekly_suspension" }, "type" : "array" }, "array_of_escalations" : { "items" : { "$ref" : "#/components/schemas/escalation" }, "type" : "array" }, "array_of_event_service_level_intervals" : { "items" : { "$ref" : "#/components/schemas/event_service_level_interval" }, "type" : "array" }, "array_of_event_status_change_logs" : { "items" : { "$ref" : "#/components/schemas/event_status_change_log" }, "type" : "array" }, "array_of_event_status_changes" : { "items" : { "$ref" : "#/components/schemas/event_status_change" }, "type" : "array" }, "array_of_event_statuses" : { "items" : { "$ref" : "#/components/schemas/event_status" }, "type" : "array" }, "array_of_events" : { "items" : { "$ref" : "#/components/schemas/event" }, "type" : "array" }, "array_of_extended_setting_formats" : { "items" : { "$ref" : "#/components/schemas/extended_setting_format" }, "type" : "array" }, "array_of_group_shares" : { "items" : { "$ref" : "#/components/schemas/group_share" }, "type" : "array" }, "array_of_group_stats" : { "items" : { "$ref" : "#/components/schemas/group_stat" }, "type" : "array" }, "array_of_groups" : { "items" : { "$ref" : "#/components/schemas/group" }, "type" : "array" }, "array_of_ids" : { "description" : "Tablica identyfikatorów.", "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true }, "array_of_languages" : { "items" : { "$ref" : "#/components/schemas/language" }, "type" : "array" }, "array_of_metric_types" : { "items" : { "$ref" : "#/components/schemas/metric_type" }, "type" : "array" }, "array_of_monthly_account_usage_stats" : { "items" : { "$ref" : "#/components/schemas/monthly_account_usage_stat" }, "type" : "array" }, "array_of_monthly_group_usage_stats" : { "items" : { "$ref" : "#/components/schemas/monthly_group_usage_stat" }, "type" : "array" }, "array_of_notification_addresses" : { "items" : { "$ref" : "#/components/schemas/notification_address" }, "type" : "array" }, "array_of_notification_channels" : { "items" : { "$ref" : "#/components/schemas/notification_channel" }, "type" : "array" }, "array_of_notification_conditions" : { "items" : { "$ref" : "#/components/schemas/notification_condition" }, "type" : "array" }, "array_of_notification_modes" : { "items" : { "$ref" : "#/components/schemas/notification_mode" }, "type" : "array" }, "array_of_notifications" : { "items" : { "$ref" : "#/components/schemas/notification" }, "type" : "array" }, "array_of_packages" : { "items" : { "$ref" : "#/components/schemas/package" }, "type" : "array" }, "array_of_performance_chart_points" : { "description" : "Punkty na wykresie szybkości działania.", "items" : { "$ref" : "#/components/schemas/performance_chart_point" }, "type" : "array" }, "array_of_performance_chart_series" : { "items" : { "$ref" : "#/components/schemas/performance_chart_series" }, "type" : "array" }, "array_of_periodic_report_addresses" : { "items" : { "$ref" : "#/components/schemas/periodic_report_address" }, "type" : "array" }, "array_of_recovery_notification_modes" : { "items" : { "$ref" : "#/components/schemas/recovery_notification_mode" }, "type" : "array" }, "array_of_report_analyses_by_hour" : { "items" : { "$ref" : "#/components/schemas/report_analyses" }, "maxItems" : 24, "minItems" : 24, "type" : "array" }, "array_of_report_analyses_by_month" : { "items" : { "$ref" : "#/components/schemas/report_analyses" }, "maxItems" : 12, "minItems" : 12, "type" : "array" }, "array_of_report_analyses_by_month_day" : { "items" : { "$ref" : "#/components/schemas/report_analyses" }, "maxItems" : 31, "minItems" : 31, "type" : "array" }, "array_of_report_analyses_by_week_day" : { "items" : { "$ref" : "#/components/schemas/report_analyses" }, "maxItems" : 7, "minItems" : 7, "type" : "array" }, "array_of_report_attachment_types" : { "items" : { "$ref" : "#/components/schemas/report_attachment_type" }, "type" : "array" }, "array_of_report_attachments" : { "items" : { "$ref" : "#/components/schemas/report_attachment" }, "type" : "array" }, "array_of_report_checks_by_hour" : { "items" : { "$ref" : "#/components/schemas/report_checks" }, "maxItems" : 24, "minItems" : 24, "type" : "array" }, "array_of_report_checks_by_month" : { "items" : { "$ref" : "#/components/schemas/report_checks" }, "maxItems" : 12, "minItems" : 12, "type" : "array" }, "array_of_report_checks_by_month_day" : { "items" : { "$ref" : "#/components/schemas/report_checks" }, "maxItems" : 31, "minItems" : 31, "type" : "array" }, "array_of_report_checks_by_sensor" : { "items" : { "$ref" : "#/components/schemas/report_checks_by_sensor" }, "type" : "array" }, "array_of_report_checks_by_week_day" : { "items" : { "$ref" : "#/components/schemas/report_checks" }, "maxItems" : 7, "minItems" : 7, "type" : "array" }, "array_of_report_errors_by_path_step" : { "items" : { "$ref" : "#/components/schemas/report_errors_by_path_step" }, "type" : "array" }, "array_of_report_errors_by_type" : { "items" : { "$ref" : "#/components/schemas/report_errors_by_type" }, "type" : "array" }, "array_of_report_performance_by_hour" : { "items" : { "$ref" : "#/components/schemas/report_performance" }, "maxItems" : 24, "minItems" : 24, "type" : "array" }, "array_of_report_performance_by_month" : { "items" : { "$ref" : "#/components/schemas/report_performance" }, "maxItems" : 12, "minItems" : 12, "type" : "array" }, "array_of_report_performance_by_month_day" : { "items" : { "$ref" : "#/components/schemas/report_performance" }, "maxItems" : 31, "minItems" : 31, "type" : "array" }, "array_of_report_performance_by_path_step" : { "items" : { "$ref" : "#/components/schemas/report_performance_by_path_step" }, "type" : "array" }, "array_of_report_performance_by_sensor" : { "items" : { "$ref" : "#/components/schemas/report_performance_by_sensor" }, "type" : "array" }, "array_of_report_performance_by_week_day" : { "items" : { "$ref" : "#/components/schemas/report_performance" }, "maxItems" : 7, "minItems" : 7, "type" : "array" }, "array_of_report_results" : { "items" : { "$ref" : "#/components/schemas/report_result" }, "type" : "array" }, "array_of_report_sections" : { "items" : { "$ref" : "#/components/schemas/report_section" }, "type" : "array" }, "array_of_report_service_level_by_hour" : { "items" : { "$ref" : "#/components/schemas/report_service_level" }, "maxItems" : 24, "minItems" : 24, "type" : "array" }, "array_of_report_service_level_by_month" : { "items" : { "$ref" : "#/components/schemas/report_service_level" }, "maxItems" : 12, "minItems" : 12, "type" : "array" }, "array_of_report_service_level_by_month_day" : { "items" : { "$ref" : "#/components/schemas/report_service_level" }, "maxItems" : 31, "minItems" : 31, "type" : "array" }, "array_of_report_service_level_by_week_day" : { "items" : { "$ref" : "#/components/schemas/report_service_level" }, "maxItems" : 7, "minItems" : 7, "type" : "array" }, "array_of_report_status_changes_by_duration" : { "items" : { "$ref" : "#/components/schemas/report_status_changes_by_duration" }, "type" : "array" }, "array_of_report_status_changes_by_hour" : { "items" : { "$ref" : "#/components/schemas/report_status_changes" }, "maxItems" : 24, "minItems" : 24, "type" : "array" }, "array_of_report_status_changes_by_month" : { "items" : { "$ref" : "#/components/schemas/report_status_changes" }, "maxItems" : 12, "minItems" : 12, "type" : "array" }, "array_of_report_status_changes_by_month_day" : { "items" : { "$ref" : "#/components/schemas/report_status_changes" }, "maxItems" : 31, "minItems" : 31, "type" : "array" }, "array_of_report_status_changes_by_week_day" : { "items" : { "$ref" : "#/components/schemas/report_status_changes" }, "maxItems" : 7, "minItems" : 7, "type" : "array" }, "array_of_report_template_variables" : { "items" : { "$ref" : "#/components/schemas/report_template_variable" }, "type" : "array" }, "array_of_report_templates" : { "items" : { "$ref" : "#/components/schemas/report_template" }, "type" : "array" }, "array_of_reporting_plans" : { "items" : { "$ref" : "#/components/schemas/reporting_plan" }, "type" : "array" }, "array_of_reports" : { "items" : { "$ref" : "#/components/schemas/report" }, "type" : "array" }, "array_of_scheduled_suspensions" : { "items" : { "$ref" : "#/components/schemas/scheduled_suspension" }, "type" : "array" }, "array_of_sensors" : { "items" : { "$ref" : "#/components/schemas/sensor" }, "type" : "array" }, "array_of_service_level_intervals" : { "items" : { "$ref" : "#/components/schemas/service_level_interval" }, "type" : "array" }, "array_of_service_statuses" : { "items" : { "$ref" : "#/components/schemas/service_status" }, "type" : "array" }, "array_of_service_type_categories" : { "items" : { "$ref" : "#/components/schemas/service_type_category" }, "type" : "array" }, "array_of_service_type_limits" : { "items" : { "$ref" : "#/components/schemas/service_type_limit" }, "type" : "array" }, "array_of_service_types" : { "items" : { "$ref" : "#/components/schemas/service_type" }, "type" : "array" }, "array_of_services" : { "items" : { "$ref" : "#/components/schemas/service" }, "type" : "array" }, "array_of_sessions" : { "items" : { "$ref" : "#/components/schemas/session" }, "type" : "array" }, "array_of_status_change_logs" : { "items" : { "$ref" : "#/components/schemas/status_change_log" }, "type" : "array" }, "array_of_status_change_stats" : { "items" : { "$ref" : "#/components/schemas/status_change_stat" }, "type" : "array" }, "array_of_status_changes" : { "items" : { "$ref" : "#/components/schemas/status_change" }, "type" : "array" }, "array_of_suspensions" : { "items" : { "$ref" : "#/components/schemas/suspension" }, "type" : "array" }, "array_of_template_variables" : { "items" : { "$ref" : "#/components/schemas/template_variable" }, "type" : "array" }, "array_of_templates" : { "items" : { "$ref" : "#/components/schemas/template" }, "type" : "array" }, "array_of_time_zones" : { "items" : { "$ref" : "#/components/schemas/time_zone" }, "type" : "array" }, "array_of_traceroute_hops" : { "items" : { "$ref" : "#/components/schemas/traceroute_hop" }, "type" : "array" }, "array_of_weekly_suspensions" : { "items" : { "$ref" : "#/components/schemas/weekly_suspension" }, "type" : "array" }, "artifact" : { "additionalProperties" : true, "properties" : { "analysis_id" : { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "artifact_id" : { "description" : "Identyfikator artefaktu, unikalny w obrębie sprawdzenia", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "content_type" : { "description" : "Typ MIME artefaktu", "type" : "string" }, "file_name" : { "description" : "Nazwa pliku z artefaktem", "type" : "string" }, "sensor_id" : { "description" : "Identyfikator stacji monitorującej, która wykonała sprawdzenie", "minimum" : 1, "type" : "integer" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "artifact_type" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "assigned_sensor_ids" : { "additionalProperties" : { "items" : { "minimum" : 1, "type" : "integer" }, "minItems" : 1, "type" : "array", "uniqueItems" : true }, "type" : "object" }, "auth_token_create_data" : { "properties" : { "client_id" : { "description" : "Identyfikator klienta API", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "password" : { "description" : "Hasło", "maxLength" : 1024, "minLength" : 6, "type" : "string" }, "scope" : { "description" : "Zasięg autoryzacji", "enum" : [ "customer", "administrator" ], "type" : "string" }, "timeout" : { "default" : "3600", "description" : "Czas bez aktywności, po jakim sesja wygaśnie, w sekundach", "maximum" : 7776000, "minimum" : 1, "type" : "integer" }, "user_ip_address" : { "description" : "Adres IP użytkownika API", "maxLength" : 15, "minLength" : 1, "type" : "string" }, "username" : { "description" : "Login", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "required" : [ "username", "password" ], "type" : "object" }, "auth_token_create_result" : { "properties" : { "id" : { "description" : "ID utworzonego tokena sesji", "maxLength" : 32, "minLength" : 32, "pattern" : "^[a-f0-9]*$", "type" : "string" } }, "required" : [ "id" ], "type" : "object" }, "authentication" : { "additionalProperties" : true, "properties" : { "account_id" : { "description" : "Identyfikator konta", "minimum" : 1, "type" : "integer" }, "client_id" : { "description" : "Identyfikator klienta API", "nullable" : true, "type" : "string" }, "client_ip_address" : { "description" : "Adres IP klienta API", "nullable" : true, "type" : "string" }, "time" : { "description" : "Czas autentykacji", "format" : "dateTime", "type" : "string" }, "type" : { "description" : "Typ autentykacji", "enum" : [ "oauth2", "auth_token", "session" ], "type" : "string" }, "user_ip_address" : { "description" : "Adres IP użytkownika", "nullable" : true, "type" : "string" } }, "type" : "object" }, "availability_time_range" : { "properties" : { "from" : { "description" : "Początek przedziału czasowego, dla którego są dostępne dane o dostępności usługi lub NULL jeśli żadne dane nie są jeszcze dostępne", "format" : "dateTime", "nullable" : true, "type" : "string" }, "to" : { "description" : "Koniec przedziału czasowego, dla którego są dostępne dane o dostępności lub NULL jeśli żadne dane nie są jeszcze dostępne", "format" : "dateTime", "nullable" : true, "type" : "string" } }, "required" : [ "from", "to" ], "type" : "object" }, "bulk_group_change_data" : { "properties" : { "group_id" : { "minimum" : 1, "type" : "integer" }, "service_ids" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true } }, "required" : [ "service_ids", "group_id" ], "type" : "object" }, "check" : { "additionalProperties" : true, "properties" : { "analysis_id" : { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "data_size" : { "description" : "Rozmiar pobranych danych, w bajtach", "minimum" : 0, "nullable" : true, "type" : "integer" }, "error_message" : { "description" : "Komunikat błędu zwrócony przez stację monitorującą", "nullable" : true, "type" : "string" }, "error_type_id" : { "description" : "Identyfikator typu wykrytego błędu lub NULL jeśli sprawdzenie nie zakończyło się błędem", "minimum" : 1, "nullable" : true, "type" : "integer" }, "har_available" : { "description" : "Określa, czy dla sprawdzenia jest dostępny plik HAR (artefakt o identyfikatorze `har`)", "type" : "boolean" }, "path_step" : { "description" : "Numer kroku scenariusza, na którym zakończyło się sprawdzenie", "minimum" : 1, "nullable" : true, "type" : "integer" }, "response_time" : { "description" : "Długość trwania sprawdzenia w milisekundach", "minimum" : 0, "nullable" : true, "type" : "integer" }, "result" : { "description" : "Wynik sprawdzenia", "enum" : [ "ok", "error", "unknown" ], "type" : "string" }, "sensor_id" : { "description" : "Identyfikator stacji monitorującej, która wykonała sprawdzenie", "minimum" : 1, "type" : "integer" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "time" : { "description" : "Czas sprawdzenia", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "check_detail" : { "additionalProperties" : true, "properties" : { "analysis_id" : { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "base_url" : { "description" : "Adres URL pobrany w momencie awarii", "nullable" : true, "type" : "string" }, "content_available" : { "description" : "Określa, czy dla sprawdzenia jest dostępna zawartość strony z momentu awarii (artefakt o identyfikatorze `content`)", "type" : "boolean" }, "content_type" : { "description" : "Typ MIME pobranej zawartości, jeśli jest dostępna", "nullable" : true, "type" : "string" }, "file_name" : { "description" : "Nazwa pliku pobranego w momencie awarii", "nullable" : true, "type" : "string" }, "metrics" : { "description" : "Metryki dla sprawdzenia", "items" : { "$ref" : "#/components/schemas/metric_value" }, "nullable" : true, "type" : "array" }, "response_headers" : { "description" : "Nagłówki HTTP odpowiedzi serwera (tylko dla błędnych sprawdzeń)", "nullable" : true, "type" : "string" }, "sensor_id" : { "description" : "Identyfikator stacji monitorującej, która wykonała sprawdzenie", "minimum" : 1, "type" : "integer" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "step_data" : { "description" : "Szczegóły sprawdzenia dla poszczególnych kroków scenariusza", "items" : { "$ref" : "#/components/schemas/check_step_detail" }, "nullable" : true, "type" : "array" } }, "type" : "object" }, "check_step_detail" : { "properties" : { "data_size" : { "description" : "Rozmiar danych pobranych w kroku, w bajtach", "minimum" : 0, "nullable" : true, "type" : "integer" }, "response_time" : { "description" : "Czas przejścia kroku w milisekundach", "minimum" : 0, "nullable" : true, "type" : "integer" }, "step" : { "description" : "Numer kroku scenariusza", "minimum" : 1, "type" : "integer" } }, "required" : [ "step", "response_time", "data_size" ], "type" : "object" }, "close_account_data" : { "additionalProperties" : false, "properties" : { "password" : { "type" : "string" } }, "type" : "object" }, "contact" : { "additionalProperties" : true, "properties" : { "description" : { "default" : "", "description" : "Opis kontaktu", "maxLength" : 10000, "type" : "string" }, "id" : { "description" : "Identyfikator kontaktu", "minimum" : 1, "type" : "integer" }, "language_id" : { "description" : "Preferowany język kontaktu. Domyślnie taki, jak język konta, do którego należy kontakt", "type" : "string" }, "name" : { "description" : "Nazwa kontaktu", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "Identyfikator konta, do którego należy kontakt", "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "contact_address" : { "additionalProperties" : true, "properties" : { "address" : { "description" : "Adres kontaktowy (e-mail, nr telefonu itp. - w zależności od kanału)", "maxLength" : 512, "minLength" : 1, "type" : "string" }, "channel_id" : { "description" : "Identyfikator kanału kontaktowego dla adresu", "type" : "string" }, "contact_id" : { "description" : "Identyfikator kontaktu, do którego należy adres", "minimum" : 1, "type" : "integer" }, "id" : { "description" : "Identyfikator adresu", "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "contact_address_create_data" : { "additionalProperties" : false, "properties" : { "address" : { "description" : "Adres kontaktowy (e-mail, nr telefonu itp. - w zależności od kanału)", "maxLength" : 512, "minLength" : 1, "type" : "string" }, "channel_id" : { "description" : "Identyfikator kanału kontaktowego dla adresu", "type" : "string" }, "contact_id" : { "description" : "Identyfikator kontaktu, do którego należy adres", "minimum" : 1, "type" : "integer" } }, "required" : [ "address", "channel_id", "contact_id" ], "type" : "object" }, "contact_address_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "contact_address_filters" : { "additionalProperties" : false, "properties" : { "address" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "channel_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "contact.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "contact_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "contact_address_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "address", "channel_id", "contact_id", "id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/contact_address_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/contact_address_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "contact_address_sortable_field" : { "enum" : [ "address", "channel_id", "contact.name", "contact_id", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "contact_address_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/contact_address_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "contact_channel" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "contact_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "default" : "", "description" : "Opis kontaktu", "maxLength" : 10000, "type" : "string" }, "language_id" : { "description" : "Preferowany język kontaktu. Domyślnie taki, jak język konta, do którego należy kontakt", "type" : "string" }, "name" : { "description" : "Nazwa kontaktu", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "Identyfikator konta, do którego należy kontakt", "minimum" : 1, "type" : "integer" } }, "required" : [ "name" ], "type" : "object" }, "contact_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "contact_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "language_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_addresses" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_suspensions" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_weekly_suspensions" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.customize_templates" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "contact_group" : { "additionalProperties" : true, "properties" : { "contact_ids" : { "default" : [], "description" : "Tablica identyfikatorów kontaktów należących do grupy. Kontakty w grupie muszą należeć do tego samego konta, co sama grupa", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 1000, "type" : "array", "uniqueItems" : true }, "description" : { "default" : "", "description" : "Nazwa grupy kontaktów", "maxLength" : 10000, "type" : "string" }, "id" : { "description" : "Identyfikator grupy kontaktów", "minimum" : 1, "type" : "integer" }, "name" : { "description" : "Nazwa grupy kontaktów", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "ID konta, do którego należy grupa kontaktów", "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "contact_group_create_data" : { "additionalProperties" : false, "properties" : { "contact_ids" : { "default" : [], "description" : "Tablica identyfikatorów kontaktów należących do grupy. Kontakty w grupie muszą należeć do tego samego konta, co sama grupa", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 1000, "type" : "array", "uniqueItems" : true }, "description" : { "default" : "", "description" : "Nazwa grupy kontaktów", "maxLength" : 10000, "type" : "string" }, "name" : { "description" : "Nazwa grupy kontaktów", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "ID konta, do którego należy grupa kontaktów", "minimum" : 1, "type" : "integer" } }, "required" : [ "name" ], "type" : "object" }, "contact_group_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "contact_group_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "contact_group_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "contacts", "contacts.description", "contacts.id", "contacts.language_id", "contacts.name", "contacts.owner_id", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "contact_ids", "description", "id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/contact_group_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/contact_group_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "contact_group_sortable_field" : { "enum" : [ "description", "id", "name", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "contact_group_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/contact_group_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "contact_notification" : { "additionalProperties" : true, "properties" : { "account_id" : { "description" : "Identyfikator konta, w ramach którego zostało wysłane powiadomienie", "minimum" : 1, "type" : "integer" }, "address" : { "description" : "Adres (e-mail, nr telefonu itp.), na który zostało wysłane powiadomienie", "maxLength" : 512, "type" : "string" }, "address_id" : { "description" : "Identyfikator adresu, na który zostało wysłane powiadomienie", "minimum" : 1, "type" : "integer" }, "channel_id" : { "description" : "Identyfikator kanału powiadomień, przez który zostało wysłane powiadomienie", "type" : "string" }, "contact_id" : { "description" : "Identyfikator kontaktu, do którego zostało wysłane powiadomienie", "minimum" : 1, "type" : "integer" }, "content" : { "description" : "Treść powiadomienia", "type" : "string" }, "escalation_id" : { "description" : "Identyfikator eskalacji, w wyniku której zostało wysłane powiadomienie", "minimum" : 1, "type" : "integer" }, "event_id" : { "description" : "Identyfikator zdarzenia, którego dotyczy powiadomienie", "minimum" : 1, "type" : "integer" }, "id" : { "description" : "Identyfikator powiadomienia", "minimum" : 1, "type" : "integer" }, "service_id" : { "description" : "Identyfikator usługi, której dotyczy powiadomienie", "minimum" : 1, "type" : "integer" }, "subject" : { "description" : "Temat powiadomienia", "type" : "string" }, "time" : { "description" : "Czas wysłania powiadomienia", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "contact_permission" : { "additionalProperties" : true, "properties" : { "create_addresses" : { "description" : "Uprawnienia do tworzenia nowych adresów przypisanych do kontaktu", "type" : "boolean" }, "create_suspensions" : { "description" : "Uprawnienia do tworzenia nowych zawieszeń przypisanych do kontaktu", "type" : "boolean" }, "create_weekly_suspensions" : { "description" : "Uprawnienia do tworzenia nowych zawieszeń tygodniowych przypisanych do kontaktu", "type" : "boolean" }, "customize_templates" : { "description" : "Uprawnienia do przypisywania niestandardowych szablonów do kontaktu", "type" : "boolean" }, "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "contact_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/contact_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/contact_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "contact_sortable_field" : { "enum" : [ "description", "id", "language_id", "name", "owner.name", "owner.username", "owner_id", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "contact_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/contact_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "contact_suspension" : { "additionalProperties" : true, "properties" : { "contact_id" : { "description" : "Identyfikator kontaktu, do którego należy zawieszenie", "minimum" : 1, "type" : "integer" }, "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_time" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "id" : { "description" : "Identyfikator zawieszenia", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "contact_suspension_create_data" : { "additionalProperties" : false, "properties" : { "contact_id" : { "description" : "Identyfikator kontaktu, do którego należy zawieszenie", "minimum" : 1, "type" : "integer" }, "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_time" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "start_time" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "required" : [ "contact_id", "end_time" ], "type" : "object" }, "contact_suspension_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "contact_suspension_filters" : { "additionalProperties" : false, "properties" : { "contact.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "contact_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "end_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "contact_suspension_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "contact_id", "description", "end_time", "id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/contact_suspension_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/contact_suspension_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "contact_suspension_sortable_field" : { "enum" : [ "contact.name", "contact_id", "description", "end_time", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_time" ], "type" : "string" }, "contact_suspension_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/contact_suspension_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "contact_weekly_suspension" : { "additionalProperties" : true, "properties" : { "contact_id" : { "description" : "Identyfikator kontaktu, do którego należy zawieszenie", "minimum" : 1, "type" : "integer" }, "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "id" : { "description" : "Identyfikator tygodniowego zawieszenia", "minimum" : 1, "type" : "integer" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "type" : "object" }, "contact_weekly_suspension_create_data" : { "additionalProperties" : false, "properties" : { "contact_id" : { "description" : "Identyfikator kontaktu, do którego należy zawieszenie", "minimum" : 1, "type" : "integer" }, "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "required" : [ "contact_id", "end_minute", "start_minute" ], "type" : "object" }, "contact_weekly_suspension_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "contact_weekly_suspension_filters" : { "additionalProperties" : false, "properties" : { "contact.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "contact_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "contact_weekly_suspension_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "contact_id", "description", "end_minute", "id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/contact_weekly_suspension_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/contact_weekly_suspension_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "contact_weekly_suspension_sortable_field" : { "enum" : [ "contact.name", "contact_id", "description", "end_minute", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_minute" ], "type" : "string" }, "contact_weekly_suspension_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/contact_weekly_suspension_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "correction" : { "additionalProperties" : true, "properties" : { "created_at" : { "description" : "Czas utworzenia korekty", "format" : "dateTime", "type" : "string" }, "description" : { "description" : "Opis korekty", "maxLength" : 1000, "type" : "string" }, "end_time" : { "description" : "Koniec korygowanego przedziału czasowego", "format" : "dateTime", "type" : "string" }, "id" : { "description" : "Identyfikator korekty", "minimum" : 1, "type" : "integer" }, "service_id" : { "description" : "Identyfikator korygowanej usługi", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Początek korygowanego przedziału czasowego", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status usługi", "enum" : [ "ok", "failure", "paused" ], "type" : "string" } }, "type" : "object" }, "correction_bulk_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "description" : "Opis korekty", "maxLength" : 1000, "type" : "string" }, "end_time" : { "description" : "Koniec korygowanego przedziału czasowego", "format" : "dateTime", "type" : "string" }, "service_ids" : { "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 1000, "type" : "array" }, "start_time" : { "description" : "Początek korygowanego przedziału czasowego", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status usługi", "enum" : [ "ok", "failure", "paused" ], "type" : "string" } }, "required" : [ "service_ids", "end_time", "start_time", "status" ], "type" : "object" }, "correction_bulk_update_data" : { "properties" : { "description" : { "maxLength" : 1000, "type" : "string" }, "ids" : { "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 1000, "type" : "array" }, "status" : { "enum" : [ "ok", "failure", "paused" ], "type" : "string" } }, "required" : [ "ids" ], "type" : "object" }, "correction_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "description" : "Opis korekty", "maxLength" : 1000, "type" : "string" }, "end_time" : { "description" : "Koniec korygowanego przedziału czasowego", "format" : "dateTime", "type" : "string" }, "service_id" : { "description" : "Identyfikator korygowanej usługi", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Początek korygowanego przedziału czasowego", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status usługi", "enum" : [ "ok", "failure", "paused" ], "type" : "string" } }, "required" : [ "end_time", "service_id", "start_time", "status" ], "type" : "object" }, "correction_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "correction_filters" : { "additionalProperties" : false, "properties" : { "created_at" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "end_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.interval" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.is_active" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.is_archived" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "correction_intervals_create_type" : { "additionalProperties" : false, "properties" : { "description" : { "description" : "Opis korekty", "maxLength" : 1000, "type" : "string" }, "end_time" : { "description" : "Koniec korygowanego przedziału czasowego", "format" : "dateTime", "type" : "string" }, "start_time" : { "description" : "Początek korygowanego przedziału czasowego", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status usługi", "enum" : [ "ok", "failure", "paused" ], "type" : "string" } }, "required" : [ "end_time", "start_time", "status" ], "type" : "object" }, "correction_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "created_at", "description", "end_time", "id", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/correction_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/correction_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "correction_sortable_field" : { "enum" : [ "created_at", "description", "end_time", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start_time", "status" ], "type" : "string" }, "correction_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/correction_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "custom_template" : { "additionalProperties" : true, "properties" : { "channel_id" : { "description" : "Identyfikator kanału powiadomień", "type" : "string" }, "contact_id" : { "description" : "Identyfikator kontaktu", "minimum" : 1, "type" : "integer" }, "template_id" : { "description" : "Identyfikator szablonu powiadomień", "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "default_template" : { "additionalProperties" : true, "properties" : { "artifact_type_ids" : { "description" : "Identyfikatory typów artefaktów, które należy załączyć do powiadomień (dla kanałów, które wspierają załączniki)", "items" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "type" : "array" }, "channel_id" : { "description" : "Identyfikator kanału kontaktowego", "type" : "string" }, "end_subject" : { "default" : "Monit24 notification", "description" : "Szablon tematu powiadomienia o końcu zdarzenia (dla kanałów, które wspierają tematy powiadomień)", "maxLength" : 1000, "type" : "string" }, "end_template" : { "default" : "", "description" : "Szablon powiadomienia o końcu zdarzenia", "maxLength" : 10000, "type" : "string" }, "language_id" : { "default" : "pl", "description" : "Identyfikator domyślnego języka powiadomień (klucz w słowniku `languages`)", "type" : "string" }, "start_subject" : { "default" : "Monit24 notification", "description" : "Szablon tematu powiadomienia o początku zdarzenia (dla kanałów, które wspierają tematy powiadomień)", "maxLength" : 1000, "type" : "string" }, "start_template" : { "default" : "", "description" : "Szablon powiadomienia o początku zdarzenia", "maxLength" : 10000, "type" : "string" } }, "type" : "object" }, "default_template_filters" : { "additionalProperties" : false, "properties" : { "channel_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "end_subject" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "end_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "language_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start_subject" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "default_template_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "language", "language.description", "language.id", "language.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "artifact_type_ids", "channel_id", "end_subject", "end_template", "language_id", "start_subject", "start_template" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/default_template_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/default_template_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "default_template_sortable_field" : { "enum" : [ "channel_id", "end_subject", "end_template", "language_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_subject", "start_template" ], "type" : "string" }, "default_template_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/default_template_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "dns_diagnostic" : { "additionalProperties" : true, "properties" : { "id" : { "description" : "Identyfikator zapytania diagnostycznego", "maxLength" : 40, "minLength" : 40, "pattern" : "^[0-9a-f]*$", "type" : "string" }, "results" : { "description" : "Wyniki zapytania, dostępne kiedy `status` przyjmie wartość `completed`. Tekst zawierający wyjście programu dig na wybranej stacji monitorującej lub komunikat o błędzie", "nullable" : true, "type" : "string" }, "sensor_id" : { "description" : "Identyfikator stacji monitorującej, z której należy wykonać zapytanie", "minimum" : 1, "type" : "integer" }, "settings" : { "$ref" : "#/components/schemas/dns_diagnostics_settings" }, "status" : { "description" : "Status zapytania", "enum" : [ "pending", "in_progress", "completed" ], "type" : "string" } }, "type" : "object" }, "dns_diagnostic_create_data" : { "additionalProperties" : false, "properties" : { "sensor_id" : { "description" : "Identyfikator stacji monitorującej, z której należy wykonać zapytanie", "minimum" : 1, "type" : "integer" }, "settings" : { "$ref" : "#/components/schemas/dns_diagnostics_settings" } }, "required" : [ "sensor_id", "settings" ], "type" : "object" }, "dns_diagnostic_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "maxLength" : 40, "minLength" : 40, "pattern" : "^[0-9a-f]*$", "type" : "string" } }, "required" : [ "id" ], "type" : "object" }, "dns_diagnostics_settings" : { "additionalProperties" : false, "properties" : { "address" : { "description" : "Adres URL lub IP, o który należy zapytać serwer DNS", "maxLength" : 256, "minLength" : 1, "pattern" : "^[0-9a-zA-Z\\-\\.]*$", "type" : "string" }, "dns_server" : { "description" : "Adres IP serwera DNS, który należy zapytać", "pattern" : "^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$", "type" : "string" }, "record_type" : { "description" : "Typ rekordu DNS, o który należy zapytać", "enum" : [ "A", "MX", "TXT", "NS", "SOA", "AAAA", "CNAME", "PTR", "MBOXFW" ], "type" : "string" } }, "required" : [ "dns_server", "address", "record_type" ], "type" : "object" }, "error_type" : { "additionalProperties" : true, "properties" : { "category_ids" : { "default" : [], "description" : "Identyfikatory kategorii, do których należy typ błędu", "items" : { "type" : "string" }, "minItems" : 1, "type" : "array", "uniqueItems" : true }, "description" : { "description" : "Opis błędu", "maxLength" : 100000, "minLength" : 0, "type" : "string" }, "diagnosis" : { "description" : "Diagnoza błędu", "maxLength" : 100000, "minLength" : 0, "type" : "string" }, "extra_info" : { "description" : "Dodatkowe informacje o błędzie", "maxLength" : 100000, "minLength" : 0, "type" : "string" }, "id" : { "description" : "Kod błędu", "minimum" : 1, "type" : "integer" }, "name" : { "description" : "Nazwa błędu", "maxLength" : 255, "minLength" : 1, "type" : "string" } }, "type" : "object" }, "error_type_category" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "error_type_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "diagnosis" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "extra_info" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "error_type_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "categories", "categories.description", "categories.id", "categories.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "category_ids", "description", "diagnosis", "extra_info", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/error_type_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/error_type_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "error_type_sortable_field" : { "enum" : [ "description", "diagnosis", "extra_info", "id", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "error_type_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/error_type_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "escalation" : { "additionalProperties" : true, "properties" : { "contact_groups" : { "default" : [], "description" : "Tablica identyfikatorów grup kontaktów, które mają być powiadamiane, wraz z opcjonalnymi filtrami kanałów powiadomień", "items" : { "$ref" : "#/components/schemas/escalation_contact_group_assignment" }, "maxItems" : 1000, "type" : "array" }, "contacts" : { "default" : [], "description" : "Tablica identyfikatorów kontaktów, które mają być powiadamiane, wraz z opcjonalnymi filtrami kanałów powiadomień", "items" : { "$ref" : "#/components/schemas/escalation_contact_assignment" }, "maxItems" : 1000, "type" : "array" }, "description" : { "default" : "", "description" : "Opis eskalacji", "maxLength" : 10000, "type" : "string" }, "end_notifications_delay" : { "default" : 0, "description" : "Opóźnienie powiadomień o zakończeniu zdarzenia, w sekundach", "maximum" : 86400, "minimum" : 0, "type" : "integer" }, "event_id" : { "description" : "Identyfikator zdarzenia, o którym należy powiadamiać", "minimum" : 1, "type" : "integer" }, "id" : { "description" : "Identyfikator eskalacji", "minimum" : 1, "type" : "integer" }, "is_enabled" : { "default" : true, "description" : "Określa, czy eskalacja jest włączona", "type" : "boolean" }, "name" : { "default" : "", "description" : "Nazwa eskalacji", "maxLength" : 64, "type" : "string" }, "repeated_notifications_interval" : { "description" : "Odstęp pomiędzy powtórzonymi powiadomieniami o rozpoczęciu zdarzenia. Wartość NULL wyłącza powtarzanie powiadomień", "maximum" : 34560000, "minimum" : 60, "nullable" : true, "type" : "integer" }, "repeated_notifications_limit" : { "description" : "Liczba powtórzeń powiadomień o rozpoczęciu zdarzenia. Wartość NULL oznacza brak limitu (wysyłanie powiadomień do zakończenia zdarzenia)", "maximum" : 1000000000, "minimum" : 1, "nullable" : true, "type" : "integer" }, "start_notifications_delay" : { "default" : 0, "description" : "Opóźnienie powiadomień o rozpoczęciu zdarzenia, w sekundach", "maximum" : 86400, "minimum" : 0, "type" : "integer" } }, "type" : "object" }, "escalation_contact_assignment" : { "properties" : { "contact_id" : { "description" : "Identyfikator kontaktu", "minimum" : 1, "type" : "integer" }, "end_channel_ids" : { "description" : "Tablica identyfikatorów kanałów powiadomień, przez które kontakt ma być powiadamiany o końcu zdarzenia. NULL oznacza wszystkie kanały", "items" : { "type" : "string" }, "nullable" : true, "type" : "array", "uniqueItems" : true }, "start_channel_ids" : { "description" : "Tablica identyfikatorów kanałów powiadomień, przez które kontakt ma być powiadamiany o początku zdarzenia. NULL oznacza wszystkie kanały", "items" : { "type" : "string" }, "nullable" : true, "type" : "array", "uniqueItems" : true } }, "required" : [ "contact_id", "start_channel_ids", "end_channel_ids" ], "type" : "object" }, "escalation_contact_group_assignment" : { "properties" : { "contact_group_id" : { "description" : "Identyfikator grupy kontaktów", "minimum" : 1, "type" : "integer" }, "end_channel_ids" : { "description" : "Tablica identyfikatorów kanałów powiadomień, przez które kontakty w grupie mają być powiadamiane o końcu zdarzenia. NULL oznacza wszystkie kanały", "items" : { "type" : "string" }, "nullable" : true, "type" : "array", "uniqueItems" : true }, "start_channel_ids" : { "description" : "Tablica identyfikatorów kanałów powiadomień, przez które kontakty w grupie mają być powiadamiane o początku zdarzenia. NULL oznacza wszystkie kanały", "items" : { "type" : "string" }, "nullable" : true, "type" : "array", "uniqueItems" : true } }, "required" : [ "contact_group_id", "start_channel_ids", "end_channel_ids" ], "type" : "object" }, "escalation_create_data" : { "additionalProperties" : false, "properties" : { "contact_groups" : { "default" : [], "description" : "Tablica identyfikatorów grup kontaktów, które mają być powiadamiane, wraz z opcjonalnymi filtrami kanałów powiadomień", "items" : { "$ref" : "#/components/schemas/escalation_contact_group_assignment" }, "maxItems" : 1000, "type" : "array" }, "contacts" : { "default" : [], "description" : "Tablica identyfikatorów kontaktów, które mają być powiadamiane, wraz z opcjonalnymi filtrami kanałów powiadomień", "items" : { "$ref" : "#/components/schemas/escalation_contact_assignment" }, "maxItems" : 1000, "type" : "array" }, "description" : { "default" : "", "description" : "Opis eskalacji", "maxLength" : 10000, "type" : "string" }, "end_notifications_delay" : { "default" : 0, "description" : "Opóźnienie powiadomień o zakończeniu zdarzenia, w sekundach", "maximum" : 86400, "minimum" : 0, "type" : "integer" }, "event_id" : { "description" : "Identyfikator zdarzenia, o którym należy powiadamiać", "minimum" : 1, "type" : "integer" }, "is_enabled" : { "default" : true, "description" : "Określa, czy eskalacja jest włączona", "type" : "boolean" }, "name" : { "default" : "", "description" : "Nazwa eskalacji", "maxLength" : 64, "type" : "string" }, "repeated_notifications_interval" : { "description" : "Odstęp pomiędzy powtórzonymi powiadomieniami o rozpoczęciu zdarzenia. Wartość NULL wyłącza powtarzanie powiadomień", "maximum" : 34560000, "minimum" : 60, "nullable" : true, "type" : "integer" }, "repeated_notifications_limit" : { "description" : "Liczba powtórzeń powiadomień o rozpoczęciu zdarzenia. Wartość NULL oznacza brak limitu (wysyłanie powiadomień do zakończenia zdarzenia)", "maximum" : 1000000000, "minimum" : 1, "nullable" : true, "type" : "integer" }, "start_notifications_delay" : { "default" : 0, "description" : "Opóźnienie powiadomień o rozpoczęciu zdarzenia, w sekundach", "maximum" : 86400, "minimum" : 0, "type" : "integer" } }, "required" : [ "event_id" ], "type" : "object" }, "escalation_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "escalation_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "end_notifications_delay" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "event.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "event.owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "event_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_enabled" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_suspensions" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_weekly_suspensions" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "repeated_notifications_interval" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "repeated_notifications_limit" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start_notifications_delay" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "escalation_permission" : { "additionalProperties" : true, "properties" : { "create_suspensions" : { "description" : "Uprawnienia do tworzenia nowych zawieszeń eskalacji", "type" : "boolean" }, "create_weekly_suspensions" : { "description" : "Uprawnienia do tworzenia nowych zawieszeń tygodniowych eskalacji", "type" : "boolean" }, "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "escalation_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "contact_groups", "contacts", "description", "end_notifications_delay", "event_id", "id", "is_enabled", "name", "repeated_notifications_interval", "repeated_notifications_limit", "start_notifications_delay" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/escalation_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/escalation_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "escalation_sortable_field" : { "enum" : [ "description", "end_notifications_delay", "event.name", "event.owner_id", "event_id", "id", "is_enabled", "name", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "repeated_notifications_interval", "repeated_notifications_limit", "start_notifications_delay" ], "type" : "string" }, "escalation_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/escalation_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "escalation_status" : { "additionalProperties" : true, "properties" : { "escalation_id" : { "description" : "Identyfikator eskalacji", "minimum" : 1, "type" : "integer" }, "event_id" : { "description" : "Identyfikator zdarzenia", "minimum" : 1, "type" : "integer" }, "sent_notifications" : { "description" : "Liczba wysłanych powiadomień o aktualnym stanie zdarzenia", "minimum" : 0, "nullable" : true, "type" : "integer" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "summary" : { "description" : "Status powiadomień dla eskalacji", "enum" : [ "delayed", "notifying", "sent", "unknown" ], "type" : "string" }, "times_notified" : { "description" : "Liczba powiadamiań każdego z kontaktów o aktualnym stanie zdarzenia", "minimum" : 0, "nullable" : true, "type" : "integer" } }, "type" : "object" }, "escalation_status_filters" : { "additionalProperties" : false, "properties" : { "escalation.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "escalation_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "event_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "sent_notifications" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "summary" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "times_notified" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "escalation_status_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "escalation_id", "event_id", "sent_notifications", "service_id", "summary", "times_notified" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/escalation_status_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/escalation_status_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "escalation_status_sortable_field" : { "enum" : [ "escalation.name", "escalation_id", "event_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "sent_notifications", "service.name", "service_id", "summary", "times_notified" ], "type" : "string" }, "escalation_status_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/escalation_status_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "escalation_suspension" : { "additionalProperties" : true, "properties" : { "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_time" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "escalation_id" : { "description" : "Identyfikator eskalacji, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "id" : { "description" : "Identyfikator zawieszenia", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "escalation_suspension_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_time" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "escalation_id" : { "description" : "Identyfikator eskalacji, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "required" : [ "end_time", "escalation_id" ], "type" : "object" }, "escalation_suspension_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "escalation_suspension_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "end_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "escalation.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "escalation_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "escalation_suspension_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "description", "end_time", "escalation_id", "id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/escalation_suspension_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/escalation_suspension_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "escalation_suspension_sortable_field" : { "enum" : [ "description", "end_time", "escalation.name", "escalation_id", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_time" ], "type" : "string" }, "escalation_suspension_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/escalation_suspension_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "escalation_weekly_suspension" : { "additionalProperties" : true, "properties" : { "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "escalation_id" : { "description" : "Identyfikator eskalacji, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "id" : { "description" : "Identyfikator tygodniowego zawieszenia", "minimum" : 1, "type" : "integer" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "type" : "object" }, "escalation_weekly_suspension_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "escalation_id" : { "description" : "Identyfikator eskalacji, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "required" : [ "end_minute", "escalation_id", "start_minute" ], "type" : "object" }, "escalation_weekly_suspension_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "escalation_weekly_suspension_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "escalation.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "escalation_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "escalation_weekly_suspension_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "description", "end_minute", "escalation_id", "id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/escalation_weekly_suspension_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/escalation_weekly_suspension_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "escalation_weekly_suspension_sortable_field" : { "enum" : [ "description", "end_minute", "escalation.name", "escalation_id", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_minute" ], "type" : "string" }, "escalation_weekly_suspension_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/escalation_weekly_suspension_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "event" : { "additionalProperties" : true, "properties" : { "account_ids" : { "default" : [], "description" : "Tablica identyfikatorów kont, których dotyczy zdarzenie (wszystkich usług należących do wybranych kont)", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 100, "type" : "array" }, "description" : { "default" : "", "description" : "Opis zdarzenia", "maxLength" : 10000, "type" : "string" }, "disable_elements" : { "default" : false, "description" : "Wyłącza zdarzenie dla błędów wykrytych na elementach strony", "type" : "boolean" }, "disable_main_content" : { "default" : false, "description" : "Wyłącza zdarzenie dla błędów wykrytych na głównej zawartości (kodzie strony)", "type" : "boolean" }, "disable_steps" : { "default" : [], "description" : "Wyłącza zdarzenie dla błędów wykrytych na krokach o podanych numerach", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 1000, "type" : "array", "uniqueItems" : true }, "error_on_elements" : { "default" : false, "description" : "Włącza zdarzenie dla błędów wykrytych na elementach strony (nawet jeśli sprawdzenie nie zakończyło się błędem)", "type" : "boolean" }, "error_type_category_ids" : { "description" : "Identyfikatory kategorii typów błędów, które powodują zdarzenie. NULL oznacza wszystkie kategorie", "items" : { "type" : "string" }, "nullable" : true, "type" : "array", "uniqueItems" : true }, "excluded_error_type_category_ids" : { "default" : [], "description" : "Identyfikatory kategorii typów błędów, które nie powodują zdarzenia", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "group_ids" : { "default" : [], "description" : "Tablica identyfikatorów grup, których dotyczy zdarzenie (wszystkich usług w wybranych grupach)", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 100, "type" : "array" }, "id" : { "description" : "Identyfikator zdarzenia", "minimum" : 1, "type" : "integer" }, "is_persistent" : { "default" : false, "description" : "Określa, czy zdarzenie jest możliwe do wyłączenia jedynie ręcznie lub przez zatrzymanie usługi", "type" : "boolean" }, "maximum_sensors_percentage" : { "default" : 100, "description" : "Maksymalny dozwolony procent stacji, na których muszą zostać spełnione warunki, aby zdarzenie zaszło", "maximum" : 100, "minimum" : 1, "type" : "integer" }, "metrics" : { "default" : [], "description" : "Wartości metryk, dla których zdarzenie zachodzi (dowolny z warunków na metryki musi zostać spełniony)", "items" : { "additionalProperties" : false, "properties" : { "max_value" : { "description" : "Maksymalna wartość metryki, dla której zdarzenie zachodzi", "nullable" : true, "type" : "integer" }, "metric_id" : { "description" : "Identyfikator metryki", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "min_value" : { "description" : "Minimalna wartość metryki, dla której zdarzenie zachodzi", "nullable" : true, "type" : "integer" } }, "required" : [ "metric_id" ], "type" : "object" }, "maxItems" : 16, "type" : "array" }, "minimum_response_time" : { "description" : "Czas odpowiedzi usługi w milisekundach, powyżej którego zdarzenie zachodzi. NULL oznacza brak warunku na czas odpowiedzi", "maximum" : 1000000, "minimum" : 0, "nullable" : true, "type" : "integer" }, "name" : { "description" : "Nazwa zdarzenia", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "Identyfikator konta, do którego należy zdarzenie", "minimum" : 1, "type" : "integer" }, "priority" : { "default" : 3, "description" : "Poziom istotności zdarzenia. 1 oznacza najwyższy poziom, 4 - najniższy", "maximum" : 4, "minimum" : 1, "type" : "integer" }, "required_event_ids" : { "default" : [], "description" : "Tablica identyfikatorów zdarzeń, które muszą zajść, aby zdarzenie wystąpiło", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 100, "type" : "array" }, "sensors_percentage" : { "description" : "Procent stacji, na których muszą zostać spełnione warunki, aby zdarzenie zaszło. NULL oznacza taki sam procent, jak w ustawieniu `error_tolerance` usługi", "maximum" : 100, "minimum" : 1, "nullable" : true, "type" : "integer" }, "service_ids" : { "default" : [], "description" : "Tablica identyfikatorów usług, których dotyczy zdarzenie", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 100, "type" : "array" }, "unknown_check_results" : { "default" : "ignore", "description" : "Sposób obsługi nieznanych wyników sprawdzeń: ignorowanie (domyślne), sprzyjające zdarzeniu lub wykluczające zdarzenie", "enum" : [ "ignore", "include", "exclude" ], "type" : "string" } }, "type" : "object" }, "event_availability_time_range" : { "properties" : { "from" : { "description" : "Początek przedziału czasowego, dla którego są dostępne dane o dostępności dla usługi i zdarzenia lub NULL jeśli żadne dane nie są jeszcze dostępne", "format" : "dateTime", "nullable" : true, "type" : "string" }, "to" : { "description" : "Koniec przedziału czasowego, dla którego są dostępne dane o dostępności dla usługi i zdarzenia lub NULL jeśli żadne dane nie są jeszcze dostępne", "format" : "dateTime", "nullable" : true, "type" : "string" } }, "required" : [ "from", "to" ], "type" : "object" }, "event_create_data" : { "additionalProperties" : false, "properties" : { "account_ids" : { "default" : [], "description" : "Tablica identyfikatorów kont, których dotyczy zdarzenie (wszystkich usług należących do wybranych kont)", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 100, "type" : "array" }, "description" : { "default" : "", "description" : "Opis zdarzenia", "maxLength" : 10000, "type" : "string" }, "disable_elements" : { "default" : false, "description" : "Wyłącza zdarzenie dla błędów wykrytych na elementach strony", "type" : "boolean" }, "disable_main_content" : { "default" : false, "description" : "Wyłącza zdarzenie dla błędów wykrytych na głównej zawartości (kodzie strony)", "type" : "boolean" }, "disable_steps" : { "default" : [], "description" : "Wyłącza zdarzenie dla błędów wykrytych na krokach o podanych numerach", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 1000, "type" : "array", "uniqueItems" : true }, "error_on_elements" : { "default" : false, "description" : "Włącza zdarzenie dla błędów wykrytych na elementach strony (nawet jeśli sprawdzenie nie zakończyło się błędem)", "type" : "boolean" }, "error_type_category_ids" : { "description" : "Identyfikatory kategorii typów błędów, które powodują zdarzenie. NULL oznacza wszystkie kategorie", "items" : { "type" : "string" }, "nullable" : true, "type" : "array", "uniqueItems" : true }, "excluded_error_type_category_ids" : { "default" : [], "description" : "Identyfikatory kategorii typów błędów, które nie powodują zdarzenia", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "group_ids" : { "default" : [], "description" : "Tablica identyfikatorów grup, których dotyczy zdarzenie (wszystkich usług w wybranych grupach)", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 100, "type" : "array" }, "is_persistent" : { "default" : false, "description" : "Określa, czy zdarzenie jest możliwe do wyłączenia jedynie ręcznie lub przez zatrzymanie usługi", "type" : "boolean" }, "maximum_sensors_percentage" : { "default" : 100, "description" : "Maksymalny dozwolony procent stacji, na których muszą zostać spełnione warunki, aby zdarzenie zaszło", "maximum" : 100, "minimum" : 1, "type" : "integer" }, "metrics" : { "default" : [], "description" : "Wartości metryk, dla których zdarzenie zachodzi (dowolny z warunków na metryki musi zostać spełniony)", "items" : { "additionalProperties" : false, "properties" : { "max_value" : { "description" : "Maksymalna wartość metryki, dla której zdarzenie zachodzi", "nullable" : true, "type" : "integer" }, "metric_id" : { "description" : "Identyfikator metryki", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "min_value" : { "description" : "Minimalna wartość metryki, dla której zdarzenie zachodzi", "nullable" : true, "type" : "integer" } }, "required" : [ "metric_id" ], "type" : "object" }, "maxItems" : 16, "type" : "array" }, "minimum_response_time" : { "description" : "Czas odpowiedzi usługi w milisekundach, powyżej którego zdarzenie zachodzi. NULL oznacza brak warunku na czas odpowiedzi", "maximum" : 1000000, "minimum" : 0, "nullable" : true, "type" : "integer" }, "name" : { "description" : "Nazwa zdarzenia", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "Identyfikator konta, do którego należy zdarzenie", "minimum" : 1, "type" : "integer" }, "priority" : { "default" : 3, "description" : "Poziom istotności zdarzenia. 1 oznacza najwyższy poziom, 4 - najniższy", "maximum" : 4, "minimum" : 1, "type" : "integer" }, "required_event_ids" : { "default" : [], "description" : "Tablica identyfikatorów zdarzeń, które muszą zajść, aby zdarzenie wystąpiło", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 100, "type" : "array" }, "sensors_percentage" : { "description" : "Procent stacji, na których muszą zostać spełnione warunki, aby zdarzenie zaszło. NULL oznacza taki sam procent, jak w ustawieniu `error_tolerance` usługi", "maximum" : 100, "minimum" : 1, "nullable" : true, "type" : "integer" }, "service_ids" : { "default" : [], "description" : "Tablica identyfikatorów usług, których dotyczy zdarzenie", "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 100, "type" : "array" }, "unknown_check_results" : { "default" : "ignore", "description" : "Sposób obsługi nieznanych wyników sprawdzeń: ignorowanie (domyślne), sprzyjające zdarzeniu lub wykluczające zdarzenie", "enum" : [ "ignore", "include", "exclude" ], "type" : "string" } }, "required" : [ "name" ], "type" : "object" }, "event_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "event_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "disable_elements" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "disable_main_content" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "error_on_elements" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_persistent" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "maximum_sensors_percentage" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "minimum_response_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_escalations" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "priority" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "sensors_percentage" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "unknown_check_results" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "event_permission" : { "additionalProperties" : true, "properties" : { "create_escalations" : { "description" : "Uprawnienia do tworzenia nowych eskalacji powiadamiających o zdarzeniu", "type" : "boolean" }, "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "event_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "error_type_categories", "error_type_categories.description", "error_type_categories.id", "error_type_categories.name", "excluded_error_type_categories", "excluded_error_type_categories.description", "excluded_error_type_categories.id", "excluded_error_type_categories.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "required_events", "required_events.account_ids", "required_events.description", "required_events.disable_elements", "required_events.disable_main_content", "required_events.disable_steps", "required_events.error_on_elements", "required_events.error_type_category_ids", "required_events.excluded_error_type_category_ids", "required_events.group_ids", "required_events.id", "required_events.is_persistent", "required_events.maximum_sensors_percentage", "required_events.metrics", "required_events.minimum_response_time", "required_events.name", "required_events.owner_id", "required_events.priority", "required_events.required_event_ids", "required_events.sensors_percentage", "required_events.service_ids", "required_events.unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "account_ids", "description", "disable_elements", "disable_main_content", "disable_steps", "error_on_elements", "error_type_category_ids", "excluded_error_type_category_ids", "group_ids", "id", "is_persistent", "maximum_sensors_percentage", "metrics", "minimum_response_time", "name", "owner_id", "priority", "required_event_ids", "sensors_percentage", "service_ids", "unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/event_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/event_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "event_service_level_data" : { "properties" : { "active" : { "description" : "Liczba sekund z wybranego przedziału w których zdarzenie zachodziło dla usługi", "minimum" : 0, "type" : "integer" }, "inactive" : { "description" : "Liczba sekund z wybranego przedziału w których zdarzenie nie zachodziło dla usługi", "minimum" : 0, "type" : "integer" }, "unknown" : { "description" : "Liczba sekund z wybranego przedziału w których monitoring zdarzenia był wyłączony dla usługi", "minimum" : 0, "type" : "integer" } }, "type" : "object" }, "event_service_level_interval" : { "properties" : { "active" : { "description" : "Procent czasu, kiedy zdarzenie zachodziło dla usługi w danym przedziale czasowym", "maximum" : 100, "minimum" : 0, "type" : "number" }, "active_seconds" : { "description" : "Liczba sekund, w których zdarzenie zachodziło dla usługi w danym przedziale czasowym", "minimum" : 0, "type" : "integer" }, "from" : { "description" : "Początek przedziału czasowego", "format" : "dateTime", "type" : "string" }, "inactive" : { "description" : "Procent czasu, kiedy zdarzenie nie zachodziło dla usługi w danym przedziale czasowym", "maximum" : 100, "minimum" : 0, "type" : "number" }, "inactive_seconds" : { "description" : "Liczba sekund, w których zdarzenie nie zachodziło dla usługi w danym przedziale czasowym", "minimum" : 0, "type" : "integer" }, "to" : { "description" : "Koniec przedziału czasowego", "format" : "dateTime", "type" : "string" }, "unknown" : { "description" : "Procent czasu, kiedy zdarzenie nie było monitorowane dla usługi w danym przedziale czasowym", "maximum" : 100, "minimum" : 0, "type" : "number" }, "unknown_seconds" : { "description" : "Liczba sekund, w których zdarzenie nie było monitorowane dla usługi w danym przedziale czasowym", "minimum" : 0, "type" : "integer" } }, "required" : [ "from", "to", "inactive", "active", "unknown", "inactive_seconds", "active_seconds", "unknown_seconds" ], "type" : "object" }, "event_sortable_field" : { "enum" : [ "description", "disable_elements", "disable_main_content", "error_on_elements", "id", "is_persistent", "maximum_sensors_percentage", "minimum_response_time", "name", "owner.name", "owner.username", "owner_id", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "priority", "sensors_percentage", "unknown_check_results" ], "type" : "string" }, "event_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/event_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "event_status" : { "additionalProperties" : true, "properties" : { "event_id" : { "description" : "Identyfikator zdarzenia", "minimum" : 1, "type" : "integer" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "summary" : { "description" : "Status zdarzenia dla usługi", "enum" : [ "active", "inactive", "unknown" ], "type" : "string" }, "time" : { "description" : "Czas rozpoczęcia lub zakończenia aktualnego statusu zdarzenia. NULL dla statusów `unknown`", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "event_status_change" : { "additionalProperties" : true, "properties" : { "change_id" : { "description" : "Identyfikator zmiany stanu zdarzenia", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "duration" : { "description" : "Aktualna długość przedziału czasowego, w którym zdarzenie miało dany stan dla usługi (w sekundach)", "minimum" : 0, "type" : "integer" }, "end_time" : { "description" : "Koniec przedziału czasowego, w którym zdarzenie miało określony stan dla usługi (pierwsza sekunda nie należąca do przedziału - przedział prawostronnie otwarty) lub NULL jeśli zdarzenie wciąż przebywa w tym stanie", "format" : "dateTime", "type" : "string" }, "event_id" : { "description" : "Identyfikator zdarzenia", "minimum" : 1, "type" : "integer" }, "first_analysis_id" : { "description" : "Identyfikator pierwszej analizy działania usługi, który spowodował zmianę stanu zdarzenia (dla zmian typu `active` lub `inactive`)", "maxLength" : 15, "minLength" : 15, "nullable" : true, "pattern" : "^[0-9]*$", "type" : "string" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Początek przedziału czasowego, w którym zdarzenie miało określony stan dla usługi", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status zdarzenia dla usługi", "enum" : [ "active", "inactive", "unknown" ], "type" : "string" } }, "type" : "object" }, "event_status_change_log" : { "additionalProperties" : true, "properties" : { "change_id" : { "description" : "Identyfikator zmiany stanu zdarzenia", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "duration" : { "description" : "Aktualna długość przedziału czasowego, w którym zdarzenie miało dany stan dla usługi (w sekundach)", "minimum" : 0, "type" : "integer" }, "end_time" : { "description" : "Koniec przedziału czasowego, w którym zdarzenie miało określony stan dla usługi (pierwsza sekunda nie należąca do przedziału - przedział prawostronnie otwarty) lub NULL jeśli zdarzenie wciąż przebywa w tym stanie", "format" : "dateTime", "type" : "string" }, "event_id" : { "description" : "Identyfikator zdarzenia", "minimum" : 1, "type" : "integer" }, "first_analysis_id" : { "description" : "Identyfikator pierwszej analizy działania usługi, który spowodował zmianę stanu zdarzenia (dla zmian typu `active` lub `inactive`)", "maxLength" : 15, "minLength" : 15, "nullable" : true, "pattern" : "^[0-9]*$", "type" : "string" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Początek przedziału czasowego, w którym zdarzenie miało określony stan dla usługi", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status zdarzenia dla usługi", "enum" : [ "active", "inactive", "unknown" ], "type" : "string" } }, "type" : "object" }, "event_status_filters" : { "additionalProperties" : false, "properties" : { "event.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "event.priority" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "event_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.disable" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "summary" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "event_status_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.delete", "permissions.disable", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "event_id", "service_id", "summary", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/event_status_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/event_status_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "event_status_sortable_field" : { "enum" : [ "event.name", "event.priority", "event_id", "permissions.delete", "permissions.disable", "permissions.own", "permissions.read", "permissions.update", "service.name", "service_id", "summary", "time" ], "type" : "string" }, "event_status_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/event_status_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "extended_setting_format" : { "additionalProperties" : true, "properties" : { "default" : { "anyOf" : [ { "type" : "boolean" }, { "type" : "integer" }, { "type" : "number" }, { "type" : "string" } ], "description" : "Domyślna wartość ustawienia", "nullable" : true }, "description" : { "description" : "Opis zaawansowanego ustawienia", "type" : "string" }, "enum" : { "description" : "Lista dozwolonych wartości (dla ustawień typu `string`)", "items" : { "type" : "string" }, "nullable" : true, "type" : "array" }, "is_hidden" : { "description" : "Określa, czy ustawienie jest dostępne jedynie dla administratorów", "type" : "boolean" }, "is_nullable" : { "description" : "Określa, czy wartość ustawienia może przyjąć wartość NULL", "type" : "boolean" }, "json_schema" : { "description" : "Schemat wartości tekstowej w formacie JSON", "nullable" : true, "type" : "object" }, "maximum" : { "description" : "Maksymalna dopuszczalna wartość (dla ustawień typu `number` oraz `integer`)", "nullable" : true, "type" : "number" }, "maximum_length" : { "description" : "Maksymalna dopuszczalna długość tekstu (dla ustawień typu `string` lub `regex`)", "nullable" : true, "type" : "integer" }, "minimum" : { "description" : "Minimalna dopuszczalna wartość (dla ustawień typu `number` oraz `integer`)", "nullable" : true, "type" : "number" }, "minimum_length" : { "description" : "Minimalna dopuszczalna długość tekstu (dla ustawień typu `string` lub `regex`)", "nullable" : true, "type" : "integer" }, "pattern" : { "description" : "Wyrażenie regularne, do którego musi pasować wartość", "nullable" : true, "type" : "string" }, "pattern_error_message" : { "description" : "Niestandardowy komunikat błędu w przypadku niespełnienia dopasowania warunku określonego przez pole `pattern` lub `json_schema`", "minLength" : 8, "nullable" : true, "type" : "string" }, "service_type_id" : { "description" : "Identyfikator typu usługi", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "setting_id" : { "description" : "Identyfikator zaawansowanego ustawienia", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "suggested_form_element" : { "description" : "Sugerowany element formularza, w przypadku automatycznego generowania interfejsu edycji ustawień", "enum" : [ "text", "checkbox", "regex", "percent", "textarea", "select", "url_patterns" ], "type" : "string" }, "type" : { "description" : "Typ dopuszczalnych wartości ustawienia. Jeśli pole `is_nullable` ma wartość `true`, ustawienie może oprócz wartości tego typu przyjąć wartość NULL", "enum" : [ "string", "integer", "number", "boolean", "regex", "url_patterns" ], "type" : "string" } }, "type" : "object" }, "extended_settings" : { "additionalProperties" : { "anyOf" : [ { "type" : "boolean" }, { "type" : "integer" }, { "type" : "number" }, { "type" : "string" } ], "nullable" : true }, "type" : "object" }, "filter" : { "additionalProperties" : false, "properties" : { "type" : { "$ref" : "#/components/schemas/filter_type" }, "value" : { "$ref" : "#/components/schemas/filter_value" } }, "required" : [ "value" ], "type" : "object" }, "filter_type" : { "default" : "equal", "enum" : [ "equal", "not_equal", "match", "in", "not_in" ], "type" : "string" }, "filter_value" : { "anyOf" : [ { "items" : { "$ref" : "#/components/schemas/simple_type" }, "maxItems" : 1024, "type" : "array" }, { "type" : "boolean" }, { "type" : "number" }, { "type" : "string" } ] }, "group" : { "additionalProperties" : true, "properties" : { "archived_services_in_periodic_reports" : { "default" : true, "description" : "Określa, czy w raportach okresowych dla grupy uwzględniać usługi archiwalne", "type" : "boolean" }, "assigned_sensor_ids" : { "$ref" : "#/components/schemas/assigned_sensor_ids" }, "id" : { "description" : "Identyfikator grupy", "minimum" : 1, "type" : "integer" }, "is_default" : { "default" : false, "description" : "Określa, czy grupa jest grupą domyślną dla konta", "type" : "boolean" }, "name" : { "description" : "Nazwa grupy", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "ID konta, do którego należy grupa", "minimum" : 1, "type" : "integer" }, "periodic_daily_reports" : { "default" : true, "description" : "Określa, czy dla grupy są włączone raporty dzienne", "type" : "boolean" }, "periodic_monthly_reports" : { "default" : true, "description" : "Określa, czy dla grupy są włączone raporty miesięczne", "type" : "boolean" }, "periodic_weekly_reports" : { "default" : true, "description" : "Określa, czy dla grupy są włączone raporty tygodniowe", "type" : "boolean" }, "sensor_ids" : { "description" : "Tablica identyfikatorów stacji monitorujących przypisanych do grupy.\n\nUWAGA: To pole zostanie usunięte w jednej z nadchodzących wersji API. Zamiast niego należy używać bardziej ogólnego pola `assigned_sensor_ids`", "items" : { "minimum" : 1, "type" : "integer" }, "minItems" : 1, "type" : "array", "uniqueItems" : true } }, "type" : "object" }, "group_create_data" : { "additionalProperties" : false, "properties" : { "archived_services_in_periodic_reports" : { "default" : true, "description" : "Określa, czy w raportach okresowych dla grupy uwzględniać usługi archiwalne", "type" : "boolean" }, "assigned_sensor_ids" : { "$ref" : "#/components/schemas/assigned_sensor_ids" }, "name" : { "description" : "Nazwa grupy", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "ID konta, do którego należy grupa", "minimum" : 1, "type" : "integer" }, "periodic_daily_reports" : { "default" : true, "description" : "Określa, czy dla grupy są włączone raporty dzienne", "type" : "boolean" }, "periodic_monthly_reports" : { "default" : true, "description" : "Określa, czy dla grupy są włączone raporty miesięczne", "type" : "boolean" }, "periodic_weekly_reports" : { "default" : true, "description" : "Określa, czy dla grupy są włączone raporty tygodniowe", "type" : "boolean" }, "sensor_ids" : { "description" : "Tablica identyfikatorów stacji monitorujących przypisanych do grupy.\n\nUWAGA: To pole zostanie usunięte w jednej z nadchodzących wersji API. Zamiast niego należy używać bardziej ogólnego pola `assigned_sensor_ids`", "items" : { "minimum" : 1, "type" : "integer" }, "minItems" : 1, "type" : "array", "uniqueItems" : true } }, "required" : [ "name" ], "type" : "object" }, "group_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "group_filters" : { "additionalProperties" : false, "properties" : { "archived_services_in_periodic_reports" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_default" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "periodic_daily_reports" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "periodic_monthly_reports" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "periodic_weekly_reports" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_notification_addresses" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_periodic_report_addresses" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_services" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.send_test_sms_notifications" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.share" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "group_permission" : { "additionalProperties" : true, "properties" : { "create_notification_addresses" : { "description" : "Uprawnienia do tworzenia adresów powiadomień w grupie", "type" : "boolean" }, "create_periodic_report_addresses" : { "description" : "Uprawnienia do tworzenia adresów raportów w grupie", "type" : "boolean" }, "create_services" : { "description" : "Uprawnienia do tworzenia nowych usług w grupie", "type" : "boolean" }, "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "send_test_sms_notifications" : { "description" : "Uprawnienia do wysyłania testowych powiadomień SMS na numery telefonu przypisane do grupy", "type" : "boolean" }, "share" : { "description" : "Uprawnienia do udostępniania grupy innym użytkownikom", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "group_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "stats", "stats.id", "stats.sensors_count", "stats.services_count", "stats.services_count_archived", "stats.services_count_failure", "stats.services_count_ok", "stats.services_count_paused", "stats.services_count_suspended", "stats.services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "assigned_sensor_ids", "id", "is_default", "name", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "sensor_ids" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/group_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/group_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "group_share" : { "additionalProperties" : true, "properties" : { "account_id" : { "description" : "Identyfikator konta, któremu grupa jest udostępniona", "minimum" : 1, "type" : "integer" }, "can_archive_services" : { "default" : false, "description" : "Określa, czy użytkownik może archiwizować i przywracać usługi w grupie", "type" : "boolean" }, "can_create_services" : { "default" : false, "description" : "Określa, czy użytkownik może tworzyć nowe usługi w grupie", "type" : "boolean" }, "can_delete_services" : { "default" : false, "description" : "Określa, czy użytkownik może usuwać usługi z grupy", "type" : "boolean" }, "can_force_analyses" : { "default" : false, "description" : "Określa, czy użytkownik może wymuszać analizy usługi w grupie", "type" : "boolean" }, "can_modify_group" : { "default" : false, "description" : "Określa, czy użytkownik może modyfikować ustawienia grupy, w tym adresy powiadomień i raportów", "type" : "boolean" }, "can_modify_services" : { "default" : false, "description" : "Określa, czy użytkownik może modyfikować usługi w grupie", "type" : "boolean" }, "group_id" : { "description" : "Identyfikator grupy udostępnionej", "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "group_sortable_field" : { "enum" : [ "archived_services_in_periodic_reports", "id", "is_default", "name", "owner.name", "owner.username", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "stats.sensors_count", "stats.services_count" ], "type" : "string" }, "group_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/group_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "group_stat" : { "additionalProperties" : true, "properties" : { "id" : { "description" : "Identyfikator grupy", "minimum" : 1, "type" : "integer" }, "sensors_count" : { "description" : "Liczba stacji monitorujących przypisanych do grupy dla kategorii `default`", "minimum" : 0, "type" : "integer" }, "services_count" : { "description" : "Liczba usług w grupie, z wyłączeniem usług archiwalnych", "minimum" : 0, "type" : "integer" }, "services_count_archived" : { "description" : "Liczba archiwalnych usług w grupie", "minimum" : 0, "type" : "integer" }, "services_count_failure" : { "description" : "Liczba usług w grupie w stanie awarii", "minimum" : 0, "type" : "integer" }, "services_count_ok" : { "description" : "Liczba poprawnie działających usług w grupie", "minimum" : 0, "type" : "integer" }, "services_count_paused" : { "description" : "Liczba usług w grupie, których monitoring jest zatrzymany, z wyłączeniem usług archiwalnych", "minimum" : 0, "type" : "integer" }, "services_count_suspended" : { "description" : "Liczba usług w grupie, których monitoring jest zawieszony", "minimum" : 0, "type" : "integer" }, "services_count_unknown" : { "description" : "Liczba usług w grupie, których status jest nieznany", "minimum" : 0, "type" : "integer" } }, "type" : "object" }, "group_stat_filters" : { "additionalProperties" : false, "properties" : { "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "group_stat_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "id", "sensors_count", "services_count", "services_count_archived", "services_count_failure", "services_count_ok", "services_count_paused", "services_count_suspended", "services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/group_stat_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/group_stat_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "group_stat_sortable_field" : { "enum" : [ "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "sensors_count", "services_count", "services_count_archived", "services_count_failure", "services_count_ok", "services_count_paused", "services_count_suspended", "services_count_unknown" ], "type" : "string" }, "group_stat_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/group_stat_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "groups_scope" : { "properties" : { "all" : { "type" : "boolean" }, "by_id" : { "$ref" : "#/components/schemas/array_of_ids" }, "by_owner_id" : { "$ref" : "#/components/schemas/array_of_ids" } }, "type" : "object" }, "language" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "metric_type" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "metric_value" : { "properties" : { "id" : { "description" : "Identyfikator metryki", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "value" : { "description" : "Wartość metryki", "minimum" : 0, "type" : "integer" } }, "required" : [ "id", "value" ], "type" : "object" }, "minute_of_week" : { "properties" : { "day_of_week" : { "description" : "Dzień tygodnia. 1 oznacza poniedziałek, 7 niedzielę", "maximum" : 7, "minimum" : 1, "type" : "integer" }, "hour" : { "description" : "Godzina doby - liczba pomiędzy 0 a 23", "maximum" : 23, "minimum" : 0, "type" : "integer" }, "minute" : { "description" : "Minuta w godzinie - liczba pomiędzy 0 a 59", "maximum" : 59, "minimum" : 0, "type" : "integer" } }, "required" : [ "day_of_week", "hour", "minute" ], "type" : "object" }, "monthly_account_usage_stat" : { "additionalProperties" : false, "properties" : { "account_id" : { "description" : "Identyfikator konta", "minimum" : 1, "type" : "integer" }, "count" : { "description" : "Licznik zużycia zasobów dla konta w wybranym miesiącu. Sprawdzenia FullPage i FullPageHttps są zliczane jako 5, pozostałe jako 1. Wysłane powiadomienia SMS są zliczane jako 350", "minimum" : 0, "type" : "integer" }, "username" : { "description" : "Login właściciela konta", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "required" : [ "account_id", "username", "count" ], "type" : "object" }, "monthly_group_usage_stat" : { "additionalProperties" : false, "properties" : { "account_id" : { "description" : "Identyfikator konta, do którego należy grupa", "minimum" : 1, "type" : "integer" }, "count" : { "description" : "Licznik zużycia zasobów dla grupy w wybranym miesiącu. Sprawdzenia FullPage i FullPageHttps są zliczane jako 5, pozostałe jako 1. Wysłane powiadomienia SMS nie są zliczane", "minimum" : 0, "type" : "integer" }, "group_id" : { "description" : "Identyfikator grupy", "minimum" : 1, "type" : "integer" }, "username" : { "description" : "Login właściciela konta", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "required" : [ "account_id", "username", "count", "group_id" ], "type" : "object" }, "notification" : { "additionalProperties" : true, "properties" : { "account_id" : { "description" : "Identyfikator konta, w ramach którego zostało wysłane powiadomienie", "minimum" : 1, "type" : "integer" }, "address" : { "description" : "Adres (e-mail, nr telefonu itp.), na który zostało wysłane powiadomienie", "maxLength" : 512, "type" : "string" }, "content" : { "description" : "Treść powiadomienia", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator powiadomienia", "minimum" : 1, "type" : "integer" }, "notification_channel_id" : { "description" : "Identyfikator kanału powiadomień przez który zostało wysłane powiadomienie", "type" : "string" }, "subject" : { "description" : "Temat powiadomienia (dla powiadomień e-mail)", "nullable" : true, "type" : "string" }, "time" : { "description" : "Czas wysłania powiadomienia", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "notification_address" : { "additionalProperties" : true, "properties" : { "address" : { "description" : "Adres powiadomień (w zależności od typu adresu może być to np. e-mail, Jabber ID lub numer telefonu)", "maxLength" : 512, "type" : "string" }, "description" : { "default" : "", "description" : "Opcjonalny opis adresu", "maxLength" : 1024, "type" : "string" }, "group_id" : { "description" : "ID grupy, do której jest przypisany adres", "minimum" : 1, "type" : "integer" }, "id" : { "description" : "Identyfikator adresu powiadomień", "minimum" : 1, "type" : "integer" }, "notification_channel_id" : { "description" : "Identyfikator kanału powiadomień", "type" : "string" }, "owner_id" : { "description" : "ID konta, do którego należy adres", "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "notification_address_create_data" : { "additionalProperties" : false, "properties" : { "address" : { "description" : "Adres powiadomień (w zależności od typu adresu może być to np. e-mail, Jabber ID lub numer telefonu)", "maxLength" : 512, "type" : "string" }, "description" : { "default" : "", "description" : "Opcjonalny opis adresu", "maxLength" : 1024, "type" : "string" }, "group_id" : { "description" : "ID grupy, do której jest przypisany adres", "minimum" : 1, "type" : "integer" }, "notification_channel_id" : { "description" : "Identyfikator kanału powiadomień", "type" : "string" }, "owner_id" : { "description" : "ID konta, do którego należy adres", "minimum" : 1, "type" : "integer" } }, "required" : [ "address", "notification_channel_id" ], "type" : "object" }, "notification_address_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "notification_address_filters" : { "additionalProperties" : false, "properties" : { "address" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "group.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "group_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "notification_channel_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.send_test_sms_notifications" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "notification_address_permission" : { "additionalProperties" : true, "properties" : { "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "send_test_sms_notifications" : { "description" : "Uprawnienia do wysyłania testowych powiadomień SMS na adres", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "notification_address_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "notification_channel", "notification_channel.description", "notification_channel.id", "notification_channel.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "address", "description", "group_id", "id", "notification_channel_id", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/notification_address_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/notification_address_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "notification_address_sortable_field" : { "enum" : [ "address", "description", "group.name", "group_id", "id", "notification_channel_id", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update" ], "type" : "string" }, "notification_address_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/notification_address_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "notification_channel" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "notification_condition" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "notification_mode" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "package" : { "additionalProperties" : true, "properties" : { "available_notification_channel_ids" : { "default" : [ "alerta", "email", "email_dedicated", "email_extended", "email_short", "email_simplified", "gadu_gadu", "hipchat", "jabber", "json_post", "ms_teams", "ms_teams_extended", "pagerduty", "push", "rocketchat", "signal", "slack", "sms", "telephone" ], "description" : "Identyfikatory kanałów powiadomień dostępnych w pakiecie", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "available_service_types" : { "description" : "Dostępne typy usług, razem z ewentualnymi ograniczeniami dla poszczególnych typów", "items" : { "$ref" : "#/components/schemas/package_service_type_limit" }, "type" : "array" }, "can_force_custom_analyses" : { "default" : false, "description" : "Określa, czy konta z tym pakietem mają uprawnienia do wymuszania niestandardowych analiz usług", "type" : "boolean" }, "id" : { "description" : "Identyfikator pakietu", "minimum" : 1, "type" : "integer" }, "is_available_for_new_accounts" : { "description" : "Określa, czy pakiet jest dostępny dla rejestracji nowych kont", "type" : "boolean" }, "maximum_sensors" : { "description" : "Liczba stacji monitorujących, z których usługi mogą być monitorowane jednocześnie", "maximum" : 1000, "minimum" : 1, "type" : "integer" }, "maximum_services" : { "description" : "Liczba usług dostępna w pakiecie", "maximum" : 100000, "minimum" : 0, "type" : "integer" }, "maximum_sms_numbers" : { "description" : "Maksymalna liczba numerów powiadomień SMS zdefiniowanych dla grupy", "maximum" : 1000, "minimum" : 0, "nullable" : true, "type" : "integer" }, "minimum_interval" : { "description" : "Minimalny odstęp pomiędzy sprawdzeniami usług, w sekundach", "maximum" : 86400, "minimum" : 10, "type" : "integer" }, "monthly_reports_limit" : { "description" : "Miesięczny limit wygenerowanych raportów", "maximum" : 1000, "minimum" : 0, "nullable" : true, "type" : "integer" }, "name" : { "description" : "Nazwa pakietu", "maxLength" : 40, "minLength" : 1, "type" : "string" } }, "type" : "object" }, "package_filters" : { "additionalProperties" : false, "properties" : { "can_force_custom_analyses" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_available_for_new_accounts" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "maximum_sensors" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "maximum_services" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "maximum_sms_numbers" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "minimum_interval" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "monthly_reports_limit" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "package_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "available_notification_channels", "available_notification_channels.description", "available_notification_channels.id", "available_notification_channels.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "available_notification_channel_ids", "available_service_types", "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/package_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/package_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "package_service_type_limit" : { "properties" : { "maximum_services" : { "maximum" : 100000, "minimum" : 0, "nullable" : true, "type" : "integer" }, "minimum_interval" : { "maximum" : 86400, "minimum" : 10, "nullable" : true, "type" : "integer" }, "service_type_id" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" } }, "required" : [ "service_type_id", "maximum_services", "minimum_interval" ], "type" : "object" }, "package_sortable_field" : { "enum" : [ "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "package_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/package_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "password_reset_confirmation" : { "additionalProperties" : false, "properties" : { "account_id" : { "description" : "Identyfikator konta, z adresu URL w wiadomości e-mail", "minimum" : 1, "type" : "integer" }, "password" : { "description" : "Nowe hasło do konta", "maxLength" : 1024, "minLength" : 6, "type" : "string" }, "token" : { "description" : "Token autoryzacyjny, z adresu URL w wiadomości e-mail", "maxLength" : 64, "minLength" : 64, "pattern" : "^[0-9a-f]*$", "type" : "string" } }, "required" : [ "password", "token", "account_id" ], "type" : "object" }, "password_reset_request" : { "additionalProperties" : false, "properties" : { "identifier" : { "description" : "Login do konta lub adres e-mail podany przy rejestracji konta", "minLength" : 1, "type" : "string" }, "url" : { "description" : "Bazowy adres URL do formularza resetu hasła. Na jego podstawie zostanie wygenerowany link z parametrami `token` i `account_id`", "maxLength" : 1024, "pattern" : "^https?:\\/\\/[^\\/]", "type" : "string" } }, "required" : [ "identifier", "url" ], "type" : "object" }, "password_update_data" : { "additionalProperties" : false, "properties" : { "new_password" : { "maxLength" : 1024, "minLength" : 6, "type" : "string" }, "old_password" : { "type" : "string" } }, "required" : [ "new_password" ], "type" : "object" }, "performance_chart_point" : { "properties" : { "a" : { "description" : "Identyfikator analizy lub NULL jeśli punkt zawiera agregację danych z wielu analiz", "maxLength" : 15, "minLength" : 15, "nullable" : true, "pattern" : "^[0-9]*$", "type" : "string" }, "t" : { "description" : "Data i czas sprawdzenia (odcięta na wykresie)", "format" : "dateTime", "type" : "string" }, "v" : { "description" : "Czas odpowiedzi w milisekundach (rzędna na wykresie)", "minimum" : 0, "type" : "integer" } }, "required" : [ "t", "v", "a" ], "type" : "object" }, "performance_chart_series" : { "properties" : { "path_step" : { "description" : "Numer kroku w scenariuszu, lub NULL jeśli seria nie dotyczy pojedynczego kroku", "minimum" : 1, "nullable" : true, "type" : "integer" }, "points" : { "$ref" : "#/components/schemas/array_of_performance_chart_points" }, "sensor_id" : { "description" : "Identyfikator stacji monitorującej lub NULL jeśli seria nie dotyczy pojedynczej stacji", "minimum" : 1, "nullable" : true, "type" : "integer" }, "series_id" : { "description" : "Identyfikator serii punktów", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" } }, "required" : [ "series_id", "points" ], "type" : "object" }, "performance_time_range" : { "properties" : { "from" : { "description" : "Początek przedziału czasowego, dla którego są dostępne dane o szybkości działania usługi", "format" : "dateTime", "nullable" : true, "type" : "string" }, "to" : { "description" : "Koniec przedziału czasowego, dla którego są dostępne dane o szybkości działania usługi", "format" : "dateTime", "nullable" : true, "type" : "string" } }, "required" : [ "from", "to" ], "type" : "object" }, "periodic_report_address" : { "additionalProperties" : true, "properties" : { "address" : { "description" : "Adres e-mail, na który należy wysyłać raporty okresowe", "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "group_id" : { "description" : "ID grupy, do której jest przypisany adres", "minimum" : 1, "type" : "integer" }, "id" : { "description" : "Identyfikator adresu raportów okresowych", "minimum" : 1, "type" : "integer" }, "owner_id" : { "description" : "ID konta, do którego należy adres", "minimum" : 1, "type" : "integer" }, "report_frequency" : { "description" : "Częstotliwość wysyłania raportów", "enum" : [ "daily", "monthly", "weekly" ], "type" : "string" } }, "type" : "object" }, "periodic_report_address_create_data" : { "additionalProperties" : false, "properties" : { "address" : { "description" : "Adres e-mail, na który należy wysyłać raporty okresowe", "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "group_id" : { "description" : "ID grupy, do której jest przypisany adres", "minimum" : 1, "type" : "integer" }, "owner_id" : { "description" : "ID konta, do którego należy adres", "minimum" : 1, "type" : "integer" }, "report_frequency" : { "description" : "Częstotliwość wysyłania raportów", "enum" : [ "daily", "monthly", "weekly" ], "type" : "string" } }, "required" : [ "address", "report_frequency" ], "type" : "object" }, "periodic_report_address_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "periodic_report_address_filters" : { "additionalProperties" : false, "properties" : { "address" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "group_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "report_frequency" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "periodic_report_address_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "report_frequency" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/periodic_report_address_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/periodic_report_address_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "periodic_report_address_sortable_field" : { "enum" : [ "address", "group_id", "id", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "report_frequency" ], "type" : "string" }, "periodic_report_address_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/periodic_report_address_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "permission" : { "additionalProperties" : true, "properties" : { "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "recovery_notification_mode" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "report" : { "additionalProperties" : true, "properties" : { "account_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić informacje o kontach. Wartość \"auto\" oznacza włączenie tylko w przypadku, gdy usługi w raporcie należą do więcej niż jednego konta", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "archived_services" : { "default" : true, "description" : "Określa, czy w raporcie uwzględnić usługi archiwalne", "type" : "boolean" }, "attachment_type_ids" : { "default" : [], "description" : "Identyfikatory załączników do raportu", "items" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "maxItems" : 32, "type" : "array" }, "context_data" : { "default" : false, "description" : "Określa, czy w sekcjach tygodniowych i miesięcznych uwzględnić kontekst historyczny", "type" : "boolean" }, "created_at" : { "description" : "Czas zlecenia wygenerowania raportu", "format" : "dateTime", "type" : "string" }, "delay" : { "default" : 300, "description" : "Opóźnienie generowania raportu względem końca przedziału czasowego, którego dotyczy", "maximum" : 1000000, "minimum" : 300, "type" : "integer" }, "description" : { "description" : "Opis raportu", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "email_addresses" : { "description" : "Adresy e-mail, na które należy wysłać raport po wygenerowaniu", "items" : { "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "type" : "array", "uniqueItems" : true }, "email_subject_template" : { "default" : "", "description" : "Szablon tytułu wiadomości e-mail z raportem", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "email_template" : { "default" : "", "description" : "Szablon wiadomości e-mail z raportem", "maxLength" : 10000, "nullable" : true, "type" : "string" }, "file_name" : { "description" : "Sugerowana nazwa pliku z raportem (bez rozszerzenia), używana w przypadku wysyłki raportu pocztą elektroniczną", "maxLength" : 255, "minLength" : 1, "pattern" : "^[A-Za-z0-9_\\-]*$", "type" : "string" }, "file_name_template" : { "default" : "", "description" : "Szablon nazwy pliku z raportem (bez rozszerzenia)", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "from" : { "description" : "Początek przedziału czasowego, którego dotyczy raport", "format" : "dateTime", "type" : "string" }, "generate_pdf" : { "default" : true, "description" : "Określa, czy generować plik PDF z raportem", "type" : "boolean" }, "generated_at" : { "description" : "Czas wygenerowania raportu", "format" : "dateTime", "type" : "string" }, "generated_attachment_ids" : { "default" : [], "description" : "Identyfikatory wygenerowanych załączników", "items" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "maxItems" : 32, "type" : "array" }, "generating_progress" : { "description" : "Procentowy postęp generowania raportu JSON", "maximum" : 100, "minimum" : 0, "type" : "number" }, "generating_status" : { "description" : "Status generowania raportu JSON", "enum" : [ "pending", "in_progress", "completed" ], "type" : "string" }, "group_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić informacje o grupach. Wartość \"auto\" oznacza włączenie tylko w przypadku, gdy usługi w raporcie należą do więcej niż jednej grupy", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "id" : { "description" : "Identyfikator raportu", "minimum" : 1, "type" : "integer" }, "owner_id" : { "description" : "Identyfikator konta, do którego należy raport", "minimum" : 1, "type" : "integer" }, "progress" : { "description" : "Procentowy postęp przetwarzania (generowania i renderowania) raportu", "maximum" : 100, "minimum" : 0, "type" : "number" }, "rendering_progress" : { "description" : "Procentowy postęp generowania raportu PDF", "maximum" : 100, "minimum" : 0, "type" : "number" }, "rendering_status" : { "description" : "Status generowania raportu PDF", "enum" : [ "pending", "in_progress", "completed" ], "type" : "string" }, "reporting_plan_id" : { "description" : "Identyfikator planu generowania raportów, zgodnie z którym raport został wygenerowany", "nullable" : true, "type" : "string" }, "requested_scope" : { "$ref" : "#/components/schemas/scope_request" }, "section_ids" : { "default" : [ "service_level_summary", "analyses_summary", "checks_summary", "errors_by_type", "status_changes_by_duration", "performance_summary" ], "description" : "Sekcje raportu", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "service_level_events" : { "default" : { "accounts" : [], "default" : null, "groups" : [], "services" : [] }, "description" : "Modyfikacje sposobu obliczania SL przez zdarzenia", "properties" : { "accounts" : { "default" : [], "description" : "Domyślne zdarzenia dla kont", "items" : { "properties" : { "account_id" : { "minimum" : 1, "type" : "integer" }, "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "default" : { "description" : "Domyślne zdarzenie", "minimum" : 1, "nullable" : true, "type" : "integer" }, "groups" : { "default" : [], "description" : "Domyślne zdarzenia dla grup", "items" : { "properties" : { "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" }, "group_id" : { "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "services" : { "default" : [], "description" : "Zdarzenia dla usług", "items" : { "properties" : { "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" }, "service_id" : { "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "type" : "array" } }, "required" : [ "default", "accounts", "groups", "services" ], "type" : "object" }, "status" : { "description" : "Sumaryczny status przetwarzania raportu", "enum" : [ "pending", "in_progress", "completed" ], "type" : "string" }, "summary" : { "default" : "enabled", "description" : "Sposób obsługi podsumowania raportu: włączone (domyślnie), wyłączone lub tylko podsumowanie", "enum" : [ "disabled", "enabled", "only" ], "type" : "string" }, "template_id" : { "description" : "Identyfikator szablonu, na podstawie którego raport został utworzony", "minimum" : 1, "type" : "integer" }, "title" : { "description" : "Tytuł raportu", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "to" : { "description" : "Koniec przedziału czasowego, którego dotyczy raport", "format" : "dateTime", "type" : "string" }, "weekly_suspensions" : { "default" : [], "description" : "Lista tygodniowych zawieszeń (przedziałów, z których dane nie będą uwzględniane w raporcie)", "items" : { "additionalProperties" : false, "properties" : { "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "required" : [ "start_minute", "end_minute" ], "type" : "object" }, "maxItems" : 1000, "type" : "array" } }, "type" : "object" }, "report_analyses" : { "properties" : { "failure" : { "description" : "Liczba awaryjnych analiz", "minimum" : 0, "type" : "integer" }, "ok" : { "description" : "Liczba poprawnych analiz", "minimum" : 0, "type" : "integer" } }, "required" : [ "ok", "failure" ], "type" : "object" }, "report_attachment" : { "additionalProperties" : true, "properties" : { "content_type" : { "description" : "Typ MIME załącznika", "type" : "string" }, "file_name" : { "description" : "Nazwa pliku z załącznikiem", "type" : "string" }, "report_id" : { "description" : "Identyfikator raportu", "minimum" : 1, "type" : "integer" }, "type_id" : { "description" : "Identyfikator typu załącznika", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" } }, "type" : "object" }, "report_attachment_type" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "report_change_duration_interval" : { "properties" : { "from" : { "description" : "Początek przedziału czasu trwania zmiany stanu", "minimum" : 0, "type" : "integer" }, "to" : { "description" : "Koniec przedziału czasu trwania zmiany stanu", "minimum" : 0, "nullable" : true, "type" : "integer" } }, "required" : [ "from", "to" ], "type" : "object" }, "report_checks" : { "properties" : { "error" : { "description" : "Liczba błędnych sprawdzeń", "minimum" : 0, "type" : "integer" }, "ok" : { "description" : "Liczba poprawnych sprawdzeń", "minimum" : 0, "type" : "integer" }, "unknown" : { "description" : "Liczba nieznanych sprawdzeń", "minimum" : 0, "type" : "integer" } }, "required" : [ "ok", "error", "unknown" ], "type" : "object" }, "report_checks_by_sensor" : { "properties" : { "checks" : { "$ref" : "#/components/schemas/report_checks" }, "sensor" : { "$ref" : "#/components/schemas/report_sensor" } }, "required" : [ "checks", "sensor" ], "type" : "object" }, "report_create_data" : { "additionalProperties" : false, "properties" : { "account_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić informacje o kontach. Wartość \"auto\" oznacza włączenie tylko w przypadku, gdy usługi w raporcie należą do więcej niż jednego konta", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "archived_services" : { "default" : true, "description" : "Określa, czy w raporcie uwzględnić usługi archiwalne", "type" : "boolean" }, "attachment_type_ids" : { "default" : [], "description" : "Identyfikatory załączników do raportu", "items" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "maxItems" : 32, "type" : "array" }, "context_data" : { "default" : false, "description" : "Określa, czy w sekcjach tygodniowych i miesięcznych uwzględnić kontekst historyczny", "type" : "boolean" }, "delay" : { "default" : 300, "description" : "Opóźnienie generowania raportu względem końca przedziału czasowego, którego dotyczy", "maximum" : 1000000, "minimum" : 300, "type" : "integer" }, "description" : { "description" : "Opis raportu", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "email_addresses" : { "description" : "Adresy e-mail, na które należy wysłać raport po wygenerowaniu", "items" : { "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "type" : "array", "uniqueItems" : true }, "email_subject_template" : { "default" : "", "description" : "Szablon tytułu wiadomości e-mail z raportem", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "email_template" : { "default" : "", "description" : "Szablon wiadomości e-mail z raportem", "maxLength" : 10000, "nullable" : true, "type" : "string" }, "file_name_template" : { "default" : "", "description" : "Szablon nazwy pliku z raportem (bez rozszerzenia)", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "from" : { "description" : "Początek przedziału czasowego, którego dotyczy raport", "format" : "dateTime", "type" : "string" }, "generate_pdf" : { "default" : true, "description" : "Określa, czy generować plik PDF z raportem", "type" : "boolean" }, "group_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić informacje o grupach. Wartość \"auto\" oznacza włączenie tylko w przypadku, gdy usługi w raporcie należą do więcej niż jednej grupy", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "requested_scope" : { "$ref" : "#/components/schemas/scope_request" }, "section_ids" : { "default" : [ "service_level_summary", "analyses_summary", "checks_summary", "errors_by_type", "status_changes_by_duration", "performance_summary" ], "description" : "Sekcje raportu", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "service_level_events" : { "default" : { "accounts" : [], "default" : null, "groups" : [], "services" : [] }, "description" : "Modyfikacje sposobu obliczania SL przez zdarzenia", "properties" : { "accounts" : { "default" : [], "description" : "Domyślne zdarzenia dla kont", "items" : { "properties" : { "account_id" : { "minimum" : 1, "type" : "integer" }, "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "default" : { "description" : "Domyślne zdarzenie", "minimum" : 1, "nullable" : true, "type" : "integer" }, "groups" : { "default" : [], "description" : "Domyślne zdarzenia dla grup", "items" : { "properties" : { "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" }, "group_id" : { "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "services" : { "default" : [], "description" : "Zdarzenia dla usług", "items" : { "properties" : { "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" }, "service_id" : { "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "type" : "array" } }, "required" : [ "default", "accounts", "groups", "services" ], "type" : "object" }, "summary" : { "default" : "enabled", "description" : "Sposób obsługi podsumowania raportu: włączone (domyślnie), wyłączone lub tylko podsumowanie", "enum" : [ "disabled", "enabled", "only" ], "type" : "string" }, "template_id" : { "description" : "Identyfikator szablonu, na podstawie którego raport został utworzony", "minimum" : 1, "type" : "integer" }, "title" : { "description" : "Tytuł raportu", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "to" : { "description" : "Koniec przedziału czasowego, którego dotyczy raport", "format" : "dateTime", "type" : "string" }, "weekly_suspensions" : { "default" : [], "description" : "Lista tygodniowych zawieszeń (przedziałów, z których dane nie będą uwzględniane w raporcie)", "items" : { "additionalProperties" : false, "properties" : { "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "required" : [ "start_minute", "end_minute" ], "type" : "object" }, "maxItems" : 1000, "type" : "array" } }, "required" : [ "from", "template_id", "to" ], "type" : "object" }, "report_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "report_data" : { "properties" : { "account_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić inforacje o koncie", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "archived_services" : { "description" : "Określa, czy raport obejmuje usługi archiwalne", "type" : "boolean" }, "context_data" : { "default" : false, "description" : "Określa, czy raport zawiera dane kontekstowe", "type" : "boolean" }, "description" : { "description" : "Opis raportu", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "email_subject_template" : { "default" : "", "description" : "Szablon tematu wiadomości e-mail z raportem", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "email_template" : { "default" : "", "description" : "Szablon wiadomości e-mail z raportem", "maxLength" : 10000, "nullable" : true, "type" : "string" }, "file_name_template" : { "default" : "", "description" : "Szablon nazwy pliku z raportem (bez rozszerzenia pdf)", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "from" : { "description" : "Początek przedziału czasowego, którego dotyczy raport", "format" : "dateTime", "type" : "string" }, "generated_at" : { "description" : "Data wygenerowania raportu", "format" : "dateTime", "type" : "string" }, "group_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić informacje o grupie", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "id" : { "description" : "Identyfikator raportu", "minimum" : 1, "type" : "integer" }, "language" : { "$ref" : "#/components/schemas/language" }, "owner" : { "$ref" : "#/components/schemas/report_owner" }, "reporting_plan" : { "$ref" : "#/components/schemas/reporting_plan" }, "results" : { "$ref" : "#/components/schemas/array_of_report_results" }, "sections" : { "$ref" : "#/components/schemas/array_of_report_sections" }, "summary" : { "default" : "enabled", "description" : "Sposób obsługi podsumowania raportu", "enum" : [ "disabled", "enabled", "only" ], "type" : "string" }, "time_zone" : { "$ref" : "#/components/schemas/time_zone" }, "title" : { "description" : "Tytuł raportu", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "to" : { "description" : "Koniec przedziału czasowego, którego dotyczy raport", "format" : "dateTime", "type" : "string" }, "version" : { "description" : "Wersja formatu raportu", "minimum" : 0, "type" : "integer" }, "weekly_suspensions" : { "default" : [], "description" : "Użyty harmonogram zawieszeń tygodniowych dla danych w raporcie", "items" : { "additionalProperties" : false, "properties" : { "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "required" : [ "start_minute", "end_minute" ], "type" : "object" }, "maxItems" : 1000, "type" : "array" } }, "required" : [ "version", "id", "title", "description", "time_zone", "to", "from", "results", "owner", "generated_at", "weekly_suspensions", "file_name_template", "email_subject_template", "email_template", "group_info", "account_info", "context_data" ], "type" : "object" }, "report_error_type" : { "properties" : { "id" : { "description" : "Identyfikator typu błędu", "minimum" : 1, "type" : "integer" }, "name" : { "description" : "Nazwa typu błędu", "maxLength" : 255, "minLength" : 1, "type" : "string" } }, "required" : [ "id", "name" ], "type" : "object" }, "report_errors_by_path_step" : { "properties" : { "errors" : { "minimum" : 0, "type" : "integer" }, "step" : { "$ref" : "#/components/schemas/report_path_step" } }, "required" : [ "errors", "step" ], "type" : "object" }, "report_errors_by_type" : { "properties" : { "error_type" : { "$ref" : "#/components/schemas/report_error_type" }, "errors" : { "minimum" : 0, "type" : "integer" } }, "required" : [ "errors", "error_type" ], "type" : "object" }, "report_filters" : { "additionalProperties" : false, "properties" : { "account_info" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "archived_services" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "context_data" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "delay" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "email_subject_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "email_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "file_name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "file_name_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "generate_pdf" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "generating_progress" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "generating_status" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "group_info" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "progress" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "rendering_progress" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "rendering_status" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "reporting_plan.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "reporting_plan_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "summary" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "template.title" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "template_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "title" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "report_owner" : { "properties" : { "id" : { "description" : "Identyfikator konta", "minimum" : 1, "type" : "integer" }, "name" : { "description" : "Nazwa konta", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "username" : { "description" : "Login użytkownika", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "required" : [ "id", "name", "username" ], "type" : "object" }, "report_path_step" : { "properties" : { "name" : { "description" : "Nazwa kroku", "type" : "string" }, "number" : { "description" : "Numer kroku scenariusza, począwszy od 1", "minimum" : 1, "type" : "integer" } }, "required" : [ "number", "name" ], "type" : "object" }, "report_performance" : { "properties" : { "cnt" : { "description" : "Liczba wykonanych sprawdzeń", "minimum" : 0, "type" : "integer" }, "max" : { "description" : "Czas nawolniejszego działania, w milisekundach", "minimum" : 0, "nullable" : true, "type" : "integer" }, "min" : { "description" : "Czas najszybszego działania, w milisekundach", "minimum" : 0, "nullable" : true, "type" : "integer" }, "sum" : { "description" : "Suma czasów działania ze wszystkich sprawdzeń (dzieląc ją przez `cnt` - o ile nie jest zerem - można obliczyć średni czas odpowiedzi)", "minimum" : 0, "type" : "integer" } }, "required" : [ "min", "max", "cnt", "sum" ], "type" : "object" }, "report_performance_by_path_step" : { "properties" : { "performance" : { "$ref" : "#/components/schemas/report_performance" }, "step" : { "$ref" : "#/components/schemas/report_path_step" } }, "required" : [ "performance", "step" ], "type" : "object" }, "report_performance_by_sensor" : { "properties" : { "performance" : { "$ref" : "#/components/schemas/report_performance" }, "sensor" : { "$ref" : "#/components/schemas/report_sensor" } }, "required" : [ "performance", "sensor" ], "type" : "object" }, "report_result" : { "properties" : { "__extra" : { "additionalProperties" : true, "type" : "object" }, "analyses_by_hour" : { "$ref" : "#/components/schemas/array_of_report_analyses_by_hour" }, "analyses_by_month" : { "$ref" : "#/components/schemas/array_of_report_analyses_by_month" }, "analyses_by_month_day" : { "$ref" : "#/components/schemas/array_of_report_analyses_by_month_day" }, "analyses_by_week_day" : { "$ref" : "#/components/schemas/array_of_report_analyses_by_week_day" }, "analyses_summary" : { "$ref" : "#/components/schemas/report_analyses" }, "checks_by_hour" : { "$ref" : "#/components/schemas/array_of_report_checks_by_hour" }, "checks_by_month" : { "$ref" : "#/components/schemas/array_of_report_checks_by_month" }, "checks_by_month_day" : { "$ref" : "#/components/schemas/array_of_report_checks_by_month_day" }, "checks_by_sensor" : { "$ref" : "#/components/schemas/array_of_report_checks_by_sensor" }, "checks_by_week_day" : { "$ref" : "#/components/schemas/array_of_report_checks_by_week_day" }, "checks_summary" : { "$ref" : "#/components/schemas/report_checks" }, "errors_by_path_step" : { "$ref" : "#/components/schemas/array_of_report_errors_by_path_step" }, "errors_by_type" : { "$ref" : "#/components/schemas/array_of_report_errors_by_type" }, "performance_by_hour" : { "$ref" : "#/components/schemas/array_of_report_performance_by_hour" }, "performance_by_month" : { "$ref" : "#/components/schemas/array_of_report_performance_by_month" }, "performance_by_month_day" : { "$ref" : "#/components/schemas/array_of_report_performance_by_month_day" }, "performance_by_path_step" : { "$ref" : "#/components/schemas/array_of_report_performance_by_path_step" }, "performance_by_sensor" : { "$ref" : "#/components/schemas/array_of_report_performance_by_sensor" }, "performance_by_week_day" : { "$ref" : "#/components/schemas/array_of_report_performance_by_week_day" }, "performance_summary" : { "$ref" : "#/components/schemas/report_performance" }, "scope" : { "$ref" : "#/components/schemas/report_scope" }, "service_level_by_hour" : { "$ref" : "#/components/schemas/array_of_report_service_level_by_hour" }, "service_level_by_month" : { "$ref" : "#/components/schemas/array_of_report_service_level_by_month" }, "service_level_by_month_day" : { "$ref" : "#/components/schemas/array_of_report_service_level_by_month_day" }, "service_level_by_week_day" : { "$ref" : "#/components/schemas/array_of_report_service_level_by_week_day" }, "service_level_summary" : { "$ref" : "#/components/schemas/report_service_level" }, "status_changes_by_duration" : { "$ref" : "#/components/schemas/array_of_report_status_changes_by_duration" }, "status_changes_by_hour" : { "$ref" : "#/components/schemas/array_of_report_status_changes_by_hour" }, "status_changes_by_month" : { "$ref" : "#/components/schemas/array_of_report_status_changes_by_month" }, "status_changes_by_month_day" : { "$ref" : "#/components/schemas/array_of_report_status_changes_by_month_day" }, "status_changes_by_week_day" : { "$ref" : "#/components/schemas/array_of_report_status_changes_by_week_day" }, "status_changes_summary" : { "$ref" : "#/components/schemas/report_status_changes" } }, "required" : [ "scope" ], "type" : "object" }, "report_scope" : { "properties" : { "account" : { "$ref" : "#/components/schemas/report_scope_account" }, "events" : { "$ref" : "#/components/schemas/report_scope_events" }, "group" : { "$ref" : "#/components/schemas/report_scope_group" }, "service" : { "$ref" : "#/components/schemas/report_scope_service" }, "type" : { "enum" : [ "service", "group", "account", "summary" ], "type" : "string" } }, "required" : [ "type", "service", "group", "account" ], "type" : "object" }, "report_scope_account" : { "properties" : { "id" : { "description" : "Identyfikator konta", "minimum" : 1, "type" : "integer" }, "name" : { "description" : "Nazwa konta", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "username" : { "description" : "Login użytkownika", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "required" : [ "id", "name", "username" ], "type" : "object" }, "report_scope_event" : { "properties" : { "id" : { "description" : "Identyfikator zdarzenia", "minimum" : 1, "type" : "integer" }, "name" : { "description" : "Nazwa zdarzenia", "maxLength" : 64, "minLength" : 1, "type" : "string" } }, "required" : [ "id", "name" ], "type" : "object" }, "report_scope_events" : { "description" : "Tablica zdarzeń użytych do obliczania Service Level; NULL oznacza, że użyto standardowego SL.", "items" : { "$ref" : "#/components/schemas/report_scope_event" }, "type" : "array" }, "report_scope_group" : { "properties" : { "id" : { "description" : "Identyfikator grupy", "minimum" : 1, "type" : "integer" }, "name" : { "description" : "Nazwa grupy", "maxLength" : 60, "minLength" : 1, "type" : "string" } }, "required" : [ "id", "name" ], "type" : "object" }, "report_scope_service" : { "properties" : { "description" : { "description" : "Opis usługi", "maxLength" : 10000, "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "name" : { "description" : "Nazwa usługi", "maxLength" : 60, "minLength" : 1, "type" : "string" }, "type" : { "$ref" : "#/components/schemas/report_scope_service_type" } }, "required" : [ "id", "name", "description", "type" ], "type" : "object" }, "report_scope_service_type" : { "properties" : { "id" : { "description" : "Identyfikator typu usługi", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa typu usługi", "maxLength" : 255, "minLength" : 1, "type" : "string" } }, "required" : [ "id", "name" ], "type" : "object" }, "report_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "generated_attachments", "generated_attachments.content_type", "generated_attachments.file_name", "generated_attachments.report_id", "generated_attachments.type_id", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plan", "reporting_plan.description", "reporting_plan.id", "reporting_plan.name", "sections", "sections.description", "sections.id", "sections.name", "template", "template.account_info", "template.archived_services", "template.attachment_type_ids", "template.context_data", "template.delay", "template.description", "template.email_addresses", "template.email_subject_template", "template.email_template", "template.file_name_template", "template.generate_pdf", "template.group_info", "template.id", "template.owner_id", "template.reporting_plan_ids", "template.requested_scope", "template.section_ids", "template.service_level_events", "template.summary", "template.title", "template.weekly_suspensions", "token", "token.report_id", "token.session_id", "token.suggested_file_name", "token.token" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "created_at", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name", "file_name_template", "from", "generate_pdf", "generated_at", "generated_attachment_ids", "generating_progress", "generating_status", "group_info", "id", "owner_id", "progress", "rendering_progress", "rendering_status", "reporting_plan_id", "requested_scope", "section_ids", "service_level_events", "status", "summary", "template_id", "title", "to", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/report_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/report_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "report_section" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "report_sensor" : { "properties" : { "id" : { "description" : "Identyfikator stacji monitorującej", "minimum" : 1, "type" : "integer" }, "name" : { "description" : "Nazwa stacji monitorującej", "maxLength" : 128, "minLength" : 1, "type" : "string" } }, "required" : [ "id", "name" ], "type" : "object" }, "report_service_level" : { "properties" : { "context_data" : { "default" : false, "description" : "Jeśli true, dane są kontekstowe. Tylko w raportach kontekstowych", "type" : "boolean" }, "failure" : { "description" : "Sumaryczna liczba sekund awarii", "minimum" : 0, "type" : "integer" }, "label" : { "description" : "Opcjonalny numer dnia tygodnia lub miesiąca. Tylko w raportach kontekstowych", "type" : "string" }, "ok" : { "description" : "Sumaryczna liczba sekund poprawnego działania", "minimum" : 0, "type" : "integer" }, "paused" : { "description" : "Sumaryczna liczba sekund pauzy", "minimum" : 0, "type" : "integer" } }, "required" : [ "ok", "failure", "paused" ], "type" : "object" }, "report_sortable_field" : { "enum" : [ "account_info", "archived_services", "context_data", "created_at", "delay", "description", "email_subject_template", "email_template", "file_name", "file_name_template", "from", "generate_pdf", "generated_at", "generating_progress", "generating_status", "group_info", "id", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "progress", "rendering_progress", "rendering_status", "reporting_plan.name", "reporting_plan_id", "status", "summary", "template.title", "template_id", "title", "to" ], "type" : "string" }, "report_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/report_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "report_status_changes" : { "properties" : { "failure" : { "description" : "Liczba zmian stanów na awarię", "minimum" : 0, "type" : "integer" }, "ok" : { "description" : "Liczba zmian stanów na poprawne działanie", "minimum" : 0, "type" : "integer" }, "paused" : { "description" : "Liczba zmian stanów na pauzę", "minimum" : 0, "type" : "integer" } }, "required" : [ "ok", "failure", "paused" ], "type" : "object" }, "report_status_changes_by_duration" : { "properties" : { "duration" : { "$ref" : "#/components/schemas/report_change_duration_interval" }, "status_changes" : { "$ref" : "#/components/schemas/report_status_changes" } }, "required" : [ "status_changes", "duration" ], "type" : "object" }, "report_template" : { "additionalProperties" : true, "properties" : { "account_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić informacje o kontach. Wartość \"auto\" oznacza włączenie tylko w przypadku, gdy usługi w raporcie należą do więcej niż jednego konta", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "archived_services" : { "default" : true, "description" : "Określa, czy w raporcie uwzględnić usługi archiwalne", "type" : "boolean" }, "attachment_type_ids" : { "default" : [], "description" : "Identyfikatory załączników do raportu", "items" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "maxItems" : 32, "type" : "array" }, "context_data" : { "default" : false, "description" : "Określa, czy w sekcjach tygodniowych i miesięcznych uwzględnić kontekst historyczny", "type" : "boolean" }, "delay" : { "default" : 300, "description" : "Opóźnienie generowania raportu względem końca przedziału czasowego, którego dotyczy", "maximum" : 1000000, "minimum" : 300, "type" : "integer" }, "description" : { "description" : "Opis raportu", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "email_addresses" : { "description" : "Adresy e-mail, na które należy wysłać raport po wygenerowaniu", "items" : { "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "type" : "array", "uniqueItems" : true }, "email_subject_template" : { "default" : "", "description" : "Szablon tytułu wiadomości e-mail z raportem", "maxLength" : 1024, "type" : "string" }, "email_template" : { "default" : "", "description" : "Szablon wiadomości e-mail z raportem", "maxLength" : 10000, "type" : "string" }, "file_name_template" : { "default" : "", "description" : "Szablon nazwy pliku z raportem (bez rozszerzenia)", "maxLength" : 1024, "type" : "string" }, "generate_pdf" : { "default" : true, "description" : "Określa, czy generować plik PDF z raportem", "type" : "boolean" }, "group_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić informacje o grupach. Wartość \"auto\" oznacza włączenie tylko w przypadku, gdy usługi w raporcie należą do więcej niż jednej grupy", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "id" : { "description" : "Identyfikator szablonu raportów", "minimum" : 1, "type" : "integer" }, "owner_id" : { "description" : "Identyfikator konta, do którego należy szablon", "minimum" : 1, "type" : "integer" }, "reporting_plan_ids" : { "default" : [], "description" : "Sekcje raportu", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "requested_scope" : { "$ref" : "#/components/schemas/scope_request" }, "section_ids" : { "default" : [ "service_level_summary", "analyses_summary", "checks_summary", "errors_by_type", "status_changes_by_duration", "performance_summary" ], "description" : "Sekcje raportu", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "service_level_events" : { "default" : { "accounts" : [], "default" : null, "groups" : [], "services" : [] }, "description" : "Modyfikacje sposobu obliczania SL przez zdarzenia", "properties" : { "accounts" : { "default" : [], "description" : "Domyślne zdarzenia dla kont", "items" : { "properties" : { "account_id" : { "minimum" : 1, "type" : "integer" }, "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "default" : { "description" : "Domyślne zdarzenie", "minimum" : 1, "nullable" : true, "type" : "integer" }, "groups" : { "default" : [], "description" : "Domyślne zdarzenia dla grup", "items" : { "properties" : { "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" }, "group_id" : { "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "services" : { "default" : [], "description" : "Zdarzenia dla usług", "items" : { "properties" : { "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" }, "service_id" : { "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "type" : "array" } }, "required" : [ "default", "accounts", "groups", "services" ], "type" : "object" }, "summary" : { "default" : "enabled", "description" : "Sposób obsługi podsumowania raportu: włączone (domyślnie), wyłączone lub tylko podsumowanie", "enum" : [ "disabled", "enabled", "only" ], "type" : "string" }, "title" : { "description" : "Tytuł raportu", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "weekly_suspensions" : { "default" : [], "description" : "Lista tygodniowych zawieszeń (przedziałów, z których dane nie będą uwzględniane w raporcie)", "items" : { "additionalProperties" : false, "properties" : { "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "required" : [ "start_minute", "end_minute" ], "type" : "object" }, "maxItems" : 1000, "type" : "array" } }, "type" : "object" }, "report_template_create_data" : { "additionalProperties" : false, "properties" : { "account_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić informacje o kontach. Wartość \"auto\" oznacza włączenie tylko w przypadku, gdy usługi w raporcie należą do więcej niż jednego konta", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "archived_services" : { "default" : true, "description" : "Określa, czy w raporcie uwzględnić usługi archiwalne", "type" : "boolean" }, "attachment_type_ids" : { "default" : [], "description" : "Identyfikatory załączników do raportu", "items" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "maxItems" : 32, "type" : "array" }, "context_data" : { "default" : false, "description" : "Określa, czy w sekcjach tygodniowych i miesięcznych uwzględnić kontekst historyczny", "type" : "boolean" }, "delay" : { "default" : 300, "description" : "Opóźnienie generowania raportu względem końca przedziału czasowego, którego dotyczy", "maximum" : 1000000, "minimum" : 300, "type" : "integer" }, "description" : { "description" : "Opis raportu", "maxLength" : 1024, "nullable" : true, "type" : "string" }, "email_addresses" : { "description" : "Adresy e-mail, na które należy wysłać raport po wygenerowaniu", "items" : { "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "type" : "array", "uniqueItems" : true }, "email_subject_template" : { "default" : "", "description" : "Szablon tytułu wiadomości e-mail z raportem", "maxLength" : 1024, "type" : "string" }, "email_template" : { "default" : "", "description" : "Szablon wiadomości e-mail z raportem", "maxLength" : 10000, "type" : "string" }, "file_name_template" : { "default" : "", "description" : "Szablon nazwy pliku z raportem (bez rozszerzenia)", "maxLength" : 1024, "type" : "string" }, "generate_pdf" : { "default" : true, "description" : "Określa, czy generować plik PDF z raportem", "type" : "boolean" }, "group_info" : { "default" : "on", "description" : "Określa, czy w nagłówkach uwzględnić informacje o grupach. Wartość \"auto\" oznacza włączenie tylko w przypadku, gdy usługi w raporcie należą do więcej niż jednej grupy", "enum" : [ "on", "off", "auto" ], "type" : "string" }, "owner_id" : { "description" : "Identyfikator konta, do którego należy szablon", "minimum" : 1, "type" : "integer" }, "reporting_plan_ids" : { "default" : [], "description" : "Sekcje raportu", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "requested_scope" : { "$ref" : "#/components/schemas/scope_request" }, "section_ids" : { "default" : [ "service_level_summary", "analyses_summary", "checks_summary", "errors_by_type", "status_changes_by_duration", "performance_summary" ], "description" : "Sekcje raportu", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "service_level_events" : { "default" : { "accounts" : [], "default" : null, "groups" : [], "services" : [] }, "description" : "Modyfikacje sposobu obliczania SL przez zdarzenia", "properties" : { "accounts" : { "default" : [], "description" : "Domyślne zdarzenia dla kont", "items" : { "properties" : { "account_id" : { "minimum" : 1, "type" : "integer" }, "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "default" : { "description" : "Domyślne zdarzenie", "minimum" : 1, "nullable" : true, "type" : "integer" }, "groups" : { "default" : [], "description" : "Domyślne zdarzenia dla grup", "items" : { "properties" : { "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" }, "group_id" : { "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "services" : { "default" : [], "description" : "Zdarzenia dla usług", "items" : { "properties" : { "event_id" : { "minimum" : 1, "nullable" : true, "type" : "integer" }, "service_id" : { "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "type" : "array" } }, "required" : [ "default", "accounts", "groups", "services" ], "type" : "object" }, "summary" : { "default" : "enabled", "description" : "Sposób obsługi podsumowania raportu: włączone (domyślnie), wyłączone lub tylko podsumowanie", "enum" : [ "disabled", "enabled", "only" ], "type" : "string" }, "title" : { "description" : "Tytuł raportu", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "weekly_suspensions" : { "default" : [], "description" : "Lista tygodniowych zawieszeń (przedziałów, z których dane nie będą uwzględniane w raporcie)", "items" : { "additionalProperties" : false, "properties" : { "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "required" : [ "start_minute", "end_minute" ], "type" : "object" }, "maxItems" : 1000, "type" : "array" } }, "required" : [ "email_addresses", "requested_scope", "section_ids", "title" ], "type" : "object" }, "report_template_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "report_template_filters" : { "additionalProperties" : false, "properties" : { "account_info" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "archived_services" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "context_data" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "delay" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "email_subject_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "email_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "file_name_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "generate_pdf" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "group_info" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_reports" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "summary" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "title" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "report_template_permission" : { "additionalProperties" : true, "properties" : { "create_reports" : { "description" : "Uprawnienia do tworzenia nowych raportów na podstawie szablonu", "type" : "boolean" }, "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" } }, "type" : "object" }, "report_template_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_reports", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plans", "reporting_plans.description", "reporting_plans.id", "reporting_plans.name", "sections", "sections.description", "sections.id", "sections.name", "stats", "stats.created_at", "stats.id", "stats.last_report_generated_at", "stats.reports_count" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name_template", "generate_pdf", "group_info", "id", "owner_id", "reporting_plan_ids", "requested_scope", "section_ids", "service_level_events", "summary", "title", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/report_template_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/report_template_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "report_template_sortable_field" : { "enum" : [ "account_info", "archived_services", "context_data", "delay", "description", "email_subject_template", "email_template", "file_name_template", "generate_pdf", "group_info", "id", "owner.name", "owner.username", "owner_id", "permissions.create_reports", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "stats.created_at", "stats.last_report_generated_at", "stats.reports_count", "summary", "title" ], "type" : "string" }, "report_template_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/report_template_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "report_template_stat" : { "additionalProperties" : true, "properties" : { "created_at" : { "description" : "Czas utworzenia szablonu", "format" : "dateTime", "type" : "string" }, "id" : { "description" : "Identyfikator szablonu raportów", "minimum" : 1, "type" : "integer" }, "last_report_generated_at" : { "description" : "Czas wygenerowania ostatniego raportu według szablonu", "format" : "dateTime", "type" : "string" }, "reports_count" : { "description" : "Liczba raportów", "minimum" : 0, "type" : "integer" } }, "type" : "object" }, "report_template_variable" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "reporting_plan" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "scheduled_suspension" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis zawieszenia", "maxLength" : 255, "nullable" : true, "type" : "string" }, "end" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "id" : { "description" : "Identyfikator zaplanowanego zawieszenia", "minimum" : 1, "type" : "integer" }, "only_notifications" : { "default" : false, "description" : "Określa, czy zawieszenie dotyczy jedynie wysyłania powiadomień", "type" : "boolean" }, "service_id" : { "description" : "Identyfikator usługi, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "start" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "scheduled_suspension_bulk_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "description" : "Opis zawieszenia", "maxLength" : 255, "nullable" : true, "type" : "string" }, "end" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "only_notifications" : { "default" : false, "description" : "Określa, czy zawieszenie dotyczy jedynie wysyłania powiadomień", "type" : "boolean" }, "service_ids" : { "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 1000, "type" : "array" }, "start" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "required" : [ "service_ids", "end" ], "type" : "object" }, "scheduled_suspension_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "description" : "Opis zawieszenia", "maxLength" : 255, "nullable" : true, "type" : "string" }, "end" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "only_notifications" : { "default" : false, "description" : "Określa, czy zawieszenie dotyczy jedynie wysyłania powiadomień", "type" : "boolean" }, "service_id" : { "description" : "Identyfikator usługi, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "start" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "required" : [ "end", "service_id" ], "type" : "object" }, "scheduled_suspension_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "scheduled_suspension_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "end" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "only_notifications" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.interval" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.is_active" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.is_archived" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "scheduled_suspension_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "description", "end", "id", "only_notifications", "service_id", "start" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/scheduled_suspension_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/scheduled_suspension_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "scheduled_suspension_sortable_field" : { "enum" : [ "description", "end", "id", "only_notifications", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start" ], "type" : "string" }, "scheduled_suspension_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/scheduled_suspension_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "scope_request" : { "properties" : { "accounts" : { "$ref" : "#/components/schemas/accounts_scope" }, "groups" : { "$ref" : "#/components/schemas/groups_scope" }, "services" : { "$ref" : "#/components/schemas/services_scope" } }, "type" : "object" }, "sensor" : { "additionalProperties" : true, "properties" : { "city" : { "description" : "Miejscowość, w której znajduje się stacja monitorująca", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "continent" : { "description" : "Kontynent, na którym znajduje się stacja monitorująca", "maxLength" : 30, "minLength" : 1, "type" : "string" }, "country" : { "description" : "Kraj, w którym znajduje się stacja monitorująca", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "dns_diagnostics_available" : { "description" : "Określa, czy dla stacji jest dostępna diagnostyka DNS", "type" : "boolean" }, "id" : { "description" : "Identyfikator stacji monitorującej", "minimum" : 1, "type" : "integer" }, "ip_address" : { "description" : "Adres IP stacji monitorującej", "format" : "ip", "maxLength" : 15, "minLength" : 1, "type" : "string" }, "ipv6_address" : { "description" : "Adres IPv6 stacji monitorującej", "format" : "ip", "maxLength" : 64, "minLength" : 1, "nullable" : true, "type" : "string" }, "is_available" : { "description" : "Określa, czy stacja domyślnie jest dostępna do przypisania do grup i usług. To ustawienie może być zmienione dla poszczególnych kont, dlatego listę dostępnych stacji należy pobierać za pomocą dedykowanych do tego operacji", "type" : "boolean" }, "is_enabled" : { "description" : "Określa, czy stacja jest aktualnie włączona", "type" : "boolean" }, "links" : { "description" : "Łącza i styki internetowe podpięte do stacji monitorującej", "maxLength" : 1024, "type" : "string" }, "name" : { "description" : "Nazwa stacji monitorującej", "maxLength" : 128, "minLength" : 1, "type" : "string" }, "service_type_category_ids" : { "default" : [ "default" ], "description" : "Tablica identyfikatorów kategorii typów usług obsługiwanych przez stację monitorującą", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "traceroute_diagnostics_available" : { "description" : "Określa, czy dla stacji jest dostępna diagnostyka traceroute", "type" : "boolean" } }, "type" : "object" }, "sensor_filters" : { "additionalProperties" : false, "properties" : { "city" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "continent" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "country" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "dns_diagnostics_available" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "ip_address" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "ipv6_address" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_available" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_enabled" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "links" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status.is_connected" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status.summary" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "traceroute_diagnostics_available" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "sensor_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/sensor_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/sensor_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "sensor_sortable_field" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available" ], "type" : "string" }, "sensor_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/sensor_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "sensor_status" : { "additionalProperties" : true, "properties" : { "id" : { "description" : "Identyfikator stacji monitorującej", "minimum" : 1, "type" : "integer" }, "is_connected" : { "description" : "Określa, czy stacja jest aktualnie połączona", "type" : "boolean" }, "is_suspended" : { "description" : "Określa, czy wykonywanie sprawdzeń na stacji jest aktualnie wstrzymane", "type" : "boolean" }, "summary" : { "description" : "Podsumowanie aktualnego statusu działania stacji", "enum" : [ "ok", "warning", "suspended", "offline" ], "type" : "string" } }, "type" : "object" }, "service" : { "additionalProperties" : true, "properties" : { "address" : { "description" : "Monitorowany adres", "maxLength" : 2000, "type" : "string" }, "description" : { "description" : "Opis usługi", "maxLength" : 10000, "nullable" : true, "type" : "string" }, "extended_settings" : { "$ref" : "#/components/schemas/extended_settings" }, "group_id" : { "description" : "ID grupy, do której należy usługa", "minimum" : 1, "type" : "integer" }, "id" : { "description" : "Identyfikator uslugi", "minimum" : 1, "type" : "integer" }, "interval" : { "description" : "Odstęp pomiędzy kolejnymi sprawdzeniami, w sekundach", "maximum" : 33554432, "minimum" : 1, "type" : "integer" }, "is_active" : { "default" : true, "description" : "Określa, czy monitoring usługi jest włączony", "type" : "boolean" }, "is_archived" : { "default" : false, "description" : "Określa, czy usługa została zarchiwizowana", "type" : "boolean" }, "name" : { "description" : "Nazwa usługi", "maxLength" : 60, "minLength" : 1, "type" : "string" }, "notification_channel_ids" : { "default" : [ "alerta", "email", "email_dedicated", "email_extended", "email_short", "email_simplified", "gadu_gadu", "hipchat", "jabber", "json_post", "ms_teams", "ms_teams_extended", "pagerduty", "push", "rocketchat", "signal", "slack", "sms", "telephone" ], "description" : "Identyfikatory kanałów powiadomień włączonych dla usługi", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "notification_condition_ids" : { "default" : [ "failure", "recovery" ], "description" : "Zdarzenia, o których należy powiadamiać", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "notification_mode_id" : { "default" : "default", "description" : "Identyfikator trybu powiadomień", "type" : "string" }, "owner_id" : { "description" : "ID konta, do którego należy usługa", "minimum" : 1, "type" : "integer" }, "recovery_notification_mode_id" : { "default" : "default", "description" : "Identyfikator trybu powiadomień o końcu awarii", "type" : "string" }, "sensor_ids" : { "description" : "Tablica identyfikatorów stacji monitorujących przypisanych do usługi, nadpisujących domyślną listę stacji dla grupy", "items" : { "minimum" : 1, "type" : "integer" }, "minItems" : 1, "nullable" : true, "type" : "array", "uniqueItems" : true }, "silent_hours" : { "default" : "000000000000000000000000", "description" : "24 znaki 0 lub 1 oznaczające włączony lub wyłączony tryb cichy w poszczególnych godzinach doby.\n\nUWAGA: To pole zostanie usunięte w jednej z przyszłych wersji API. Zamiast niego należy używać zasobu `weekly_suspensions` z parametrem `only_notifications`", "maxLength" : 24, "minLength" : 24, "pattern" : "^[01]*$", "type" : "string" }, "step_names" : { "description" : "Lista nazw kolejnych kroków (jeśli usługa jest scenariuszem)", "items" : { "type" : "string" }, "nullable" : true, "type" : "array" }, "suspension_hours" : { "default" : "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description" : "168 znaków 0 lub 1 oznaczające włączone lub wyłączone zawieszenie monitoringu w poszczególnych godzinach tygodnia.\n\nUWAGA: To pole zostanie usunięte w jednej z przyszłych wersji API. Zamiast niego należy używać zasobu `weekly_suspensions`", "maxLength" : 168, "minLength" : 168, "pattern" : "^[01]*$", "type" : "string" }, "type_id" : { "description" : "Identyfikator typu usługi", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" } }, "type" : "object" }, "service_create_data" : { "additionalProperties" : false, "properties" : { "address" : { "description" : "Monitorowany adres", "maxLength" : 2000, "type" : "string" }, "description" : { "description" : "Opis usługi", "maxLength" : 10000, "nullable" : true, "type" : "string" }, "extended_settings" : { "$ref" : "#/components/schemas/extended_settings" }, "group_id" : { "description" : "ID grupy, do której należy usługa", "minimum" : 1, "type" : "integer" }, "interval" : { "description" : "Odstęp pomiędzy kolejnymi sprawdzeniami, w sekundach", "maximum" : 33554432, "minimum" : 1, "type" : "integer" }, "is_active" : { "default" : true, "description" : "Określa, czy monitoring usługi jest włączony", "type" : "boolean" }, "is_archived" : { "default" : false, "description" : "Określa, czy usługa została zarchiwizowana", "type" : "boolean" }, "name" : { "description" : "Nazwa usługi", "maxLength" : 60, "minLength" : 1, "type" : "string" }, "notification_channel_ids" : { "default" : [ "alerta", "email", "email_dedicated", "email_extended", "email_short", "email_simplified", "gadu_gadu", "hipchat", "jabber", "json_post", "ms_teams", "ms_teams_extended", "pagerduty", "push", "rocketchat", "signal", "slack", "sms", "telephone" ], "description" : "Identyfikatory kanałów powiadomień włączonych dla usługi", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "notification_condition_ids" : { "default" : [ "failure", "recovery" ], "description" : "Zdarzenia, o których należy powiadamiać", "items" : { "type" : "string" }, "type" : "array", "uniqueItems" : true }, "notification_mode_id" : { "default" : "default", "description" : "Identyfikator trybu powiadomień", "type" : "string" }, "owner_id" : { "description" : "ID konta, do którego należy usługa", "minimum" : 1, "type" : "integer" }, "recovery_notification_mode_id" : { "default" : "default", "description" : "Identyfikator trybu powiadomień o końcu awarii", "type" : "string" }, "sensor_ids" : { "description" : "Tablica identyfikatorów stacji monitorujących przypisanych do usługi, nadpisujących domyślną listę stacji dla grupy", "items" : { "minimum" : 1, "type" : "integer" }, "minItems" : 1, "nullable" : true, "type" : "array", "uniqueItems" : true }, "silent_hours" : { "default" : "000000000000000000000000", "description" : "24 znaki 0 lub 1 oznaczające włączony lub wyłączony tryb cichy w poszczególnych godzinach doby.\n\nUWAGA: To pole zostanie usunięte w jednej z przyszłych wersji API. Zamiast niego należy używać zasobu `weekly_suspensions` z parametrem `only_notifications`", "maxLength" : 24, "minLength" : 24, "pattern" : "^[01]*$", "type" : "string" }, "step_names" : { "description" : "Lista nazw kolejnych kroków (jeśli usługa jest scenariuszem)", "items" : { "type" : "string" }, "nullable" : true, "type" : "array" }, "suspension_hours" : { "default" : "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description" : "168 znaków 0 lub 1 oznaczające włączone lub wyłączone zawieszenie monitoringu w poszczególnych godzinach tygodnia.\n\nUWAGA: To pole zostanie usunięte w jednej z przyszłych wersji API. Zamiast niego należy używać zasobu `weekly_suspensions`", "maxLength" : 168, "minLength" : 168, "pattern" : "^[01]*$", "type" : "string" }, "type_id" : { "description" : "Identyfikator typu usługi", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" } }, "required" : [ "address", "interval", "name", "type_id" ], "type" : "object" }, "service_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "service_filters" : { "additionalProperties" : false, "properties" : { "address" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "group.is_default" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "group.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "group_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "interval" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_active" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_archived" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.archive" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_corrections" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_scheduled_suspensions" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_suspensions" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.create_weekly_suspensions" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.force_analyses" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.force_custom_analyses" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.restore" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.send_test_sms_notifications" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update_step_names" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status.check_status" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status.check_status_is_up_to_date" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status.last_analysis_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status.last_analysis_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status.last_check_status_change_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status.monitoring_status" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "status.summary" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "type.category_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "type.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "type_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "service_level_data" : { "properties" : { "failure" : { "description" : "Liczba sekund z wybranego przedziału w których usługa była w stanie awarii", "minimum" : 0, "type" : "integer" }, "ok" : { "description" : "Liczba sekund z wybranego przedziału w których usługa działała poprawnie", "minimum" : 0, "type" : "integer" }, "paused" : { "description" : "Liczba sekund z wybranego przedziału w których monitoring usługi był zatrzymany lub zawieszony", "minimum" : 0, "type" : "integer" } }, "type" : "object" }, "service_level_interval" : { "properties" : { "failure" : { "description" : "Procent czasu, kiedy usługa była w stanie awarii w danym przedziale czasowym", "maximum" : 100, "minimum" : 0, "type" : "number" }, "failure_seconds" : { "description" : "Liczba sekund, w których usługa była w stanie awarii w danym przedziale czasowym", "minimum" : 0, "type" : "integer" }, "from" : { "description" : "Początek przedziału czasowego", "format" : "dateTime", "type" : "string" }, "ok" : { "description" : "Procent czasu, kiedy usługa działała poprawnie w danym przedziale czasowym", "maximum" : 100, "minimum" : 0, "type" : "number" }, "ok_seconds" : { "description" : "Liczba sekund, w których usługa działała poprawnie w danym przedziale czasowym", "minimum" : 0, "type" : "integer" }, "paused" : { "description" : "Procent czasu, kiedy usługa nie była monitorowana w danym przedziale czasowym (w wyniku zatrzymania lub czasowego zawieszenia monitoringu)", "maximum" : 100, "minimum" : 0, "type" : "number" }, "paused_seconds" : { "description" : "Liczba sekund, w których usługa nie była monitorowana w danym przedziale czasowym (w wyniku zatrzymania lub czasowego zawieszenia monitoringu)", "minimum" : 0, "type" : "integer" }, "to" : { "description" : "Koniec przedziału czasowego", "format" : "dateTime", "type" : "string" } }, "required" : [ "from", "to", "ok", "failure", "paused", "ok_seconds", "failure_seconds", "paused_seconds" ], "type" : "object" }, "service_permission" : { "additionalProperties" : true, "properties" : { "archive" : { "description" : "Uprawnienia do archiwizacji usługi", "type" : "boolean" }, "create_corrections" : { "description" : "Uprawnienia do tworzenia korekt Service Level usługi", "type" : "boolean" }, "create_scheduled_suspensions" : { "description" : "Uprawnienia do tworzenia nowych zaplanowanych zawieszeń monitoringu usługi (zastąpione przez `create_suspensions`)", "type" : "boolean" }, "create_suspensions" : { "description" : "Uprawnienia do tworzenia nowych zaplanowanych zawieszeń monitoringu i powiadomień dla usługi", "type" : "boolean" }, "create_weekly_suspensions" : { "description" : "Uprawnienia do tworzenia nowych tygodniowych zawieszeń monitoringu i powiadomień dla usługi", "type" : "boolean" }, "delete" : { "description" : "Uprawnienia do usunięcia", "type" : "boolean" }, "force_analyses" : { "description" : "Uprawnienia do wymuszania analiz działania usługi", "type" : "boolean" }, "force_custom_analyses" : { "description" : "Uprawnienia do wymuszania niestandardowych analiz działania usługi", "type" : "boolean" }, "own" : { "description" : "Określa, czy obiekt należy do wywołującego użytkownika", "type" : "boolean" }, "read" : { "description" : "Uprawnienia do odczytu", "type" : "boolean" }, "restore" : { "description" : "Uprawnienia do przywrócenia usługi z archiwum", "type" : "boolean" }, "send_test_sms_notifications" : { "description" : "Uprawnienia do wysyłania testowych powiadomień SMS na numery telefonu przypisane do usługi", "type" : "boolean" }, "update" : { "description" : "Uprawnienia do modyfikacji", "type" : "boolean" }, "update_step_names" : { "description" : "Uprawnienia do modyfikacji listy kroków usługi", "type" : "boolean" } }, "type" : "object" }, "service_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "monitoring_sensors", "monitoring_sensors.city", "monitoring_sensors.continent", "monitoring_sensors.country", "monitoring_sensors.dns_diagnostics_available", "monitoring_sensors.id", "monitoring_sensors.ip_address", "monitoring_sensors.ipv6_address", "monitoring_sensors.is_available", "monitoring_sensors.is_enabled", "monitoring_sensors.links", "monitoring_sensors.name", "monitoring_sensors.service_type_category_ids", "monitoring_sensors.traceroute_diagnostics_available", "notification_channels", "notification_channels.description", "notification_channels.id", "notification_channels.name", "notification_conditions", "notification_conditions.description", "notification_conditions.id", "notification_conditions.name", "notification_mode", "notification_mode.description", "notification_mode.id", "notification_mode.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "recovery_notification_mode", "recovery_notification_mode.description", "recovery_notification_mode.id", "recovery_notification_mode.name", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "status", "status.average_response_time", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.id", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.last_failure_analysis_id", "status.last_failure_analysis_time", "status.last_ok_analysis_id", "status.last_ok_analysis_time", "status.monitoring_status", "status.notifications_status", "status.summary", "type", "type.address_prefix", "type.category_id", "type.customizable_step_names", "type.description", "type.id", "type.manual_schedule", "type.name", "type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "address", "description", "extended_settings", "group_id", "id", "interval", "is_active", "is_archived", "name", "notification_channel_ids", "notification_condition_ids", "notification_mode_id", "owner_id", "recovery_notification_mode_id", "sensor_ids", "silent_hours", "step_names", "suspension_hours", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/service_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/service_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "service_sortable_field" : { "enum" : [ "address", "description", "group.is_default", "group.name", "group_id", "id", "interval", "is_active", "is_archived", "name", "owner.name", "owner.username", "owner_id", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.monitoring_status", "status.summary", "type.category_id", "type.name", "type_id" ], "type" : "string" }, "service_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/service_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "service_status" : { "additionalProperties" : true, "properties" : { "average_response_time" : { "description" : "Średni czas odpowiedzi poprawnych i błędnych sprawdzeń w ostatniej analizie, w milisekundach", "minimum" : 0, "nullable" : true, "type" : "integer" }, "check_status" : { "description" : "Ostatni status działania usługi. Poprawne działanie (\"ok\") lub awaria (\"failure\")", "enum" : [ "ok", "failure" ], "type" : "string" }, "check_status_is_up_to_date" : { "description" : "Określa, czy pole `check_status` jest aktualne. Jeśli nie jest i monitoring nie jest zatrzymany, status działania usługi jest nieznany", "type" : "boolean" }, "highest_active_event_priority" : { "description" : "Najwyższy priorytet aktualnie trwającego zdarzenia dla usługi. Wartość tego pola może zależeć od wywołującego użytkownika i jego autoryzacji do zdarzeń", "maximum" : 4, "minimum" : 1, "nullable" : true, "type" : "integer" }, "id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "last_analysis_id" : { "description" : "Identyfikator ostatniej analizy działania usługi lub NULL jeśli usługa nie była jeszcze sprawdzana", "maxLength" : 15, "minLength" : 15, "nullable" : true, "pattern" : "^[0-9]*$", "type" : "string" }, "last_analysis_time" : { "description" : "Czas ostatniej analizy działania usługi lub NULL jeśli usługa nie była jeszcze sprawdzana", "format" : "dateTime", "nullable" : true, "type" : "string" }, "last_check_status_change_time" : { "description" : "Czas ostatniej zmiany wartości pola `check_status` lub NULL jeśli status działania nie był jeszcze zmieniany", "format" : "dateTime", "nullable" : true, "type" : "string" }, "last_failure_analysis_id" : { "description" : "Identyfikator ostatniej błędnej analizy działania usługi lub NULL jeśli żadna taka analiza nie została jeszcze wykonana", "maxLength" : 15, "minLength" : 15, "nullable" : true, "pattern" : "^[0-9]*$", "type" : "string" }, "last_failure_analysis_time" : { "description" : "Czas ostatniej błędnej analizy działania usługi lub NULL jeśli żadna taka analiza nie została jeszcze wykonana", "format" : "dateTime", "nullable" : true, "type" : "string" }, "last_ok_analysis_id" : { "description" : "Identyfikator ostatniej poprawnej analizy działania usługi lub NULL jeśli żadna taka analiza nie została jeszcze wykonana", "maxLength" : 15, "minLength" : 15, "nullable" : true, "pattern" : "^[0-9]*$", "type" : "string" }, "last_ok_analysis_time" : { "description" : "Czas ostatniej poprawnej analizy działania usługi lub NULL jeśli żadna taka analiza nie została jeszcze wykonana", "format" : "dateTime", "nullable" : true, "type" : "string" }, "monitoring_status" : { "description" : "Aktualny status monitoringu usługi. Włączony (\"on\"), wyłączony (\"off\") lub czasowo wstrzymany zgodnie z harmonogramem zawieszeń (\"suspended\")", "enum" : [ "on", "off", "suspended" ], "type" : "string" }, "notifications_status" : { "description" : "Aktualny status powiadomień dla usługi. Włączony (\"on\"), wyłączony (\"off\") lub czasowo wstrzymany zgodnie z ustawienem `silent_hours` usługi (\"silent\")", "enum" : [ "on", "off", "silent" ], "type" : "string" }, "summary" : { "description" : "Podsumowanie statusu wynikające z cząstkowych wartości zawartych w polach `check_status`, `check_status_is_up_to_date` oraz `monitoring_status`", "enum" : [ "failure", "ok", "paused", "suspended", "unknown" ], "type" : "string" } }, "type" : "object" }, "service_status_filters" : { "additionalProperties" : false, "properties" : { "average_response_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "check_status" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "check_status_is_up_to_date" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "monitoring_status" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "notifications_status" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.interval" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.is_active" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "summary" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "service_status_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "average_response_time", "check_status", "check_status_is_up_to_date", "highest_active_event_priority", "id", "last_analysis_id", "last_analysis_time", "last_check_status_change_time", "last_failure_analysis_id", "last_failure_analysis_time", "last_ok_analysis_id", "last_ok_analysis_time", "monitoring_status", "notifications_status", "summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/service_status_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/service_status_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "service_status_sortable_field" : { "enum" : [ "average_response_time", "check_status", "check_status_is_up_to_date", "highest_active_event_priority", "id", "last_check_status_change_time", "monitoring_status", "notifications_status", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.name", "service.owner_id", "summary" ], "type" : "string" }, "service_status_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/service_status_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "service_type" : { "additionalProperties" : true, "properties" : { "address_prefix" : { "description" : "Prefiks adresu określający protokół komunikacji dla typu usługi, np \"http://\"", "maxLength" : 16, "type" : "string" }, "category_id" : { "default" : "default", "description" : "Identyfikator kategorii, do której należy typ usługi", "type" : "string" }, "customizable_step_names" : { "default" : false, "description" : "Określa, czy dla usług tego typu jest możliwa edycja listy nazw kroków", "type" : "boolean" }, "description" : { "default" : { "bullet_points" : [], "subtitle" : "", "title" : "" }, "description" : "Opis typu usługi", "properties" : { "bullet_points" : { "default" : [], "items" : { "maxLength" : 10000, "type" : "string" }, "maxItems" : 100, "type" : "array" }, "subtitle" : { "default" : "", "maxLength" : 100000, "type" : "string" }, "title" : { "default" : "", "maxLength" : 1000, "type" : "string" } }, "required" : [ "title", "subtitle", "bullet_points" ], "type" : "object" }, "id" : { "description" : "Identyfikator typu usługi", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "manual_schedule" : { "default" : false, "description" : "Określa, czy dla usług tego typu analizy są wykonywane jedynie ręcznie", "type" : "boolean" }, "name" : { "description" : "Nazwa typu usługi", "maxLength" : 255, "minLength" : 1, "type" : "string" }, "step_names" : { "description" : "Lista nazw kolejnych kroków (dla scenariuszy)", "items" : { "type" : "string" }, "nullable" : true, "type" : "array" } }, "type" : "object" }, "service_type_category" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "service_type_filters" : { "additionalProperties" : false, "properties" : { "address_prefix" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "category_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "customizable_step_names" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "manual_schedule" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "service_type_limit" : { "additionalProperties" : true, "properties" : { "account_id" : { "description" : "Identyfikator konta", "minimum" : 1, "type" : "integer" }, "minimum_interval" : { "description" : "Minimalny odstęp pomiędzy sprawdzeniami", "minimum" : 1, "type" : "integer" }, "remaining_services" : { "description" : "Pozostała liczba usług danego typu dla konta", "minimum" : 0, "type" : "integer" }, "service_type_id" : { "description" : "Identyfikator typu usługi", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" } }, "type" : "object" }, "service_type_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "category", "category.description", "category.id", "category.name", "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "address_prefix", "category_id", "customizable_step_names", "description", "id", "manual_schedule", "name", "step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/service_type_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/service_type_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "service_type_sortable_field" : { "enum" : [ "address_prefix", "category_id", "customizable_step_names", "id", "manual_schedule", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "service_type_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/service_type_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "services_scope" : { "properties" : { "all" : { "type" : "boolean" }, "by_group_id" : { "$ref" : "#/components/schemas/array_of_ids" }, "by_id" : { "$ref" : "#/components/schemas/array_of_ids" }, "by_owner_id" : { "$ref" : "#/components/schemas/array_of_ids" } }, "type" : "object" }, "session" : { "additionalProperties" : true, "properties" : { "absolute_expiration_time" : { "description" : "Termin ważności sesji (bez przedłużania przy jej użyciu)", "format" : "dateTime", "type" : "string" }, "account_id" : { "description" : "Identyfikator konta (dla sesji użytkownika)", "minimum" : 1, "nullable" : true, "type" : "integer" }, "created_at" : { "description" : "Czas utworzenia sesji", "format" : "dateTime", "type" : "string" }, "distribution_id" : { "description" : "Identyfikator dystrybucji (dla sesji administratora)", "minimum" : 1, "nullable" : true, "type" : "integer" }, "expiration_duration" : { "description" : "Czas bez aktywności, po którym sesja wygasa, w sekundach", "maximum" : 1000000000, "minimum" : 1, "nullable" : true, "type" : "integer" }, "expiration_time" : { "description" : "Czas wygaśnięcia sesji lub NULL dla sesji niewygasających (obliczany na podstawie `expiration_duration`, `absolute_expiration_time` i `last_used`)", "format" : "dateTime", "type" : "string" }, "id" : { "description" : "Identyfikator sesji", "maxLength" : 40, "minLength" : 40, "pattern" : "^[0-9a-f]*$", "type" : "string" }, "is_2fa_required" : { "default" : false, "description" : "Określa, czy sesję należy dodatkowo potwierdzić za pomocą 2FA", "type" : "boolean" }, "is_api_token" : { "default" : false, "description" : "[BETA] Określa, czy sesja jest tokenem API", "type" : "boolean" }, "is_hidden" : { "description" : "Określa, czy sesja jest ukryta", "type" : "boolean" }, "is_read_only" : { "default" : false, "description" : "Określa, czy sesja jest tylko do odczytu", "type" : "boolean" }, "last_used" : { "description" : "Czas ostatniego użycia sesji", "format" : "dateTime", "type" : "string" }, "manager_id" : { "description" : "Identyfikator menadżera", "minimum" : 1, "nullable" : true, "type" : "integer" }, "name" : { "default" : "", "description" : "Nazwa sesji", "maxLength" : 255, "type" : "string" }, "scope" : { "description" : "Zasięg autoryzacji", "enum" : [ "administrator", "customer" ], "type" : "string" }, "user_agent" : { "description" : "User-Agent klienta API, który utworzył sesję", "type" : "string" } }, "type" : "object" }, "session_filters" : { "additionalProperties" : false, "properties" : { "account_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "created_at" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "distribution_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "expiration_duration" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "expiration_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_2fa_required" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_api_token" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_hidden" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "is_read_only" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "manager_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "scope" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "user_agent" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "session_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "account", "account.disable_legacy_notifications", "account.id", "account.is_activated", "account.is_blocked", "account.is_read_only", "account.language_id", "account.name", "account.package_id", "account.parent_account_id", "account.time_zone_id", "account.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "absolute_expiration_time", "account_id", "created_at", "distribution_id", "expiration_duration", "expiration_time", "id", "is_2fa_required", "is_api_token", "is_hidden", "is_read_only", "last_used", "manager_id", "name", "scope", "user_agent" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/session_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/session_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "session_sortable_field" : { "enum" : [ "absolute_expiration_time", "account_id", "created_at", "distribution_id", "expiration_duration", "expiration_time", "id", "is_2fa_required", "is_api_token", "is_hidden", "is_read_only", "last_used", "manager_id", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "scope", "user_agent" ], "type" : "string" }, "session_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/session_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "session_token" : { "properties" : { "account_id" : { "description" : "Identyfikator konta (tylko jeśli `scope` jest równy `customer`)", "minimum" : 1, "nullable" : true, "type" : "integer" }, "expires_in" : { "description" : "Czas, po którym sesja wygaśnie w przypadku braku aktywności, w sekundach", "maximum" : 1000000000, "minimum" : 1, "nullable" : true, "type" : "integer" }, "id" : { "description" : "ID tokena sesji", "maxLength" : 32, "minLength" : 32, "pattern" : "^[a-f0-9]*$", "type" : "string" }, "scope" : { "description" : "Zasięg autoryzacji", "enum" : [ "customer", "administrator" ], "type" : "string" } }, "required" : [ "id", "expires_in", "account_id", "scope" ], "type" : "object" }, "simple_type" : { "anyOf" : [ { "type" : "boolean" }, { "type" : "number" }, { "type" : "string" } ] }, "sort_order" : { "default" : "asc", "enum" : [ "asc", "desc" ], "type" : "string" }, "status_change" : { "additionalProperties" : true, "properties" : { "change_id" : { "description" : "Identyfikator zmiany stanu, unikalny w obrębie pojedynczej usługi", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "description" : { "description" : "Opis zmiany stanu. W przypadku zaplanowanych zawieszeń (`service_suspensions`) zostanie użyty opis przekazany przez użytkownika", "maxLength" : 255, "nullable" : true, "type" : "string" }, "duration" : { "description" : "Aktualna długość przedziału czasowego, w którym usługa przebywała lub przebywa w danym stanie (w sekundach)", "minimum" : 0, "type" : "integer" }, "end_time" : { "description" : "Koniec przedziału czasowego, w którym usługa przebywała w danym stanie (pierwsza sekunda nie należąca do przedziału - przedział prawostronnie otwarty) lub NULL jeśli usługa wciąż przebywa w tym stanie", "format" : "dateTime", "type" : "string" }, "first_analysis_id" : { "description" : "Identyfikator pierwszej analizy działania usługi, który spowodował zmianę stanu (dla zmian typu `ok` lub `failure`)", "maxLength" : 15, "minLength" : 15, "nullable" : true, "pattern" : "^[0-9]*$", "type" : "string" }, "pause_reason" : { "description" : "Przyczyna zatrzymania monitoringu - zatrzymanie ręczne (`manual`), wstrzymanie według harmonogramu tygodniowego (`weekly`), zaplanowane zawieszenie (`scheduled`) lub NULL jeśli zmiana statusu działania nie jest typu `paused`", "enum" : [ "manual", "weekly", "scheduled" ], "nullable" : true, "type" : "string" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Początek przedziału czasowego, w którym usługa przebywała w danym stanie", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status usługi (`paused` oznacza ręczne zatrzymanie monitoringu lub zaplanowane zawieszenie)", "enum" : [ "ok", "failure", "paused" ], "type" : "string" } }, "type" : "object" }, "status_change_bulk_update_data" : { "properties" : { "change_ids" : { "items" : { "description" : "Identyfikator zmiany stanu, unikalny w obrębie jednej usługi.", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "maxItems" : 1000, "type" : "array" }, "description" : { "maxLength" : 255, "nullable" : true, "type" : "string" } }, "required" : [ "change_ids", "description" ], "type" : "object" }, "status_change_log" : { "additionalProperties" : true, "properties" : { "change_id" : { "description" : "Identyfikator zmiany stanu, unikalny w obrębie pojedynczej usługi", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "description" : { "description" : "Opis zmiany stanu. W przypadku zaplanowanych zawieszeń (`service_suspensions`) zostanie użyty opis przekazany przez użytkownika", "maxLength" : 255, "nullable" : true, "type" : "string" }, "duration" : { "description" : "Aktualna długość przedziału czasowego, w którym usługa przebywała lub przebywa w danym stanie (w sekundach)", "minimum" : 0, "type" : "integer" }, "end_time" : { "description" : "Koniec przedziału czasowego, w którym usługa przebywała w danym stanie (pierwsza sekunda nie należąca do przedziału - przedział prawostronnie otwarty) lub NULL jeśli usługa wciąż przebywa w tym stanie", "format" : "dateTime", "type" : "string" }, "first_analysis_id" : { "description" : "Identyfikator pierwszej analizy działania usługi, który spowodował zmianę stanu (dla zmian typu `ok` lub `failure`)", "maxLength" : 15, "minLength" : 15, "nullable" : true, "pattern" : "^[0-9]*$", "type" : "string" }, "pause_reason" : { "description" : "Przyczyna zatrzymania monitoringu - zatrzymanie ręczne (`manual`), wstrzymanie według harmonogramu tygodniowego (`weekly`), zaplanowane zawieszenie (`scheduled`) lub NULL jeśli zmiana statusu działania nie jest typu `paused`", "enum" : [ "manual", "weekly", "scheduled" ], "nullable" : true, "type" : "string" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Początek przedziału czasowego, w którym usługa przebywała w danym stanie", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status usługi (`paused` oznacza ręczne zatrzymanie monitoringu lub zaplanowane zawieszenie)", "enum" : [ "ok", "failure", "paused" ], "type" : "string" } }, "type" : "object" }, "status_change_stat" : { "additionalProperties" : true, "properties" : { "change_id" : { "description" : "Identyfikator zmiany stanu, unikalny w obrębie pojedynczej usługi", "maxLength" : 15, "minLength" : 15, "pattern" : "^[0-9]*$", "type" : "string" }, "checks_count" : { "description" : "Liczba sprawdzeń usługi z danej stacji monitorującej podczas przebywania w wybranym stanie", "minimum" : 0, "type" : "integer" }, "sensor_id" : { "description" : "Identyfikator stacji monitorującej", "minimum" : 1, "type" : "integer" }, "service_id" : { "description" : "Identyfikator usługi", "minimum" : 1, "type" : "integer" } }, "type" : "object" }, "suspension" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis zawieszenia", "maxLength" : 255, "nullable" : true, "type" : "string" }, "end_time" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "id" : { "description" : "Identyfikator zaplanowanego zawieszenia", "minimum" : 1, "type" : "integer" }, "only_notifications" : { "default" : false, "description" : "Określa, czy zawieszenie dotyczy jedynie wysyłania powiadomień", "type" : "boolean" }, "service_id" : { "description" : "Identyfikator usługi, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "suspension_bulk_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "description" : "Opis zawieszenia", "maxLength" : 255, "nullable" : true, "type" : "string" }, "end_time" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "only_notifications" : { "default" : false, "description" : "Określa, czy zawieszenie dotyczy jedynie wysyłania powiadomień", "type" : "boolean" }, "service_ids" : { "items" : { "minimum" : 1, "type" : "integer" }, "maxItems" : 1000, "type" : "array" }, "start_time" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "required" : [ "service_ids", "end_time" ], "type" : "object" }, "suspension_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "description" : "Opis zawieszenia", "maxLength" : 255, "nullable" : true, "type" : "string" }, "end_time" : { "description" : "Czas zakończenia zawieszenia", "format" : "dateTime", "type" : "string" }, "only_notifications" : { "default" : false, "description" : "Określa, czy zawieszenie dotyczy jedynie wysyłania powiadomień", "type" : "boolean" }, "service_id" : { "description" : "Identyfikator usługi, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "start_time" : { "description" : "Czas rozpoczęcia zawieszenia", "format" : "dateTime", "type" : "string" } }, "required" : [ "end_time", "service_id" ], "type" : "object" }, "suspension_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "suspension_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "end_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "only_notifications" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.interval" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.is_active" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.is_archived" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start_time" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "suspension_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "description", "end_time", "id", "only_notifications", "service_id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/suspension_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/suspension_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "suspension_sortable_field" : { "enum" : [ "description", "end_time", "id", "only_notifications", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start_time" ], "type" : "string" }, "suspension_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/suspension_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "system_stats" : { "additionalProperties" : false, "properties" : { "analyses" : { "description" : "Liczba wykonanych analiz", "minimum" : 0, "type" : "integer" }, "checks" : { "description" : "Liczba wykonanych sprawdzeń", "minimum" : 0, "type" : "integer" }, "errors" : { "description" : "Liczba błędnych sprawdzeń", "minimum" : 0, "type" : "integer" }, "failures" : { "description" : "Liczba wykrytych awarii", "minimum" : 0, "type" : "integer" }, "notifications" : { "description" : "Liczba wysłanych powiadomień", "minimum" : 0, "type" : "integer" } }, "required" : [ "checks", "errors", "failures", "notifications", "analyses" ], "type" : "object" }, "template" : { "additionalProperties" : true, "properties" : { "artifact_type_ids" : { "description" : "Identyfikatory typów artefaktów, które należy załączyć do powiadomień (dla kanałów, które wspierają załączniki)", "items" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "type" : "array" }, "end_subject" : { "default" : "Monit24 notification", "description" : "Szablon tematu powiadomienia o końcu zdarzenia (dla kanałów, które wspierają tematy powiadomień)", "maxLength" : 1000, "type" : "string" }, "end_template" : { "default" : "", "description" : "Szablon powiadomienia o końcu zdarzenia", "maxLength" : 10000, "type" : "string" }, "id" : { "description" : "Identyfikator szablonu", "minimum" : 1, "type" : "integer" }, "language_id" : { "default" : "pl", "description" : "Identyfikator języka powiadomień dla szablonu (klucz w słowniku `languages`)", "type" : "string" }, "name" : { "description" : "Nazwa szablonu", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "Identyfikator konta, do którego należy szablon", "minimum" : 1, "type" : "integer" }, "start_subject" : { "default" : "Monit24 notification", "description" : "Szablon tematu powiadomienia o początku zdarzenia (dla kanałów, które wspierają tematy powiadomień)", "maxLength" : 1000, "type" : "string" }, "start_template" : { "default" : "", "description" : "Szablon powiadomienia o początku zdarzenia", "maxLength" : 10000, "type" : "string" } }, "type" : "object" }, "template_create_data" : { "additionalProperties" : false, "properties" : { "artifact_type_ids" : { "description" : "Identyfikatory typów artefaktów, które należy załączyć do powiadomień (dla kanałów, które wspierają załączniki)", "items" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "type" : "array" }, "end_subject" : { "default" : "Monit24 notification", "description" : "Szablon tematu powiadomienia o końcu zdarzenia (dla kanałów, które wspierają tematy powiadomień)", "maxLength" : 1000, "type" : "string" }, "end_template" : { "default" : "", "description" : "Szablon powiadomienia o końcu zdarzenia", "maxLength" : 10000, "type" : "string" }, "language_id" : { "default" : "pl", "description" : "Identyfikator języka powiadomień dla szablonu (klucz w słowniku `languages`)", "type" : "string" }, "name" : { "description" : "Nazwa szablonu", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "owner_id" : { "description" : "Identyfikator konta, do którego należy szablon", "minimum" : 1, "type" : "integer" }, "start_subject" : { "default" : "Monit24 notification", "description" : "Szablon tematu powiadomienia o początku zdarzenia (dla kanałów, które wspierają tematy powiadomień)", "maxLength" : 1000, "type" : "string" }, "start_template" : { "default" : "", "description" : "Szablon powiadomienia o początku zdarzenia", "maxLength" : 10000, "type" : "string" } }, "required" : [ "artifact_type_ids", "name" ], "type" : "object" }, "template_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "template_filters" : { "additionalProperties" : false, "properties" : { "end_subject" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "end_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "language.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "language_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner.username" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start_subject" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "start_template" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "template_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "artifact_type_ids", "end_subject", "end_template", "id", "language_id", "name", "owner_id", "start_subject", "start_template" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/template_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/template_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "template_sortable_field" : { "enum" : [ "end_subject", "end_template", "id", "language.name", "language_id", "name", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_subject", "start_template" ], "type" : "string" }, "template_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/template_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" }, "template_variable" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "test_sms_notification_data" : { "additionalProperties" : false, "properties" : { "message" : { "maxLength" : 128, "type" : "string" } }, "required" : [ "message" ], "type" : "object" }, "time_range_info" : { "properties" : { "can_read_analyses" : { "description" : "Określa, czy można pobrać listę analiz dla danego przedziału", "type" : "boolean" }, "can_read_checks" : { "description" : "Określa, czy można pobrać listę sprawdzeń dla danego przedziału", "type" : "boolean" }, "estimated_checks_count" : { "description" : "Szacunkowa liczba sprawdzeń usługi w wybranym przedziale czasowym", "minimum" : 0, "type" : "integer" } }, "required" : [ "estimated_checks_count", "can_read_checks", "can_read_analyses" ], "type" : "object" }, "time_zone" : { "additionalProperties" : true, "properties" : { "description" : { "description" : "Opis wartości słownikowej", "nullable" : true, "type" : "string" }, "id" : { "description" : "Identyfikator wartości w słowniku", "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_]*$", "type" : "string" }, "name" : { "description" : "Nazwa wartości słownikowej", "type" : "string" } }, "type" : "object" }, "traceroute_diagnostic" : { "additionalProperties" : true, "properties" : { "id" : { "description" : "Identyfikator zapytania diagnostycznego", "maxLength" : 40, "minLength" : 40, "pattern" : "^[0-9a-f]*$", "type" : "string" }, "results" : { "$ref" : "#/components/schemas/array_of_traceroute_hops" }, "sensor_id" : { "description" : "Identyfikator stacji monitorującej, z której należy wykonać zapytanie", "minimum" : 1, "type" : "integer" }, "settings" : { "$ref" : "#/components/schemas/traceroute_diagnostics_settings" }, "status" : { "description" : "Status zapytania", "enum" : [ "pending", "in_progress", "completed" ], "type" : "string" } }, "type" : "object" }, "traceroute_diagnostic_create_data" : { "additionalProperties" : false, "properties" : { "sensor_id" : { "description" : "Identyfikator stacji monitorującej, z której należy wykonać zapytanie", "minimum" : 1, "type" : "integer" }, "settings" : { "$ref" : "#/components/schemas/traceroute_diagnostics_settings" } }, "required" : [ "sensor_id", "settings" ], "type" : "object" }, "traceroute_diagnostic_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "maxLength" : 40, "minLength" : 40, "pattern" : "^[0-9a-f]*$", "type" : "string" } }, "required" : [ "id" ], "type" : "object" }, "traceroute_diagnostics_settings" : { "additionalProperties" : false, "properties" : { "address" : { "description" : "Adres IP lub nazwa hosta, do którego trasę należy sprawdzić", "maxLength" : 256, "minLength" : 1, "pattern" : "^[0-9a-zA-Z\\-\\.]*$", "type" : "string" }, "interval_between_packets" : { "description" : "Opóźnienie pomiędzy pakietami w sekundach", "maximum" : 5, "minimum" : 0.1, "type" : "number" }, "number_of_packets" : { "description" : "Liczba pakietów, które należy wysłać", "maximum" : 16, "minimum" : 1, "type" : "integer" }, "resolve_hostnames" : { "description" : "Określa, czy należy resolwować nazwy hostów", "type" : "boolean" } }, "required" : [ "address", "number_of_packets", "interval_between_packets", "resolve_hostnames" ], "type" : "object" }, "traceroute_hop" : { "additionalProperties" : false, "properties" : { "avg" : { "description" : "Średni czas odpowiedzi w sekundach", "minimum" : 0, "nullable" : true, "type" : "number" }, "best" : { "description" : "Czas najszybszej odpowiedzi w sekundach", "minimum" : 0, "nullable" : true, "type" : "number" }, "host" : { "description" : "Nazwa hosta", "maxLength" : 256, "minLength" : 1, "type" : "string" }, "loss" : { "description" : "Procent strat pakietów", "maximum" : 100, "minimum" : 0, "nullable" : true, "type" : "number" }, "sent" : { "description" : "Liczba wysłanych pakietów", "minimum" : 0, "type" : "integer" }, "worst" : { "description" : "Czas najwolniejszej odpowiedzi w sekundach", "minimum" : 0, "nullable" : true, "type" : "number" } }, "required" : [ "host", "loss", "sent", "best", "avg", "worst" ], "type" : "object" }, "user_data" : { "additionalProperties" : true, "properties" : { "address" : { "description" : "Adres", "maxLength" : 128, "nullable" : true, "type" : "string" }, "contact_person" : { "description" : "Osoba do kontaktu", "maxLength" : 255, "nullable" : true, "type" : "string" }, "created_at" : { "description" : "Czas utworzenia konta", "format" : "dateTime", "type" : "string" }, "email_address" : { "description" : "Adres e-mail", "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "has_2fa_enabled" : { "default" : false, "description" : "Określa, czy konto ma skonfigurowane 2FA", "type" : "boolean" }, "id" : { "description" : "Identyfikator użytkownika (konta)", "minimum" : 1, "type" : "integer" }, "ip_whitelist" : { "default" : [], "description" : "Adresy IP lub klasy adresów IP, z których dozwolony jest dostęp do konta przez API", "items" : { "format" : "ip", "maxLength" : 256, "type" : "string" }, "type" : "array" }, "ip_whitelist_enabled" : { "default" : false, "description" : "Włącza ograniczenie dostępu do konta przez API do adresów IP określonych w polu `ip_whitelist`", "type" : "boolean" }, "phone_number" : { "description" : "Telefon kontaktowy", "maxLength" : 20, "nullable" : true, "pattern" : "^\\+?[0-9 ]*?$", "type" : "string" }, "settings" : { "description" : "Identyfikatory (klucze) zdefiniowanych ustawień użytkownika", "items" : { "maxLength" : 200, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_\\.]*$", "type" : "string" }, "type" : "array" }, "tax_identification_number" : { "description" : "NIP", "maxLength" : 10, "nullable" : true, "type" : "string" } }, "type" : "object" }, "user_data_create_data" : { "additionalProperties" : false, "properties" : { "address" : { "description" : "Adres", "maxLength" : 128, "nullable" : true, "type" : "string" }, "contact_person" : { "description" : "Osoba do kontaktu", "maxLength" : 255, "nullable" : true, "type" : "string" }, "email_address" : { "description" : "Adres e-mail", "maxLength" : 1024, "pattern" : "^\\S+\\@\\S+\\.\\S+$", "type" : "string" }, "ip_whitelist" : { "default" : [], "description" : "Adresy IP lub klasy adresów IP, z których dozwolony jest dostęp do konta przez API", "items" : { "format" : "ip", "maxLength" : 256, "type" : "string" }, "type" : "array" }, "ip_whitelist_enabled" : { "default" : false, "description" : "Włącza ograniczenie dostępu do konta przez API do adresów IP określonych w polu `ip_whitelist`", "type" : "boolean" }, "phone_number" : { "description" : "Telefon kontaktowy", "maxLength" : 20, "nullable" : true, "pattern" : "^\\+?[0-9 ]*?$", "type" : "string" }, "tax_identification_number" : { "description" : "NIP", "maxLength" : 10, "nullable" : true, "type" : "string" } }, "required" : [ "email_address" ], "type" : "object" }, "weekly_suspension" : { "additionalProperties" : true, "properties" : { "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "id" : { "description" : "Identyfikator tygodniowego zawieszenia", "minimum" : 1, "type" : "integer" }, "only_notifications" : { "default" : false, "description" : "Określa, czy zawieszenie dotyczy jedynie wysyłania powiadomień", "type" : "boolean" }, "service_id" : { "description" : "Identyfikator usługi, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "type" : "object" }, "weekly_suspension_create_data" : { "additionalProperties" : false, "properties" : { "description" : { "default" : "", "description" : "Opis zawieszenia", "maxLength" : 255, "type" : "string" }, "end_minute" : { "$ref" : "#/components/schemas/minute_of_week" }, "only_notifications" : { "default" : false, "description" : "Określa, czy zawieszenie dotyczy jedynie wysyłania powiadomień", "type" : "boolean" }, "service_id" : { "description" : "Identyfikator usługi, której dotyczy zawieszenie", "minimum" : 1, "type" : "integer" }, "start_minute" : { "$ref" : "#/components/schemas/minute_of_week" } }, "required" : [ "end_minute", "service_id", "start_minute" ], "type" : "object" }, "weekly_suspension_create_result" : { "additionalProperties" : false, "properties" : { "id" : { "minimum" : 1, "type" : "integer" } }, "required" : [ "id" ], "type" : "object" }, "weekly_suspension_filters" : { "additionalProperties" : false, "properties" : { "description" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "only_notifications" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.delete" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.own" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.read" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "permissions.update" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.interval" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.is_active" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.is_archived" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.name" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service.owner_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" }, "service_id" : { "items" : { "$ref" : "#/components/schemas/filter" }, "maxItems" : 32, "type" : "array" } }, "type" : "object" }, "weekly_suspension_search" : { "additionalProperties" : false, "properties" : { "embed" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "fields" : { "items" : { "enum" : [ "description", "end_minute", "id", "only_notifications", "service_id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "filters" : { "$ref" : "#/components/schemas/weekly_suspension_filters" }, "limit" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" }, "offset" : { "default" : 0, "minimum" : 0, "type" : "integer" }, "query" : { "type" : "string" }, "sort" : { "items" : { "$ref" : "#/components/schemas/weekly_suspension_sorter" }, "maxItems" : 256, "type" : "array" } }, "type" : "object" }, "weekly_suspension_sortable_field" : { "enum" : [ "description", "end_minute", "id", "only_notifications", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start_minute" ], "type" : "string" }, "weekly_suspension_sorter" : { "additionalProperties" : false, "properties" : { "field" : { "$ref" : "#/components/schemas/weekly_suspension_sortable_field" }, "order" : { "$ref" : "#/components/schemas/sort_order" } }, "required" : [ "field" ], "type" : "object" } }, "securitySchemes" : { "basic_auth" : { "description" : "Podstawowa autentykacja loginem i hasłem.", "scheme" : "basic", "type" : "http" }, "oauth2" : { "flows" : { "implicit" : { "authorizationUrl" : "https://api.monit24.pl/oauth2/authorize", "scopes" : { "administrator" : "Autoryzacja administratora Monit24.pl.", "customer" : "Autoryzacja użytkownika Monit24.pl." } } }, "type" : "oauth2" } } }, "externalDocs" : { "description" : "Strona główna dokumentacji", "url" : "https://api.monit24.pl/v3/public/doc/index.html" }, "info" : { "title" : "Monit24.pl API", "version" : "3.51" }, "openapi" : "3.0.3", "paths" : { "/accounts" : { "get" : { "description" : "Zwraca listę kont.", "operationId" : "accounts_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone_id", "username", "-disable_legacy_notifications", "-id", "-is_activated", "-is_blocked", "-is_read_only", "-language_id", "-name", "-package_id", "-parent_account_id", "-permissions.close", "-permissions.create_contact_groups", "-permissions.create_contacts", "-permissions.create_customer_portal_sessions", "-permissions.create_events", "-permissions.create_groups", "-permissions.create_report_templates", "-permissions.create_subaccounts", "-permissions.create_templates", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.read_logs", "-permissions.read_stats", "-permissions.setup_2fa", "-permissions.share_groups", "-permissions.update", "-time_zone_id", "-username" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "custom_activation_uri!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "disable_legacy_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "disable_legacy_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_activated", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_activated!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_blocked", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_blocked!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_read_only", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_read_only!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "package_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "package_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "parent_account_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "parent_account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "password!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "redirect_uri!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "time_zone_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time_zone_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "time_zone_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.close", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.close!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_contact_groups", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_contact_groups!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_contacts", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_contacts!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_customer_portal_sessions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_customer_portal_sessions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_events", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_events!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_groups", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_groups!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_report_templates", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_report_templates!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_subaccounts", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_subaccounts!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_templates", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_templates!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read_logs", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read_logs!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read_stats", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read_stats!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.setup_2fa", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.setup_2fa!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.share_groups", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.share_groups!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_accounts" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę kont.", "tags" : [ "accounts" ] }, "post" : { "description" : "Tworzy dodatkowego użytkownika konta.\n\nWartość pola `package_id` nie ma w tej operacji znaczenia - dla dodatkowych użytkowników każdorazowo tworzony jest nowy, pusty pakiet.", "operationId" : "accounts_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `username_unavailable` (4033337): Login jest już zajęty." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `language_not_found` (4044763): Nie znaleziono języka.\n* `time_zone_not_found` (4043825): Nie znaleziono strefy czasowej." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy dodatkowego użytkownika konta.", "tags" : [ "accounts" ] } }, "/accounts/register" : { "post" : { "description" : "Zakłada nowe konto.\n\nNa adres podany w polu `user_data.email_address` zostanie wysłany e-mail z linkiem umożliwiającym aktywację konta.\n\nPole `package_id` powinno zawierać identyfikator jednego z publicznie dostępnych pakietów (do pobrania za pomocą operacji `GET /packages/available_for_new_accounts`).\nDomyślnie używany jest pakiet PODSTAWOWY.\n\nRejestracja konta z wykorzystaniem tej operacji oznacza akceptację [regulaminu korzystania z usługi](https://monit24.pl/regulamin/) Monit24.pl.", "operationId" : "accounts_register", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `registration_temporarily_unavailable` (4033672): Rejestracja nowych użytkowników jest tymczasowo wyłączona.\n* `username_unavailable` (4033337): Login jest już zajęty." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `language_not_found` (4044763): Nie znaleziono języka.\n* `package_not_found` (4046424): Nie znaleziono pakietu.\n* `time_zone_not_found` (4043825): Nie znaleziono strefy czasowej." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zakłada nowe konto.", "tags" : [ "accounts" ] } }, "/accounts/search" : { "post" : { "description" : "Zaawansowane pobieranie kont.", "operationId" : "accounts_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_accounts" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie kont.", "tags" : [ "accounts" ] } }, "/accounts/{_account_id}/logs/authentications" : { "get" : { "description" : "Zwraca logi pomyślnych autentykacji do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nZa pomocą tej operacji można pobrać historię pomyślnych autentykacji (logowań) do konta z ostatnich 400 dni wykonanych za pomocą OAuth2 lub zasobu `auth_token`.\n\nDomyślnie wyniki są sortowane malejąco po czasie wystąpienia zmiany stanu (`time`).", "operationId" : "accounts_read_authentications", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "client_id", "client_ip_address", "time", "type", "user_ip_address" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "client_id", "client_ip_address", "time", "type", "user_ip_address", "-client_id", "-client_ip_address", "-time", "-type", "-user_ip_address" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "client_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "client_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "client_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "client_ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "client_ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "client_ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "type", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "user_ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "user_ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "user_ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_authentications" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_logs_unavailable` (4031278): Brak uprawnień do przeglądania logów konta.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca logi pomyślnych autentykacji do konta.", "tags" : [ "logs" ] } }, "/accounts/{_account_id}/logs/contact_notifications" : { "get" : { "description" : "Zwraca logi powiadomień wysłanych do kontaktów należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nLogi są przechowywane przez 400 dni.\n\nDomyślnie wyniki są sortowane malejąco po czasie wysłania powiadomienia (`time`).", "operationId" : "accounts_read_contact_notifications", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "contact_address", "contact_address.address", "contact_address.channel_id", "contact_address.contact_id", "contact_address.id", "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "address", "address_id", "channel_id", "contact_id", "content", "escalation_id", "event_id", "id", "service_id", "subject", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "address_id", "channel_id", "contact_id", "content", "escalation_id", "event_id", "id", "service_id", "subject", "time", "-address", "-address_id", "-channel_id", "-contact_id", "-content", "-escalation_id", "-event_id", "-id", "-service_id", "-subject", "-time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "address_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "content", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "content!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "content~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "subject", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "subject!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "subject~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_notifications" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_logs_unavailable` (4031278): Brak uprawnień do przeglądania logów konta.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca logi powiadomień wysłanych do kontaktów należących do konta.", "tags" : [ "logs" ] } }, "/accounts/{_account_id}/logs/contact_notifications/{_id}" : { "get" : { "description" : "Zwraca pojedyncze powiadomienie wysłane do kontaktu.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_contact_notification", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator powiadomienia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "contact_address", "contact_address.address", "contact_address.channel_id", "contact_address.contact_id", "contact_address.id", "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "address", "address_id", "channel_id", "contact_id", "content", "escalation_id", "event_id", "id", "service_id", "subject", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_notification" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_logs_unavailable` (4031278): Brak uprawnień do przeglądania logów konta.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `contact_notification_not_found` (4046166): Nie znaleziono powiadomienia kontaktu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze powiadomienie wysłane do kontaktu.", "tags" : [ "logs" ] } }, "/accounts/{_account_id}/logs/event_status_changes" : { "get" : { "description" : "Zwraca logi zmian stanów zdarzeń należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nZa pomocą tej operacji można pobrać zmiany stanów z ostatnich 400 dni.\nPełna historia dostępna jest jedynie dla poszczególnych par usługa-zdarzenie (zasób `/services/{_id}/event_history/{_event_id}/status_changes`).\n\nDomyślnie wyniki są sortowane malejąco po czasie wystąpienia zmiany stanu (`start_time`).", "operationId" : "accounts_read_event_status_changes", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "duration", "end_time", "event_id", "first_analysis_id", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "duration", "end_time", "event_id", "first_analysis_id", "service_id", "start_time", "status", "-change_id", "-duration", "-end_time", "-event_id", "-first_analysis_id", "-service_id", "-start_time", "-status" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "change_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "change_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "change_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "duration", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "duration!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "first_analysis_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "first_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "first_analysis_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_event_status_change_logs" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_logs_unavailable` (4031278): Brak uprawnień do przeglądania logów konta.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca logi zmian stanów zdarzeń należących do konta.", "tags" : [ "logs" ] } }, "/accounts/{_account_id}/logs/notifications" : { "get" : { "description" : "Zwraca logi wysłanych powiadomień dla konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nLogi są przechowywane przez 400 dni.\n\nDomyślnie wyniki są sortowane malejąco po czasie wysłania powiadomienia (`time`).", "operationId" : "accounts_read_notifications", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "notification_channel", "notification_channel.description", "notification_channel.id", "notification_channel.name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "address", "content", "id", "notification_channel_id", "subject", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "content", "id", "notification_channel_id", "subject", "time", "-address", "-content", "-id", "-notification_channel_id", "-subject", "-time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "content", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "content!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "content~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "notification_channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "notification_channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "notification_channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "subject", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "subject!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "subject~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notifications" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_logs_unavailable` (4031278): Brak uprawnień do przeglądania logów konta.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca logi wysłanych powiadomień dla konta.", "tags" : [ "logs" ] } }, "/accounts/{_account_id}/logs/notifications/{_id}" : { "get" : { "description" : "Zwraca pojedyncze powiadomienie.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_notification", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator powiadomienia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "notification_channel", "notification_channel.description", "notification_channel.id", "notification_channel.name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "address", "content", "id", "notification_channel_id", "subject", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_logs_unavailable` (4031278): Brak uprawnień do przeglądania logów konta.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `notification_not_found` (4043611): Nie znaleziono powiadomienia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze powiadomienie.", "tags" : [ "logs" ] } }, "/accounts/{_account_id}/logs/status_changes" : { "get" : { "description" : "Zwraca logi zmian stanów usług należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nZa pomocą tej operacji można pobrać zmiany stanów z ostatnich 400 dni.\nPełna historia dostępna jest jedynie dla poszczególnych usług (zasób `/services/{_id}/history/status_changes`).\n\nDomyślnie wyniki są sortowane malejąco po czasie wystąpienia zmiany stanu (`start_time`).", "operationId" : "accounts_read_status_changes", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "correction_stats", "correction_stats.count", "correction_stats.duration", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "description", "duration", "end_time", "first_analysis_id", "pause_reason", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "description", "duration", "end_time", "first_analysis_id", "pause_reason", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_id", "start_time", "status", "-change_id", "-description", "-duration", "-end_time", "-first_analysis_id", "-pause_reason", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service_id", "-start_time", "-status" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "change_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "change_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "change_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "duration", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "duration!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "first_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "pause_reason", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "pause_reason!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "pause_reason~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_status_change_logs" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_logs_unavailable` (4031278): Brak uprawnień do przeglądania logów konta.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca logi zmian stanów usług należących do konta.", "tags" : [ "logs" ] } }, "/accounts/{_id}" : { "delete" : { "description" : "Usuwa dodatkowego użytkownika konta.", "operationId" : "accounts_delete", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa dodatkowego użytkownika konta.", "tags" : [ "accounts" ] }, "get" : { "description" : "Zwraca pojedyncze konto.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze konto.", "tags" : [ "accounts" ] }, "put" : { "description" : "Modyfikuje ustawienia konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id`, `is_activated`, `is_blocked`, `is_read_only`, `package_id`, `parent_account_id` oraz `username`.", "operationId" : "accounts_update", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `language_not_found` (4044763): Nie znaleziono języka.\n* `time_zone_not_found` (4043825): Nie znaleziono strefy czasowej." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje ustawienia konta.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/2fa/setup" : { "post" : { "description" : "Generuje i zwraca klucz 2FA dla konta. Aby zakończyć konfigurację 2FA należy na jego podstawie wygenerować token TOTP i potwierdzić operacją 2fa/verify.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nWymagane jest uprawnienie `setup_2fa` do konta.", "operationId" : "accounts_setup_2fa", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "properties" : { "key" : { "description" : "Klucz 2FA", "maxLength" : 32, "minLength" : 32, "pattern" : "^[A-Z0-9]*$", "type" : "string" } }, "required" : [ "key" ], "type" : "object" } } }, "description" : "Poprawne wykonanie operacji", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `2fa_setup_not_allowed` (4030421): Nie można skonfigurować 2FA dla konta.\n* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Generuje i zwraca klucz 2FA dla konta. Aby zakończyć konfigurację 2FA należy na jego podstawie wygenerować token TOTP i potwierdzić operacją 2fa/verify.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/2fa/verify" : { "post" : { "description" : "Weryfikuje jednorazowy kod 2FA i włącza 2FA dla konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nWymagane jest uprawnienie `setup_2fa` do konta.", "operationId" : "accounts_verify_2fa", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "properties" : { "code" : { "description" : "Sześciocyfrowy kod wygenerowany na podstawie klucza 2FA", "maxLength" : 6, "minLength" : 6, "pattern" : "^[0-9]*$", "type" : "string" } }, "required" : [ "code" ], "type" : "object" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `2fa_code_invalid` (4033708): Niepoprawny kod 2FA.\n* `2fa_setup_not_allowed` (4030421): Nie można skonfigurować 2FA dla konta.\n* `2fa_setup_required` (4030114): Wymagane wygenerowanie klucza 2FA.\n* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Weryfikuje jednorazowy kod 2FA i włącza 2FA dla konta.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/activate" : { "get" : { "description" : "Aktywuje konto.\n\nAktywuje konto i opcjonalnie przekierowuje na adres wskazany przy rejestracji.", "operationId" : "accounts_activate", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tekst", "in" : "query", "name" : "redirect_uri", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Tekst", "in" : "query", "name" : "token", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account_activation_result" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "301" : { "description" : "Przekierowanie na adres wskazany przy rejestracji.", "headers" : { "Location" : { "description" : "Adres wskazany przy rejestracji.", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_already_activated` (4035649): Konto zostało już aktywowane.\n* `activation_token_incorrect` (4037237): Podano niepoprawny token aktywacji konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Aktywuje konto.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/available_sensors" : { "get" : { "description" : "Zwraca listę stacji monitorujących dostępnych dla konta.\n\n\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "accounts_read_available_sensors", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę stacji monitorujących dostępnych dla konta.", "tags" : [ "sensors", "accounts" ] } }, "/accounts/{_id}/available_service_types" : { "get" : { "description" : "Zwraca listę typów usług do wykorzystania w pakiecie dla konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych po identyfikatorze typu.", "operationId" : "accounts_read_available_service_types", "parameters" : [ { "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "service_type", "service_type.address_prefix", "service_type.category_id", "service_type.customizable_step_names", "service_type.description", "service_type.id", "service_type.manual_schedule", "service_type.name", "service_type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "minimum_interval", "remaining_services", "service_type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "minimum_interval", "service_type_id", "-account_id", "-minimum_interval", "-service_type_id" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "account_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum_interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum_interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "remaining_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_type_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_type_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service_type_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_service_type_limits" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę typów usług do wykorzystania w pakiecie dla konta.", "tags" : [ "service_types", "accounts" ] } }, "/accounts/{_id}/change_password" : { "post" : { "description" : "Zmienia hasło do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_change_password", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/password_update_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `incorrect_old_password` (4036334): Niepoprawne dotychczasowe hasło.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zmienia hasło do konta.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/close" : { "post" : { "description" : "Zamyka konto.\n\nZamknięcie konta powoduje zatrzymanie wszystkich usług na koncie, wyłączenie powiadomień i raportów oraz możliwości zalogowania. Wszystkie dane powiązane z kontem zostaną usunięte w czasie maksymalnie 7 dni.", "operationId" : "accounts_close_account", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/close_account_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `close_not_allowed` (4030017): Nie można zamknąć konta. Skontaktuj się z Biurem Obsługi Klienta.\n* `incorrect_password` (4038521): Niepoprawne hasło.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zamyka konto.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/contact_groups" : { "get" : { "description" : "Zwraca listę grup kontaktów należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_contact_groups", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "contacts", "contacts.description", "contacts.id", "contacts.language_id", "contacts.name", "contacts.owner_id", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_ids", "description", "id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-description", "-id", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_groups" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę grup kontaktów należących do konta.", "tags" : [ "contacts", "accounts" ] } }, "/accounts/{_id}/contacts" : { "get" : { "description" : "Zwraca listę kontaktów należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_contacts", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner.name", "owner.username", "owner_id", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-description", "-id", "-language_id", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.create_addresses", "-permissions.create_suspensions", "-permissions.create_weekly_suspensions", "-permissions.customize_templates", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_addresses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_weekly_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_weekly_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.customize_templates", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.customize_templates!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contacts" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę kontaktów należących do konta.", "tags" : [ "contacts", "accounts" ] } }, "/accounts/{_id}/customer_portal_sessions" : { "post" : { "description" : "Tworzy nową sesję portalu billingowego.", "operationId" : "accounts_create_customer_portal_session", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "properties" : { "return_url" : { "default" : "https://panel.monit24.pl", "pattern" : "^https?:\\/\\/", "type" : "string" } }, "type" : "object" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "properties" : { "url" : { "pattern" : "^https?:\\/\\/", "type" : "string" } }, "required" : [ "url" ], "type" : "object" } } }, "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nową sesję portalu billingowego.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/default_group" : { "get" : { "description" : "Zwraca domyślną grupę wybranego konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_default_group", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "stats", "stats.id", "stats.sensors_count", "stats.services_count", "stats.services_count_archived", "stats.services_count_failure", "stats.services_count_ok", "stats.services_count_paused", "stats.services_count_suspended", "stats.services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "assigned_sensor_ids", "id", "is_default", "name", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "sensor_ids" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca domyślną grupę wybranego konta.", "tags" : [ "groups", "accounts" ] } }, "/accounts/{_id}/events" : { "get" : { "description" : "Zwraca listę zdarzeń należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_events", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "error_type_categories", "error_type_categories.description", "error_type_categories.id", "error_type_categories.name", "excluded_error_type_categories", "excluded_error_type_categories.description", "excluded_error_type_categories.id", "excluded_error_type_categories.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "required_events", "required_events.account_ids", "required_events.description", "required_events.disable_elements", "required_events.disable_main_content", "required_events.disable_steps", "required_events.error_on_elements", "required_events.error_type_category_ids", "required_events.excluded_error_type_category_ids", "required_events.group_ids", "required_events.id", "required_events.is_persistent", "required_events.maximum_sensors_percentage", "required_events.metrics", "required_events.minimum_response_time", "required_events.name", "required_events.owner_id", "required_events.priority", "required_events.required_event_ids", "required_events.sensors_percentage", "required_events.service_ids", "required_events.unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_ids", "description", "disable_elements", "disable_main_content", "disable_steps", "error_on_elements", "error_type_category_ids", "excluded_error_type_category_ids", "group_ids", "id", "is_persistent", "maximum_sensors_percentage", "metrics", "minimum_response_time", "name", "owner_id", "priority", "required_event_ids", "sensors_percentage", "service_ids", "unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "disable_elements", "disable_main_content", "error_on_elements", "id", "is_persistent", "maximum_sensors_percentage", "minimum_response_time", "name", "owner.name", "owner.username", "owner_id", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "priority", "sensors_percentage", "unknown_check_results", "-description", "-disable_elements", "-disable_main_content", "-error_on_elements", "-id", "-is_persistent", "-maximum_sensors_percentage", "-minimum_response_time", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.create_escalations", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-priority", "-sensors_percentage", "-unknown_check_results" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "disable_elements", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "disable_elements!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "disable_main_content", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "disable_main_content!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_on_elements", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_on_elements!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_persistent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_persistent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_sensors_percentage", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_sensors_percentage!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum_response_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum_response_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "priority", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sensors_percentage", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensors_percentage!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "unknown_check_results", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "unknown_check_results!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "unknown_check_results~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_escalations", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_escalations!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_events" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zdarzeń należących do konta.", "tags" : [ "events", "accounts" ] } }, "/accounts/{_id}/group_shares" : { "get" : { "description" : "Zwraca listę udostępnień grup należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_group_shares", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "account", "account.disable_legacy_notifications", "account.id", "account.is_activated", "account.is_blocked", "account.is_read_only", "account.language_id", "account.name", "account.package_id", "account.parent_account_id", "account.time_zone_id", "account.username", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "can_archive_services", "can_create_services", "can_delete_services", "can_force_analyses", "can_modify_group", "can_modify_services", "group_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "account.name", "account.username", "account_id", "can_archive_services", "can_create_services", "can_delete_services", "can_force_analyses", "can_modify_group", "can_modify_services", "group.is_default", "group.name", "group.owner_id", "group_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-account.name", "-account.username", "-account_id", "-can_archive_services", "-can_create_services", "-can_delete_services", "-can_force_analyses", "-can_modify_group", "-can_modify_services", "-group.is_default", "-group.name", "-group.owner_id", "-group_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "account_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_archive_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_archive_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_create_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_create_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_delete_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_delete_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_force_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_force_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_modify_group", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_modify_group!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_modify_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_modify_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "account.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "account.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "account.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "account.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.is_default", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.is_default!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_group_shares" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę udostępnień grup należących do konta.", "tags" : [ "groups", "accounts" ] } }, "/accounts/{_id}/groups" : { "get" : { "description" : "Zwraca listę grup należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_groups", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "stats", "stats.id", "stats.sensors_count", "stats.services_count", "stats.services_count_archived", "stats.services_count_failure", "stats.services_count_ok", "stats.services_count_paused", "stats.services_count_suspended", "stats.services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "assigned_sensor_ids", "id", "is_default", "name", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "sensor_ids" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "id", "is_default", "name", "owner.name", "owner.username", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "stats.sensors_count", "stats.services_count", "-archived_services_in_periodic_reports", "-id", "-is_default", "-name", "-owner.name", "-owner.username", "-owner_id", "-periodic_daily_reports", "-periodic_monthly_reports", "-periodic_weekly_reports", "-permissions.create_notification_addresses", "-permissions.create_periodic_report_addresses", "-permissions.create_services", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.send_test_sms_notifications", "-permissions.share", "-permissions.update", "-stats.sensors_count", "-stats.services_count" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "archived_services_in_periodic_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "archived_services_in_periodic_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_default", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_default!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "periodic_daily_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "periodic_daily_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "periodic_monthly_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "periodic_monthly_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "periodic_weekly_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "periodic_weekly_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_notification_addresses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_notification_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_periodic_report_addresses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_periodic_report_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.share", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.share!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.sensors_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.services_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_groups" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę grup należących do konta.", "tags" : [ "groups", "accounts" ] } }, "/accounts/{_id}/language" : { "get" : { "description" : "Zwraca domyślny język powiadomień i raportów dla konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "accounts_read_language", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/language" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `language_not_found` (4044763): Nie znaleziono języka." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca domyślny język powiadomień i raportów dla konta.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/notification_addresses" : { "get" : { "description" : "Zwraca listę adresów powiadomień należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_notification_addresses", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "notification_channel", "notification_channel.description", "notification_channel.id", "notification_channel.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group_id", "id", "notification_channel_id", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group.name", "group_id", "id", "notification_channel_id", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update", "-address", "-description", "-group.name", "-group_id", "-id", "-notification_channel_id", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.send_test_sms_notifications", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "notification_channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "notification_channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "notification_channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów powiadomień należących do konta.", "tags" : [ "notification_addresses", "accounts" ] } }, "/accounts/{_id}/package" : { "get" : { "description" : "Zwraca pakiet przypisany do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_package", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channels", "available_notification_channels.description", "available_notification_channels.id", "available_notification_channels.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channel_ids", "available_service_types", "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/package" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `package_not_found` (4046424): Nie znaleziono pakietu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pakiet przypisany do konta.", "tags" : [ "packages", "accounts" ] } }, "/accounts/{_id}/periodic_report_addresses" : { "get" : { "description" : "Zwraca listę adresów raportów okresowych należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_periodic_report_addresses", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "report_frequency" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "report_frequency", "-address", "-group_id", "-id", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-report_frequency" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "report_frequency", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "report_frequency!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "report_frequency~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_periodic_report_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów raportów okresowych należących do konta.", "tags" : [ "periodic_report_addresses", "accounts" ] } }, "/accounts/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_permissions", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "close", "create_contact_groups", "create_contacts", "create_customer_portal_sessions", "create_events", "create_groups", "create_report_templates", "create_subaccounts", "create_templates", "delete", "own", "read", "read_logs", "read_stats", "setup_2fa", "share_groups", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego konta.", "tags" : [ "permissions", "accounts" ] } }, "/accounts/{_id}/report_templates" : { "get" : { "description" : "Zwraca listę szablonów raportów należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_report_templates", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_reports", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plans", "reporting_plans.description", "reporting_plans.id", "reporting_plans.name", "sections", "sections.description", "sections.id", "sections.name", "stats", "stats.created_at", "stats.id", "stats.last_report_generated_at", "stats.reports_count" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name_template", "generate_pdf", "group_info", "id", "owner_id", "reporting_plan_ids", "requested_scope", "section_ids", "service_level_events", "summary", "title", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "context_data", "delay", "description", "email_subject_template", "email_template", "file_name_template", "generate_pdf", "group_info", "id", "owner.name", "owner.username", "owner_id", "permissions.create_reports", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "stats.created_at", "stats.last_report_generated_at", "stats.reports_count", "summary", "title", "-account_info", "-archived_services", "-context_data", "-delay", "-description", "-email_subject_template", "-email_template", "-file_name_template", "-generate_pdf", "-group_info", "-id", "-owner.name", "-owner.username", "-owner_id", "-permissions.create_reports", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-stats.created_at", "-stats.last_report_generated_at", "-stats.reports_count", "-summary", "-title" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "account_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "account_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "archived_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "archived_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "context_data", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "context_data!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "delay", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "delay!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_subject_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_subject_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_subject_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generate_pdf", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generate_pdf!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "title", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "title!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "title~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.created_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.last_report_generated_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.reports_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_report_templates" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę szablonów raportów należących do konta.", "tags" : [ "report_templates", "accounts" ] } }, "/accounts/{_id}/reports" : { "get" : { "description" : "Zwraca listę raportów należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nPole `reporting_plan.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "accounts_read_reports", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "generated_attachments", "generated_attachments.content_type", "generated_attachments.file_name", "generated_attachments.report_id", "generated_attachments.type_id", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plan", "reporting_plan.description", "reporting_plan.id", "reporting_plan.name", "sections", "sections.description", "sections.id", "sections.name", "template", "template.account_info", "template.archived_services", "template.attachment_type_ids", "template.context_data", "template.delay", "template.description", "template.email_addresses", "template.email_subject_template", "template.email_template", "template.file_name_template", "template.generate_pdf", "template.group_info", "template.id", "template.owner_id", "template.reporting_plan_ids", "template.requested_scope", "template.section_ids", "template.service_level_events", "template.summary", "template.title", "template.weekly_suspensions", "token", "token.report_id", "token.session_id", "token.suggested_file_name", "token.token" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "created_at", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name", "file_name_template", "from", "generate_pdf", "generated_at", "generated_attachment_ids", "generating_progress", "generating_status", "group_info", "id", "owner_id", "progress", "rendering_progress", "rendering_status", "reporting_plan_id", "requested_scope", "section_ids", "service_level_events", "status", "summary", "template_id", "title", "to", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "context_data", "created_at", "delay", "description", "email_subject_template", "email_template", "file_name", "file_name_template", "from", "generate_pdf", "generated_at", "generating_progress", "generating_status", "group_info", "id", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "progress", "rendering_progress", "rendering_status", "reporting_plan.name", "reporting_plan_id", "status", "summary", "template.title", "template_id", "title", "to", "-account_info", "-archived_services", "-context_data", "-created_at", "-delay", "-description", "-email_subject_template", "-email_template", "-file_name", "-file_name_template", "-from", "-generate_pdf", "-generated_at", "-generating_progress", "-generating_status", "-group_info", "-id", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-progress", "-rendering_progress", "-rendering_status", "-reporting_plan.name", "-reporting_plan_id", "-status", "-summary", "-template.title", "-template_id", "-title", "-to" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "account_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "account_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "archived_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "archived_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "context_data", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "context_data!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "created_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "delay", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "delay!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_subject_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_subject_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_subject_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "from!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generate_pdf", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generate_pdf!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generated_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generating_progress", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generating_progress!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generating_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generating_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "generating_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "progress", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "progress!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "rendering_progress", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "rendering_progress!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "rendering_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "rendering_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "rendering_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "reporting_plan_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "reporting_plan_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "reporting_plan_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "template_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "template_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "title", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "title!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "title~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "to!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "reporting_plan.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "reporting_plan.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "reporting_plan.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "template.title", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "template.title!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "template.title~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_reports" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę raportów należących do konta.", "tags" : [ "reports", "accounts" ] } }, "/accounts/{_id}/services" : { "get" : { "description" : "Zwraca listę usług należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.", "operationId" : "accounts_read_services", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "monitoring_sensors", "monitoring_sensors.city", "monitoring_sensors.continent", "monitoring_sensors.country", "monitoring_sensors.dns_diagnostics_available", "monitoring_sensors.id", "monitoring_sensors.ip_address", "monitoring_sensors.ipv6_address", "monitoring_sensors.is_available", "monitoring_sensors.is_enabled", "monitoring_sensors.links", "monitoring_sensors.name", "monitoring_sensors.service_type_category_ids", "monitoring_sensors.traceroute_diagnostics_available", "notification_channels", "notification_channels.description", "notification_channels.id", "notification_channels.name", "notification_conditions", "notification_conditions.description", "notification_conditions.id", "notification_conditions.name", "notification_mode", "notification_mode.description", "notification_mode.id", "notification_mode.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "recovery_notification_mode", "recovery_notification_mode.description", "recovery_notification_mode.id", "recovery_notification_mode.name", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "status", "status.average_response_time", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.id", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.last_failure_analysis_id", "status.last_failure_analysis_time", "status.last_ok_analysis_id", "status.last_ok_analysis_time", "status.monitoring_status", "status.notifications_status", "status.summary", "type", "type.address_prefix", "type.category_id", "type.customizable_step_names", "type.description", "type.id", "type.manual_schedule", "type.name", "type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "extended_settings", "group_id", "id", "interval", "is_active", "is_archived", "name", "notification_channel_ids", "notification_condition_ids", "notification_mode_id", "owner_id", "recovery_notification_mode_id", "sensor_ids", "silent_hours", "step_names", "suspension_hours", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group.is_default", "group.name", "group_id", "id", "interval", "is_active", "is_archived", "name", "owner.name", "owner.username", "owner_id", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.monitoring_status", "status.summary", "type.category_id", "type.name", "type_id", "-address", "-description", "-group.is_default", "-group.name", "-group_id", "-id", "-interval", "-is_active", "-is_archived", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.archive", "-permissions.create_corrections", "-permissions.create_scheduled_suspensions", "-permissions.create_suspensions", "-permissions.create_weekly_suspensions", "-permissions.delete", "-permissions.force_analyses", "-permissions.force_custom_analyses", "-permissions.own", "-permissions.read", "-permissions.restore", "-permissions.send_test_sms_notifications", "-permissions.update", "-permissions.update_step_names", "-status.check_status", "-status.check_status_is_up_to_date", "-status.highest_active_event_priority", "-status.last_analysis_id", "-status.last_analysis_time", "-status.last_check_status_change_time", "-status.monitoring_status", "-status.summary", "-type.category_id", "-type.name", "-type_id" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "notification_mode_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "recovery_notification_mode_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "silent_hours!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "suspension_hours!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.is_default", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.is_default!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.archive", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.archive!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_corrections", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_corrections!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_scheduled_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_scheduled_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_weekly_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_weekly_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.force_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.force_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.force_custom_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.force_custom_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.restore", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.restore!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update_step_names", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update_step_names!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.check_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.check_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.check_status_is_up_to_date", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.check_status_is_up_to_date!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.check_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.highest_active_event_priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.last_analysis_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.last_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.last_analysis_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.last_analysis_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.last_check_status_change_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.last_check_status_change_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.monitoring_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.monitoring_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.monitoring_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type.category_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type.category_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type.category_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_services" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę usług należących do konta.", "tags" : [ "services", "accounts" ] } }, "/accounts/{_id}/stats" : { "get" : { "description" : "Zwraca statystyki konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nPobranie statystyk wymaga uprawnienia `read_stats` do konta.", "operationId" : "accounts_read_stats", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account_stats" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `account_stats_unavailable` (4033740): Brak uprawnień do pobrania statystyk konta.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca statystyki konta.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/stats/by_service_type_category" : { "get" : { "description" : "Zwraca statystyki konta z podziałem na kategorie typów usług.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nPobranie statystyk wymaga uprawnienia `read_stats` do konta.", "operationId" : "accounts_read_stats_by_service_type_category", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/account_stats_by_service_type_category" }, "type" : "array" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `account_stats_unavailable` (4033740): Brak uprawnień do pobrania statystyk konta.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca statystyki konta z podziałem na kategorie typów usług.", "tags" : [ "accounts" ] } }, "/accounts/{_id}/templates" : { "get" : { "description" : "Zwraca listę szablonów powiadomień należących do konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nPole `language.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "accounts_read_templates", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "artifact_type_ids", "end_subject", "end_template", "id", "language_id", "name", "owner_id", "start_subject", "start_template" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "end_subject", "end_template", "id", "language.name", "language_id", "name", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_subject", "start_template", "-end_subject", "-end_template", "-id", "-language.name", "-language_id", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_subject", "-start_template" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "end_subject", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_subject!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_subject~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_subject", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_subject!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_subject~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_templates" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę szablonów powiadomień należących do konta.", "tags" : [ "templates", "accounts" ] } }, "/accounts/{_id}/time_zone" : { "get" : { "description" : "Zwraca domyślną strefę czasową zawieszeń tygodniowych i trybu cichego dla konta.\n\nMożliwe jest użycie specjalnej wartości \"my_account\" zamiast identyfikatora, aby wybrać własne konto lub \"main_account\" aby wybrać konto nadrzędne (jeśli istnieje) lub własne.\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "accounts_read_time_zone", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/time_zone" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `time_zone_not_found` (4043825): Nie znaleziono strefy czasowej." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca domyślną strefę czasową zawieszeń tygodniowych i trybu cichego dla konta.", "tags" : [ "accounts" ] } }, "/admin/accounts" : { "get" : { "description" : "Zwraca listę kont.", "operationId" : "admin_read_all_accounts", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "permissions", "permissions.block", "permissions.delete", "permissions.own", "permissions.read", "permissions.unblock", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "comment", "contact_person", "email_address", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "phone_number", "tax_identification_number", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "comment", "contact_person", "email_address", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "permissions.block", "permissions.delete", "permissions.own", "permissions.read", "permissions.unblock", "permissions.update", "phone_number", "tax_identification_number", "time_zone_id", "username", "-address", "-comment", "-contact_person", "-email_address", "-id", "-is_activated", "-is_blocked", "-is_read_only", "-language_id", "-name", "-package_id", "-parent_account_id", "-permissions.block", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.unblock", "-permissions.update", "-phone_number", "-tax_identification_number", "-time_zone_id", "-username" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "comment", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "comment!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "comment~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact_person", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact_person!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "contact_person~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "create_notification_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_activated", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_activated!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_blocked", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_blocked!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_read_only", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_read_only!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "package_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "package_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "parent_account_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "parent_account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "password!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "phone_number", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "phone_number!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "phone_number~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "tax_identification_number", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "tax_identification_number!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "tax_identification_number~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "time_zone_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time_zone_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "time_zone_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.block", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.block!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.unblock", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.unblock!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_admin_accounts" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Zwraca listę kont.", "tags" : [ "admin" ] }, "post" : { "description" : "Tworzy nowe konto.\n\nMożliwe jest tworzenie kont z pakietami, do których posiadamy uprawnienie `create_accounts`. Utworzone konto jest automatycznie aktywowane.", "operationId" : "admin_create_account", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/admin_account_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/admin_account_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `username_unavailable` (4033337): Login jest już zajęty." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `language_not_found` (4044763): Nie znaleziono języka.\n* `package_not_found` (4046424): Nie znaleziono pakietu.\n* `time_zone_not_found` (4043825): Nie znaleziono strefy czasowej." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Tworzy nowe konto.", "tags" : [ "admin" ] } }, "/admin/accounts/search" : { "post" : { "description" : "Zaawansowane pobieranie kont.", "operationId" : "admin_search_accounts", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/admin_account_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_admin_accounts" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Zaawansowane pobieranie kont.", "tags" : [ "admin" ] } }, "/admin/accounts/{_id}" : { "delete" : { "description" : "Usuwa konto.\n\nTa operacja nieodwracalnie usuwa konto użytkownika wraz z jego grupami i usługami. W wyniku usunięcia konta, jego subkonta staną się kontami głównymi.", "operationId" : "admin_delete_account", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Usuwa konto.", "tags" : [ "admin" ] }, "get" : { "description" : "Zwraca pojedyncze konto.", "operationId" : "admin_read_account", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "permissions", "permissions.block", "permissions.delete", "permissions.own", "permissions.read", "permissions.unblock", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "comment", "contact_person", "email_address", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "phone_number", "tax_identification_number", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/admin_account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Zwraca pojedyncze konto.", "tags" : [ "admin" ] }, "put" : { "description" : "Modyfikuje konto.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id`, `is_activated`, `is_blocked`, `package_id` oraz `username`.", "operationId" : "admin_update_account", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/admin_account" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `language_not_found` (4044763): Nie znaleziono języka.\n* `time_zone_not_found` (4043825): Nie znaleziono strefy czasowej." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Modyfikuje konto.", "tags" : [ "admin" ] } }, "/admin/accounts/{_id}/block" : { "post" : { "description" : "Blokuje konto.\n\nBlokada konta powoduje:\n* zatrzymanie monitoringu wszystkich usług należących do konta,\n* uniemożliwienie logowania na konto.", "operationId" : "admin_block_account", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `block_not_allowed` (4036075): Konto jest już zablokowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Blokuje konto.", "tags" : [ "admin" ] } }, "/admin/accounts/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego konta.", "operationId" : "admin_read_account_permissions", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "block", "delete", "own", "read", "unblock", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/admin_account_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Zwraca uprawnienia do wybranego konta.", "tags" : [ "permissions", "admin" ] } }, "/admin/accounts/{_id}/unblock" : { "post" : { "description" : "Odblokowuje konto.\n\nOdblokowanie konta umożliwia zalogowanie, ale nie włącza monitoringu usług wyłączonych w wyniku blokany.", "operationId" : "admin_unblock_account", "parameters" : [ { "description" : "Identyfikator konta.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `unblock_not_allowed` (4037715): Konto nie jest zablokowane." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Odblokowuje konto.", "tags" : [ "admin" ] } }, "/admin/packages" : { "get" : { "description" : "Zwraca listę pakietów.", "operationId" : "admin_read_all_packages", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channels", "available_notification_channels.description", "available_notification_channels.id", "available_notification_channels.name", "permissions", "permissions.create_accounts", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channel_ids", "available_service_types", "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name", "permissions.create_accounts", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-can_force_custom_analyses", "-id", "-is_available_for_new_accounts", "-maximum_sensors", "-maximum_services", "-maximum_sms_numbers", "-minimum_interval", "-monthly_reports_limit", "-name", "-permissions.create_accounts", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "can_force_custom_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_force_custom_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available_for_new_accounts", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available_for_new_accounts!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_sensors", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_sensors!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_sms_numbers", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_sms_numbers!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum_interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum_interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "monthly_reports_limit", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "monthly_reports_limit!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_accounts", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_accounts!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_admin_packages" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Zwraca listę pakietów.", "tags" : [ "admin" ] } }, "/admin/packages/search" : { "post" : { "description" : "Zaawansowane pobieranie pakietów.", "operationId" : "admin_search_packages", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/admin_package_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_admin_packages" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Zaawansowane pobieranie pakietów.", "tags" : [ "admin" ] } }, "/admin/packages/{_id}" : { "get" : { "description" : "Zwraca pojedynczy pakiet.", "operationId" : "admin_read_package", "parameters" : [ { "description" : "Identyfikator pakietu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channels", "available_notification_channels.description", "available_notification_channels.id", "available_notification_channels.name", "permissions", "permissions.create_accounts", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channel_ids", "available_service_types", "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/admin_package" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`package_not_found` (4046424): Nie znaleziono pakietu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Zwraca pojedynczy pakiet.", "tags" : [ "admin" ] } }, "/admin/packages/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego pakietu.", "operationId" : "admin_read_package_permissions", "parameters" : [ { "description" : "Identyfikator pakietu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "create_accounts", "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/admin_package_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `package_not_found` (4046424): Nie znaleziono pakietu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Zwraca uprawnienia do wybranego pakietu.", "tags" : [ "permissions", "admin" ] } }, "/admin/usage_stats/by_account/{year}/{month}" : { "get" : { "description" : "Statystyki zużycia zasobów dla kont.", "operationId" : "admin_account_usage_stats", "parameters" : [ { "description" : "Rok.", "in" : "path", "name" : "year", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Miesiąc.", "in" : "path", "name" : "month", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_monthly_account_usage_stats" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Statystyki zużycia zasobów dla kont.", "tags" : [ "admin" ] } }, "/admin/usage_stats/by_group/{year}/{month}" : { "get" : { "description" : "Statystyki zużycia zasobów dla grup.", "operationId" : "admin_group_usage_stats", "parameters" : [ { "description" : "Rok.", "in" : "path", "name" : "year", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Miesiąc.", "in" : "path", "name" : "month", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_monthly_group_usage_stats" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] } ], "summary" : "Statystyki zużycia zasobów dla grup.", "tags" : [ "admin" ] } }, "/auth_token" : { "delete" : { "deprecated" : true, "description" : "Kończy sesję.\n\nTa operacja wymaga autentykacji za pomocą tokena sesji.\n\nUWAGA: Ta operacja zostanie usunięta w API 4.0. Zamiast niej należy zamykać aktualną sesję za pomocą wywołania `DELETE /sessions/my_session`.", "operationId" : "auth_token_delete", "parameters" : [], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Kończy sesję.", "tags" : [ "auth_token", "deprecated" ] }, "get" : { "deprecated" : true, "description" : "Zwraca informacje o sesji.\n\nTa operacja wymaga autentykacji za pomocą tokena sesji.\n\nUWAGA: Ta operacja zostanie usunięta w API 4.0. Zamiast niej należy pobierać informacje o aktualnej sesji za pomocą wywołania `GET /sessions/my_session`.", "operationId" : "auth_token_read", "parameters" : [], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/session_token" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca informacje o sesji.", "tags" : [ "auth_token", "deprecated" ] }, "post" : { "deprecated" : true, "description" : "Rozpoczyna nową sesję.\n\nUWAGA: Ta operacja zostanie usunięta w API 4.0. Zamiast niej należy otwierać sesje za pomocą operacji `POST /sessions`.", "operationId" : "auth_token_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/auth_token_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/auth_token_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego tokena sesji.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `too_many_sessions` (4039175): Osiągnięty limit liczby sesji i tokenów API dla konta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Rozpoczyna nową sesję.", "tags" : [ "auth_token", "deprecated" ] } }, "/contact_addresses" : { "get" : { "description" : "Zwraca listę adresów.", "operationId" : "contact_addresses_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "channel_id", "contact_id", "id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "channel_id", "contact.name", "contact_id", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-address", "-channel_id", "-contact.name", "-contact_id", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "contact.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów.", "tags" : [ "contact_addresses" ] }, "post" : { "description" : "Tworzy nowy adres.", "operationId" : "contact_addresses_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_address_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_address_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_channel_not_found` (4047880): Nie znaleziono kanału.\n* `contact_not_found` (4045290): Nie znaleziono kontaktu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_contact_address` (4223384): Niepoprawny adres kontaktowy.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowy adres.", "tags" : [ "contact_addresses" ] } }, "/contact_addresses/search" : { "post" : { "description" : "Zaawansowane pobieranie adresów.", "operationId" : "contact_addresses_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_address_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_addresses" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie adresów.", "tags" : [ "contact_addresses" ] } }, "/contact_addresses/{_id}" : { "delete" : { "description" : "Usuwa adres.", "operationId" : "contact_addresses_delete", "parameters" : [ { "description" : "Identyfikator adresu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_address_not_found` (4040811): Nie znaleziono adresu." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa adres.", "tags" : [ "contact_addresses" ] }, "get" : { "description" : "Zwraca pojedynczy adres.", "operationId" : "contact_addresses_read", "parameters" : [ { "description" : "Identyfikator adresu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "channel_id", "contact_id", "id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_address" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_address_not_found` (4040811): Nie znaleziono adresu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy adres.", "tags" : [ "contact_addresses" ] }, "put" : { "description" : "Modyfikuje adres.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `channel_id`, `contact_id` oraz `id`.", "operationId" : "contact_addresses_update", "parameters" : [ { "description" : "Identyfikator adresu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_address" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_address_not_found` (4040811): Nie znaleziono adresu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_contact_address` (4223384): Niepoprawny adres kontaktowy.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje adres.", "tags" : [ "contact_addresses" ] } }, "/contact_addresses/{_id}/channel" : { "get" : { "description" : "Zwraca kanał powiadomień dla adresu.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "contact_addresses_read_channel", "parameters" : [ { "description" : "Identyfikator adresu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_channel" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_address_not_found` (4040811): Nie znaleziono adresu.\n* `contact_channel_not_found` (4047880): Nie znaleziono kanału." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca kanał powiadomień dla adresu.", "tags" : [ "contact_addresses" ] } }, "/contact_addresses/{_id}/contact" : { "get" : { "description" : "Zwraca kontakt, do którego należy adres.", "operationId" : "contact_addresses_read_contact", "parameters" : [ { "description" : "Identyfikator adresu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_address_not_found` (4040811): Nie znaleziono adresu.\n* `contact_not_found` (4045290): Nie znaleziono kontaktu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca kontakt, do którego należy adres.", "tags" : [ "contacts", "contact_addresses" ] } }, "/contact_addresses/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego adresu.", "operationId" : "contact_addresses_read_permissions", "parameters" : [ { "description" : "Identyfikator adresu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_address_not_found` (4040811): Nie znaleziono adresu.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego adresu.", "tags" : [ "permissions", "contact_addresses" ] } }, "/contact_groups" : { "get" : { "description" : "Zwraca listę grup kontaktów.", "operationId" : "contact_groups_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "contacts", "contacts.description", "contacts.id", "contacts.language_id", "contacts.name", "contacts.owner_id", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_ids", "description", "id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-description", "-id", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_groups" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę grup kontaktów.", "tags" : [ "contact_groups" ] }, "post" : { "description" : "Tworzy nową grupę kontaktów.\n\nJeśli nie zostanie określony atrybut `owner_id`, zostanie użyty identyfikator konta wywołującego użytkownika.", "operationId" : "contact_groups_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_group_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_group_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `contact_not_found` (4045290): Nie znaleziono kontaktu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nową grupę kontaktów.", "tags" : [ "contact_groups" ] } }, "/contact_groups/search" : { "post" : { "description" : "Zaawansowane pobieranie grup kontaktów.", "operationId" : "contact_groups_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_group_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_groups" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie grup kontaktów.", "tags" : [ "contact_groups" ] } }, "/contact_groups/{_id}" : { "delete" : { "description" : "Usuwa grupę kontaktów.", "operationId" : "contact_groups_delete", "parameters" : [ { "description" : "Identyfikator grupy kontaktów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_group_not_found` (4042471): Nie znaleziono grupy kontaktów." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa grupę kontaktów.", "tags" : [ "contact_groups" ] }, "get" : { "description" : "Zwraca pojedynczą grupę kontaktów.", "operationId" : "contact_groups_read", "parameters" : [ { "description" : "Identyfikator grupy kontaktów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "contacts", "contacts.description", "contacts.id", "contacts.language_id", "contacts.name", "contacts.owner_id", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_ids", "description", "id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_group" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_group_not_found` (4042471): Nie znaleziono grupy kontaktów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczą grupę kontaktów.", "tags" : [ "contact_groups" ] }, "put" : { "description" : "Modyfikuje grupę kontaktów.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `owner_id`.", "operationId" : "contact_groups_update", "parameters" : [ { "description" : "Identyfikator grupy kontaktów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_group" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_group_not_found` (4042471): Nie znaleziono grupy kontaktów.\n* `contact_not_found` (4045290): Nie znaleziono kontaktu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje grupę kontaktów.", "tags" : [ "contact_groups" ] } }, "/contact_groups/{_id}/contacts" : { "get" : { "description" : "Zwraca listę kontaktów należących do grupy.", "operationId" : "contact_groups_read_contacts", "parameters" : [ { "description" : "Identyfikator grupy kontaktów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner.name", "owner.username", "owner_id", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-description", "-id", "-language_id", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.create_addresses", "-permissions.create_suspensions", "-permissions.create_weekly_suspensions", "-permissions.customize_templates", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_addresses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_weekly_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_weekly_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.customize_templates", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.customize_templates!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contacts" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_group_not_found` (4042471): Nie znaleziono grupy kontaktów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę kontaktów należących do grupy.", "tags" : [ "contacts", "contact_groups" ] } }, "/contact_groups/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy wybrana grupa kontaktów.", "operationId" : "contact_groups_read_owner", "parameters" : [ { "description" : "Identyfikator grupy kontaktów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `contact_group_not_found` (4042471): Nie znaleziono grupy kontaktów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy wybrana grupa kontaktów.", "tags" : [ "accounts", "contact_groups" ] } }, "/contact_groups/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranej grupy kontaktów.", "operationId" : "contact_groups_read_permissions", "parameters" : [ { "description" : "Identyfikator grupy kontaktów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_group_not_found` (4042471): Nie znaleziono grupy kontaktów.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranej grupy kontaktów.", "tags" : [ "permissions", "contact_groups" ] } }, "/contact_suspensions" : { "get" : { "description" : "Zwraca listę zawieszeń.", "operationId" : "contact_suspensions_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_id", "description", "end_time", "id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "contact.name", "contact_id", "description", "end_time", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_time", "-contact.name", "-contact_id", "-description", "-end_time", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "contact_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "contact.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zawieszeń.", "tags" : [ "contact_suspensions" ] }, "post" : { "description" : "Tworzy nowe zawieszenie.", "operationId" : "contact_suspensions_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_suspension_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_suspension_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_not_found` (4045290): Nie znaleziono kontaktu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe zawieszenie.", "tags" : [ "contact_suspensions" ] } }, "/contact_suspensions/search" : { "post" : { "description" : "Zaawansowane pobieranie zawieszeń.", "operationId" : "contact_suspensions_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_suspension_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_suspensions" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie zawieszeń.", "tags" : [ "contact_suspensions" ] } }, "/contact_suspensions/{_id}" : { "delete" : { "description" : "Usuwa zawieszenie.", "operationId" : "contact_suspensions_delete", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_suspension_not_found` (4042364): Nie znaleziono zawieszenia." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa zawieszenie.", "tags" : [ "contact_suspensions" ] }, "get" : { "description" : "Zwraca pojedyncze zawieszenie.", "operationId" : "contact_suspensions_read", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_id", "description", "end_time", "id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_suspension" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_suspension_not_found` (4042364): Nie znaleziono zawieszenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze zawieszenie.", "tags" : [ "contact_suspensions" ] }, "put" : { "description" : "Modyfikuje zawieszenie.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `contact_id` oraz `id`.", "operationId" : "contact_suspensions_update", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_suspension" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_suspension_not_found` (4042364): Nie znaleziono zawieszenia." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje zawieszenie.", "tags" : [ "contact_suspensions" ] } }, "/contact_suspensions/{_id}/contact" : { "get" : { "description" : "Zwraca kontakt, do którego należy zawieszenie.", "operationId" : "contact_suspensions_read_contact", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_not_found` (4045290): Nie znaleziono kontaktu.\n* `contact_suspension_not_found` (4042364): Nie znaleziono zawieszenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca kontakt, do którego należy zawieszenie.", "tags" : [ "contacts", "contact_suspensions" ] } }, "/contact_suspensions/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego zawieszenia.", "operationId" : "contact_suspensions_read_permissions", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_suspension_not_found` (4042364): Nie znaleziono zawieszenia.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego zawieszenia.", "tags" : [ "permissions", "contact_suspensions" ] } }, "/contact_weekly_suspensions" : { "get" : { "description" : "Zwraca listę tygodniowych zawieszeń konktaktów.", "operationId" : "contact_weekly_suspensions_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_id", "description", "end_minute", "id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "contact.name", "contact_id", "description", "end_minute", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_minute", "-contact.name", "-contact_id", "-description", "-end_minute", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_minute" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "contact_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "contact.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_weekly_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę tygodniowych zawieszeń konktaktów.", "tags" : [ "contact_suspensions" ] }, "post" : { "description" : "Tworzy nowe tygodniowe zawieszenie kontaktu.", "operationId" : "contact_weekly_suspensions_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_weekly_suspension_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_weekly_suspension_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_not_found` (4045290): Nie znaleziono kontaktu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe tygodniowe zawieszenie kontaktu.", "tags" : [ "contact_suspensions" ] } }, "/contact_weekly_suspensions/search" : { "post" : { "description" : "Zaawansowane pobieranie tygodniowych zawieszeń kontaktów.", "operationId" : "contact_weekly_suspensions_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_weekly_suspension_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_weekly_suspensions" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie tygodniowych zawieszeń kontaktów.", "tags" : [ "contact_suspensions" ] } }, "/contact_weekly_suspensions/{_id}" : { "delete" : { "description" : "Usuwa tygodniowe zawieszenie kontaktu.", "operationId" : "contact_weekly_suspensions_delete", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_weekly_suspension_not_found` (4042021): Nie znaleziono zawieszenia tygodniowego." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa tygodniowe zawieszenie kontaktu.", "tags" : [ "contact_suspensions" ] }, "get" : { "description" : "Zwraca pojedyncze tygodniowe zawieszenie kontaktu.", "operationId" : "contact_weekly_suspensions_read", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_id", "description", "end_minute", "id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_weekly_suspension" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_weekly_suspension_not_found` (4042021): Nie znaleziono zawieszenia tygodniowego." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze tygodniowe zawieszenie kontaktu.", "tags" : [ "contact_suspensions" ] }, "put" : { "description" : "Modyfikuje tygodniowe zawieszenie kontaktu.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `contact_id` oraz `id`.", "operationId" : "contact_weekly_suspensions_update", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_weekly_suspension" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_weekly_suspension_not_found` (4042021): Nie znaleziono zawieszenia tygodniowego." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje tygodniowe zawieszenie kontaktu.", "tags" : [ "contact_suspensions" ] } }, "/contact_weekly_suspensions/{_id}/contact" : { "get" : { "description" : "Zwraca kontakt, którego dotyczy wybrane tygodniowe zawieszenie.", "operationId" : "contact_weekly_suspensions_read_contact", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_not_found` (4045290): Nie znaleziono kontaktu.\n* `contact_weekly_suspension_not_found` (4042021): Nie znaleziono zawieszenia tygodniowego." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca kontakt, którego dotyczy wybrane tygodniowe zawieszenie.", "tags" : [ "contacts", "contact_suspensions" ] } }, "/contact_weekly_suspensions/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego zawieszenia tygodniowego.", "operationId" : "contact_weekly_suspensions_read_permissions", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_weekly_suspension_not_found` (4042021): Nie znaleziono zawieszenia tygodniowego.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego zawieszenia tygodniowego.", "tags" : [ "contact_suspensions" ] } }, "/contacts" : { "get" : { "description" : "Zwraca listę kontaktów.", "operationId" : "contacts_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner.name", "owner.username", "owner_id", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-description", "-id", "-language_id", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.create_addresses", "-permissions.create_suspensions", "-permissions.create_weekly_suspensions", "-permissions.customize_templates", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_addresses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_weekly_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_weekly_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.customize_templates", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.customize_templates!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contacts" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę kontaktów.", "tags" : [ "contacts" ] }, "post" : { "description" : "Tworzy nowy kontakt.\n\nJeśli nie zostanie określony atrybut `owner_id`, zostanie użyty identyfikator konta wywołującego użytkownika.", "operationId" : "contacts_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `language_not_found` (4044763): Nie znaleziono języka." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowy kontakt.", "tags" : [ "contacts" ] } }, "/contacts/search" : { "post" : { "description" : "Zaawansowane pobieranie kontaktów.", "operationId" : "contacts_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contacts" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie kontaktów.", "tags" : [ "contacts" ] } }, "/contacts/{_id}" : { "delete" : { "description" : "Usuwa kontakt.\n\nUwaga: Razem z kontaktem zostaną usunięte przypisane do niego adresy i zawieszenia.", "operationId" : "contacts_delete", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_not_found` (4045290): Nie znaleziono kontaktu." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa kontakt.", "tags" : [ "contacts" ] }, "get" : { "description" : "Zwraca pojedynczy kontakt.", "operationId" : "contacts_read", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_addresses", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.customize_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "language_id", "name", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_not_found` (4045290): Nie znaleziono kontaktu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy kontakt.", "tags" : [ "contacts" ] }, "put" : { "description" : "Modyfikuje kontakt.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `owner_id`.", "operationId" : "contacts_update", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_not_found` (4045290): Nie znaleziono kontaktu.\n* `language_not_found` (4044763): Nie znaleziono języka." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje kontakt.", "tags" : [ "contacts" ] } }, "/contacts/{_id}/addresses" : { "get" : { "description" : "Zwraca listę adresów należących do kontaktu.", "operationId" : "contacts_read_contact_addresses", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "channel_id", "contact_id", "id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "channel_id", "contact.name", "contact_id", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-address", "-channel_id", "-contact.name", "-contact_id", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "contact.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_not_found` (4045290): Nie znaleziono kontaktu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów należących do kontaktu.", "tags" : [ "contact_addresses", "contacts" ] } }, "/contacts/{_id}/custom_templates" : { "get" : { "description" : "Zwraca listę własnych szablonów dla kontaktu.", "operationId" : "contacts_read_custom_templates", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "template", "template.artifact_type_ids", "template.end_subject", "template.end_template", "template.id", "template.language_id", "template.name", "template.owner_id", "template.start_subject", "template.start_template" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "channel_id", "contact_id", "template_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "channel_id", "contact.name", "contact_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "template.name", "template_id", "-channel_id", "-contact.name", "-contact_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-template.name", "-template_id" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "template_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "template_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "contact.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "template.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "template.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "template.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_custom_templates" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_not_found` (4045290): Nie znaleziono kontaktu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę własnych szablonów dla kontaktu.", "tags" : [ "templates", "contacts" ] } }, "/contacts/{_id}/custom_templates/{_channel_id}" : { "delete" : { "description" : "Usuwa przypisanie własnego szablonu do kontaktu.", "operationId" : "contacts_delete_custom_template", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator kanału powiadomień.", "in" : "path", "name" : "_channel_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`custom_template_not_found` (4048628): Nie znaleziono przypisania własnego szablonu." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa przypisanie własnego szablonu do kontaktu.", "tags" : [ "templates", "contacts" ] }, "get" : { "description" : "Zwraca własny szablon dla określonego kontaktu i kanału.", "operationId" : "contacts_read_custom_template", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator kanału powiadomień.", "in" : "path", "name" : "_channel_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "template", "template.artifact_type_ids", "template.end_subject", "template.end_template", "template.id", "template.language_id", "template.name", "template.owner_id", "template.start_subject", "template.start_template" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "channel_id", "contact_id", "template_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/custom_template" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`custom_template_not_found` (4048628): Nie znaleziono przypisania własnego szablonu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca własny szablon dla określonego kontaktu i kanału.", "tags" : [ "templates", "contacts" ] }, "put" : { "description" : "Tworzy lub modyfikuje przypisanie własnego szablonu do kontaktu.\n\nSzablon musi należeć do tego samego konta, co kontakt.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `channel_id` oraz `contact_id`.", "operationId" : "contacts_update_custom_template", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator kanału powiadomień.", "in" : "path", "name" : "_channel_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/custom_template" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `replace_not_allowed` (4035613): Brak uprawnień do modyfikacji lub utworzenia obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_channel_not_found` (4047880): Nie znaleziono kanału.\n* `contact_not_found` (4045290): Nie znaleziono kontaktu.\n* `template_not_found` (4040118): Nie znaleziono szablonu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `id_mismatch` (4226426): Identyfikator obiektu zawarty w adresie URL nie jest zgodny z wartością identyfikatora w samym obiekcie.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy lub modyfikuje przypisanie własnego szablonu do kontaktu.", "tags" : [ "templates", "contacts" ] } }, "/contacts/{_id}/custom_templates/{_channel_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do przypisania własnego szablonu do kontaktu.", "operationId" : "contacts_read_custom_template_permissions", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator kanału powiadomień.", "in" : "path", "name" : "_channel_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `custom_template_not_found` (4048628): Nie znaleziono przypisania własnego szablonu.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do przypisania własnego szablonu do kontaktu.", "tags" : [ "templates", "permissions", "contacts" ] } }, "/contacts/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy wybrany kontakt.", "operationId" : "contacts_read_owner", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `contact_not_found` (4045290): Nie znaleziono kontaktu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy wybrany kontakt.", "tags" : [ "accounts", "contacts" ] } }, "/contacts/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego kontaktu.", "operationId" : "contacts_read_permissions", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "create_addresses", "create_suspensions", "create_weekly_suspensions", "customize_templates", "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_not_found` (4045290): Nie znaleziono kontaktu.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego kontaktu.", "tags" : [ "permissions", "contacts" ] } }, "/contacts/{_id}/suspensions" : { "get" : { "description" : "Zwraca listę zawieszeń kontaktu.", "operationId" : "contacts_read_contact_suspensions", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_id", "description", "end_time", "id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "contact.name", "contact_id", "description", "end_time", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_time", "-contact.name", "-contact_id", "-description", "-end_time", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "contact_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "contact.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_not_found` (4045290): Nie znaleziono kontaktu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zawieszeń kontaktu.", "tags" : [ "contact_suspensions", "contacts" ] } }, "/contacts/{_id}/weekly_suspensions" : { "get" : { "description" : "Zwraca listę tygodniowych zawieszeń kontaktu.", "operationId" : "contacts_read_contact_weekly_suspensions", "parameters" : [ { "description" : "Identyfikator kontaktu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "contact", "contact.description", "contact.id", "contact.language_id", "contact.name", "contact.owner_id", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_id", "description", "end_minute", "id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "contact.name", "contact_id", "description", "end_minute", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_minute", "-contact.name", "-contact_id", "-description", "-end_minute", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_minute" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "contact_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "contact.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "contact.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "contact.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_weekly_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_not_found` (4045290): Nie znaleziono kontaktu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę tygodniowych zawieszeń kontaktu.", "tags" : [ "contact_suspensions", "contacts" ] } }, "/corrections" : { "get" : { "description" : "Zwraca listę korekt.", "operationId" : "corrections_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "created_at", "description", "end_time", "id", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "created_at", "description", "end_time", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start_time", "status", "-created_at", "-description", "-end_time", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service.id", "-service.interval", "-service.is_active", "-service.is_archived", "-service.name", "-service.owner_id", "-service_id", "-start_time", "-status" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "created_at", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "created_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "created_at~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "end_time_from", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "end_time_to", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "from", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Sposób wyszukiwania korekt w wybranym przedziale (okreśonym za pomocą parametrów `from` i `to`): rozpoczynające się w nim (`starting`) lub mające z nim niepuste przecięcie (`overlapping`).", "in" : "query", "name" : "intervals", "required" : false, "schema" : { "default" : "starting", "description" : "Sposób wyszukiwania korekt w wybranym przedziale (okreśonym za pomocą parametrów `from` i `to`): rozpoczynające się w nim (`starting`) lub mające z nim niepuste przecięcie (`overlapping`).", "enum" : [ "overlapping", "starting" ], "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "start_time_from", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "start_time_to", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "to", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_corrections" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę korekt.", "tags" : [ "corrections" ] }, "post" : { "description" : "Tworzy nową korektę.", "operationId" : "corrections_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/correction_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/correction_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nową korektę.", "tags" : [ "corrections" ] } }, "/corrections/bulk_create" : { "post" : { "description" : "Dodaje korektę do wielu usług jednocześnie.\n\nZamiast pola `service_id` należy podać pole `service_ids` - tablicę identyfikatorów usług, do których posiadamy uprawnienie `create_corrections`.", "operationId" : "corrections_bulk_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/correction_bulk_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Dodaje korektę do wielu usług jednocześnie.", "tags" : [ "corrections" ] } }, "/corrections/bulk_delete" : { "post" : { "description" : "Usuwa wiele korekt jednocześnie.\n\nW treści zapytania należy podać tablicę identyfikatorów korekt, do których posiadamy uprawnienie `delete`.", "operationId" : "corrections_bulk_delete", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`correction_not_found` (4040164): Nie znaleziono korekty Service Level." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa wiele korekt jednocześnie.", "tags" : [ "corrections" ] } }, "/corrections/bulk_update" : { "post" : { "description" : "Modyfikuje wiele korekt jednocześnie.", "operationId" : "corrections_bulk_update", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/correction_bulk_update_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`correction_not_found` (4040164): Nie znaleziono korekty Service Level." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje wiele korekt jednocześnie.", "tags" : [ "corrections" ] } }, "/corrections/search" : { "post" : { "description" : "Zaawansowane pobieranie korekt.", "operationId" : "corrections_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/correction_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_corrections" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie korekt.", "tags" : [ "corrections" ] } }, "/corrections/{_id}" : { "delete" : { "description" : "Usuwa korektę.", "operationId" : "corrections_delete", "parameters" : [ { "description" : "Identyfikator korekty.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`correction_not_found` (4040164): Nie znaleziono korekty Service Level." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa korektę.", "tags" : [ "corrections" ] }, "get" : { "description" : "Zwraca pojedynczą korektę.", "operationId" : "corrections_read", "parameters" : [ { "description" : "Identyfikator korekty.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "created_at", "description", "end_time", "id", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/correction" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`correction_not_found` (4040164): Nie znaleziono korekty Service Level." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczą korektę.", "tags" : [ "corrections" ] }, "put" : { "description" : "Modyfikuje istniejącą korektę.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `created_at`, `id` oraz `service_id`.", "operationId" : "corrections_update", "parameters" : [ { "description" : "Identyfikator korekty.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/correction" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`correction_not_found` (4040164): Nie znaleziono korekty Service Level." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje istniejącą korektę.", "tags" : [ "corrections" ] } }, "/corrections/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranej korekty.", "operationId" : "corrections_read_permissions", "parameters" : [ { "description" : "Identyfikator korekty.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `correction_not_found` (4040164): Nie znaleziono korekty Service Level.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranej korekty.", "tags" : [ "permissions", "corrections" ] } }, "/default_templates" : { "get" : { "description" : "Zwraca listę domyślnych szablonów.", "operationId" : "default_templates_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "language", "language.description", "language.id", "language.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "artifact_type_ids", "channel_id", "end_subject", "end_template", "language_id", "start_subject", "start_template" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "channel_id", "end_subject", "end_template", "language_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_subject", "start_template", "-channel_id", "-end_subject", "-end_template", "-language_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_subject", "-start_template" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_subject", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_subject!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_subject~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_subject", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_subject!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_subject~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_default_templates" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę domyślnych szablonów.", "tags" : [ "templates" ] } }, "/default_templates/search" : { "post" : { "description" : "Zaawansowane pobieranie domyślnych szablonów.", "operationId" : "default_templates_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/default_template_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_default_templates" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie domyślnych szablonów.", "tags" : [ "templates" ] } }, "/default_templates/{_channel_id}/{_language_id}" : { "get" : { "description" : "Zwraca pojedynczy domyślny szablon.", "operationId" : "default_templates_read", "parameters" : [ { "description" : "Identyfikator kanału kontaktowego.", "in" : "path", "name" : "_channel_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator domyślnego języka powiadomień (klucz w słowniku `languages`).", "in" : "path", "name" : "_language_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "channel", "channel.description", "channel.id", "channel.name", "language", "language.description", "language.id", "language.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "artifact_type_ids", "channel_id", "end_subject", "end_template", "language_id", "start_subject", "start_template" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/default_template" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_channel_not_found` (4047880): Nie znaleziono kanału." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy domyślny szablon.", "tags" : [ "templates" ] } }, "/dictionaries/artifact_types" : { "get" : { "description" : "Zwraca listę znanych typów artefaktów.\n\nNiektóre typy usług mogą zwracać dodatkowe artefakty innych typów niż opisane tym słownikiem\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_artifact_types", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_artifact_types" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę znanych typów artefaktów.", "tags" : [ "dictionaries" ] } }, "/dictionaries/artifact_types/{_id}" : { "get" : { "description" : "Zwraca wybrany typ artefaktu.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_artifact_type", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/artifact_type" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`artifact_type_not_found` (4041001): Nie znaleziono typu artefaktu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany typ artefaktu.", "tags" : [ "dictionaries" ] } }, "/dictionaries/contact_channels" : { "get" : { "description" : "Zwraca listę kanałów kontaktowych.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_contact_channels", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_contact_channels" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę kanałów kontaktowych.", "tags" : [ "dictionaries" ] } }, "/dictionaries/contact_channels/{_id}" : { "get" : { "description" : "Zwraca wybrany kanał kontaktowy.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_contact_channel", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/contact_channel" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`contact_channel_not_found` (4047880): Nie znaleziono kanału." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany kanał kontaktowy.", "tags" : [ "dictionaries" ] } }, "/dictionaries/error_type_categories" : { "get" : { "description" : "Zwraca listę kategorii typów błędu.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_error_type_categories", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_error_type_categories" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę kategorii typów błędu.", "tags" : [ "dictionaries" ] } }, "/dictionaries/error_type_categories/{_id}" : { "get" : { "description" : "Zwraca wybraną kategorię typów błędu.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_error_type_category", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/error_type_category" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`error_type_category_not_found` (4042758): Nie znaleziono kategorii typów błędu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybraną kategorię typów błędu.", "tags" : [ "dictionaries" ] } }, "/dictionaries/error_type_categories/{_id}/error_types" : { "get" : { "description" : "Zwraca listę typów błędów należących do wybranej kategorii.\n\n\n\nPola wyniku `description`, `diagnosis`, `extra_info` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_error_types_by_error_type_category", "parameters" : [ { "description" : "Identyfikator kategorii.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "categories", "categories.description", "categories.id", "categories.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "category_ids", "description", "diagnosis", "extra_info", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "diagnosis", "extra_info", "id", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-description", "-diagnosis", "-extra_info", "-id", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "diagnosis", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "diagnosis!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "diagnosis~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "extra_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "extra_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "extra_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_error_types" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`error_type_category_not_found` (4042758): Nie znaleziono kategorii typów błędu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę typów błędów należących do wybranej kategorii.", "tags" : [ "error_types" ] } }, "/dictionaries/languages" : { "get" : { "description" : "Zwraca listę dostępnych języków.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_languages", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_languages" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę dostępnych języków.", "tags" : [ "dictionaries" ] } }, "/dictionaries/languages/{_id}" : { "get" : { "description" : "Zwraca wybrany język.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_language", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/language" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`language_not_found` (4044763): Nie znaleziono języka." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany język.", "tags" : [ "dictionaries" ] } }, "/dictionaries/metric_types" : { "get" : { "description" : "Zwraca listę znanych typów metryk.\n\nNiektóre typy usług mogą zwracać dodatkowe metryki innych typów niż opisane tym słownikiem\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_metric_types", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_metric_types" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę znanych typów metryk.", "tags" : [ "dictionaries" ] } }, "/dictionaries/metric_types/{_id}" : { "get" : { "description" : "Zwraca wybrany typ metryki.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_metric_type", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/metric_type" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`metric_type_not_found` (4049383): Nie znaleziono typu metryki." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany typ metryki.", "tags" : [ "dictionaries" ] } }, "/dictionaries/notification_channels" : { "get" : { "description" : "Zwraca listę kanałów powiadomień dostępnych w systemie.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_notification_channels", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_channels" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę kanałów powiadomień dostępnych w systemie.", "tags" : [ "dictionaries" ] } }, "/dictionaries/notification_channels/{_id}" : { "get" : { "description" : "Zwraca wybrany kanał powiadomień.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_notification_channel", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_channel" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`notification_channel_not_found` (4041457): Nie znaleziono kanału powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany kanał powiadomień.", "tags" : [ "dictionaries" ] } }, "/dictionaries/notification_conditions" : { "get" : { "description" : "Zwraca listę dostępnych warunków powiadomień.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_notification_conditions", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_conditions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę dostępnych warunków powiadomień.", "tags" : [ "dictionaries" ] } }, "/dictionaries/notification_conditions/{_id}" : { "get" : { "description" : "Zwraca wybrany warunek powiadomień.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_notification_condition", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_condition" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`notification_condition_not_found` (4046371): Nie znaleziono warunku powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany warunek powiadomień.", "tags" : [ "dictionaries" ] } }, "/dictionaries/notification_modes" : { "get" : { "description" : "Zwraca listę trybów powiadomień.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_notification_modes", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_modes" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę trybów powiadomień.", "tags" : [ "dictionaries" ] } }, "/dictionaries/notification_modes/{_id}" : { "get" : { "description" : "Zwraca wybrany tryb powiadomień.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_notification_mode", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_mode" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`notification_mode_not_found` (4046208): Nie znaleziono trybu powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany tryb powiadomień.", "tags" : [ "dictionaries" ] } }, "/dictionaries/recovery_notification_modes" : { "get" : { "description" : "Zwraca listę trybów powiadomień o końcu awarii.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_recovery_notification_modes", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_recovery_notification_modes" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę trybów powiadomień o końcu awarii.", "tags" : [ "dictionaries" ] } }, "/dictionaries/recovery_notification_modes/{_id}" : { "get" : { "description" : "Zwraca wybrany tryb powiadomień o końcu awarii.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_recovery_notification_mode", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/recovery_notification_mode" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`recovery_notification_mode_not_found` (4045477): Nie znaleziono trybu powiadomień o końcu awarii." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany tryb powiadomień o końcu awarii.", "tags" : [ "dictionaries" ] } }, "/dictionaries/report_attachment_types" : { "get" : { "description" : "Zwraca listę znanych typów załączników do raportów.\n\nNiektóre raporty mogą zawierać dodatkowe załączniki innych typów niż opisane tym słownikiem\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_report_attachment_types", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_report_attachment_types" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę znanych typów załączników do raportów.", "tags" : [ "dictionaries" ] } }, "/dictionaries/report_attachment_types/{_id}" : { "get" : { "description" : "Zwraca wybrany typ załcznika do raportu.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_report_attachment_type", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_attachment_type" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_attachment_type_not_found` (4045666): Nie znaleziono typu załącznika do raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany typ załcznika do raportu.", "tags" : [ "dictionaries" ] } }, "/dictionaries/report_sections" : { "get" : { "description" : "Zwraca listę dostępnych sekcji raportów.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_report_sections", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_report_sections" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę dostępnych sekcji raportów.", "tags" : [ "dictionaries" ] } }, "/dictionaries/report_sections/{_id}" : { "get" : { "description" : "Zwraca wybraną sekcję raportów.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_report_section", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_section" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_section_not_found` (4046182): Nie znaleziono sekcji raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybraną sekcję raportów.", "tags" : [ "dictionaries" ] } }, "/dictionaries/report_template_variables" : { "get" : { "description" : "Zwraca listę zmiennych dostępnych w szablonach raportów.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_report_template_variables", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_report_template_variables" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę zmiennych dostępnych w szablonach raportów.", "tags" : [ "dictionaries" ] } }, "/dictionaries/report_template_variables/{_id}" : { "get" : { "description" : "Zwraca wybraną zmienną dostępną w szablonach raportów.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_report_template_variable", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_template_variable" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_template_variable_not_found` (4045738): Nie znaleziono zmiennej szablonów raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybraną zmienną dostępną w szablonach raportów.", "tags" : [ "dictionaries" ] } }, "/dictionaries/reporting_plans" : { "get" : { "description" : "Zwraca listę dostępnych planów generowania raportów.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_reporting_plans", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_reporting_plans" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę dostępnych planów generowania raportów.", "tags" : [ "dictionaries" ] } }, "/dictionaries/reporting_plans/{_id}" : { "get" : { "description" : "Zwraca wybrany plan generowania raportów.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_reporting_plan", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/reporting_plan" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`reporting_plan_not_found` (4042872): Nie znaleziono planu generowania raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany plan generowania raportów.", "tags" : [ "dictionaries" ] } }, "/dictionaries/service_type_categories" : { "get" : { "description" : "Zwraca listę kategorii typów usług.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_service_type_categories", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_service_type_categories" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę kategorii typów usług.", "tags" : [ "dictionaries" ] } }, "/dictionaries/service_type_categories/{_id}" : { "get" : { "description" : "Zwraca wybraną kategorię typów usług.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_service_type_category", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_type_category" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_type_category_not_found` (4043944): Nie znaleziono kategorii typów usług." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybraną kategorię typów usług.", "tags" : [ "dictionaries" ] } }, "/dictionaries/service_type_categories/{_id}/sensors" : { "get" : { "description" : "Zwraca listę stacji monitorujących obsługujących sprawdzanie usług wybranej kategorii.\n\n\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_sensors_by_service_type_category", "parameters" : [ { "description" : "Identyfikator kategorii.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_type_category_not_found` (4043944): Nie znaleziono kategorii typów usług." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę stacji monitorujących obsługujących sprawdzanie usług wybranej kategorii.", "tags" : [ "sensors" ] } }, "/dictionaries/template_variables" : { "get" : { "description" : "Zwraca listę zmiennych dostępnych w szablonach powiadomień.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_template_variables", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_template_variables" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę zmiennych dostępnych w szablonach powiadomień.", "tags" : [ "dictionaries" ] } }, "/dictionaries/template_variables/{_id}" : { "get" : { "description" : "Zwraca wybraną zmienną dostępną w szablonach powiadomień.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_template_variable", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/template_variable" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`template_variable_not_found` (4049932): Nie znaleziono zmiennej szablonów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybraną zmienną dostępną w szablonach powiadomień.", "tags" : [ "dictionaries" ] } }, "/dictionaries/time_zones" : { "get" : { "description" : "Zwraca listę dostępnych stref czasowych.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_all_time_zones", "parameters" : [ { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_time_zones" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę dostępnych stref czasowych.", "tags" : [ "dictionaries" ] } }, "/dictionaries/time_zones/{_id}" : { "get" : { "description" : "Zwraca wybraną strefę czasową.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "dictionaries_read_time_zone", "parameters" : [ { "description" : "Identyfikator wartości w słowniku.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/time_zone" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`time_zone_not_found` (4043825): Nie znaleziono strefy czasowej." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybraną strefę czasową.", "tags" : [ "dictionaries" ] } }, "/error_types" : { "get" : { "description" : "Zwraca listę typów błędów.\n\n\n\nPola wyniku `description`, `diagnosis`, `extra_info` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "error_types_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "categories", "categories.description", "categories.id", "categories.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "category_ids", "description", "diagnosis", "extra_info", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "diagnosis", "extra_info", "id", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-description", "-diagnosis", "-extra_info", "-id", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "diagnosis", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "diagnosis!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "diagnosis~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "extra_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "extra_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "extra_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_error_types" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę typów błędów.", "tags" : [ "error_types" ] } }, "/error_types/search" : { "post" : { "description" : "Zaawansowane pobieranie typów błędów.\n\n\n\nPola wyniku `description`, `diagnosis`, `extra_info` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "error_types_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/error_type_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_error_types" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zaawansowane pobieranie typów błędów.", "tags" : [ "error_types" ] } }, "/error_types/{_id}" : { "get" : { "description" : "Zwraca pojedynczy typ błędu.\n\n\n\nPola wyniku `description`, `diagnosis`, `extra_info` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "error_types_read", "parameters" : [ { "description" : "Kod błędu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "categories", "categories.description", "categories.id", "categories.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "category_ids", "description", "diagnosis", "extra_info", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/error_type" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`error_type_not_found` (4041749): Nie znaleziono typu błędu monitoringu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca pojedynczy typ błędu.", "tags" : [ "error_types" ] } }, "/error_types/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego typu błędu.", "operationId" : "error_types_read_permissions", "parameters" : [ { "description" : "Kod błędu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `error_type_not_found` (4041749): Nie znaleziono typu błędu monitoringu.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca uprawnienia do wybranego typu błędu.", "tags" : [ "permissions", "error_types" ] } }, "/escalation_statuses" : { "get" : { "description" : "Zwraca listę aktualnych statusów eskalacji.", "operationId" : "escalation_statuses_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "escalation_id", "event_id", "sent_notifications", "service_id", "summary", "times_notified" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "escalation.name", "escalation_id", "event_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "sent_notifications", "service.name", "service_id", "summary", "times_notified", "-escalation.name", "-escalation_id", "-event_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-sent_notifications", "-service.name", "-service_id", "-summary", "-times_notified" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "escalation_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sent_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sent_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "times_notified", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "times_notified!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "escalation.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_statuses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę aktualnych statusów eskalacji.", "tags" : [ "escalations" ] } }, "/escalation_statuses/search" : { "post" : { "description" : "Zaawansowane pobieranie statusów eskalacji.", "operationId" : "escalation_statuses_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_status_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_statuses" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie statusów eskalacji.", "tags" : [ "escalations" ] } }, "/escalation_suspensions" : { "get" : { "description" : "Zwraca listę zawieszeń.", "operationId" : "escalation_suspensions_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "escalation_id", "id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "escalation.name", "escalation_id", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_time", "-description", "-end_time", "-escalation.name", "-escalation_id", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "escalation.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zawieszeń.", "tags" : [ "escalation_suspensions" ] }, "post" : { "description" : "Tworzy nowe zawieszenie.", "operationId" : "escalation_suspensions_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_suspension_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_suspension_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_not_found` (4046655): Nie znaleziono eskalacji." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe zawieszenie.", "tags" : [ "escalation_suspensions" ] } }, "/escalation_suspensions/search" : { "post" : { "description" : "Zaawansowane pobieranie zawieszeń.", "operationId" : "escalation_suspensions_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_suspension_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_suspensions" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie zawieszeń.", "tags" : [ "escalation_suspensions" ] } }, "/escalation_suspensions/{_id}" : { "delete" : { "description" : "Usuwa zawieszenie.", "operationId" : "escalation_suspensions_delete", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_suspension_not_found` (4042901): Nie znaleziono zawieszenia." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa zawieszenie.", "tags" : [ "escalation_suspensions" ] }, "get" : { "description" : "Zwraca pojedyncze zawieszenie.", "operationId" : "escalation_suspensions_read", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "escalation_id", "id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_suspension" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_suspension_not_found` (4042901): Nie znaleziono zawieszenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze zawieszenie.", "tags" : [ "escalation_suspensions" ] }, "put" : { "description" : "Modyfikuje zawieszenie.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `escalation_id` oraz `id`.", "operationId" : "escalation_suspensions_update", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_suspension" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_suspension_not_found` (4042901): Nie znaleziono zawieszenia." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje zawieszenie.", "tags" : [ "escalation_suspensions" ] } }, "/escalation_suspensions/{_id}/escalation" : { "get" : { "description" : "Zwraca eskalację, której dotyczy zawieszenie.", "operationId" : "escalation_suspensions_read_escalation", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_groups", "contacts", "description", "end_notifications_delay", "event_id", "id", "is_enabled", "name", "repeated_notifications_interval", "repeated_notifications_limit", "start_notifications_delay" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `escalation_not_found` (4046655): Nie znaleziono eskalacji.\n* `escalation_suspension_not_found` (4042901): Nie znaleziono zawieszenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca eskalację, której dotyczy zawieszenie.", "tags" : [ "escalations", "escalation_suspensions" ] } }, "/escalation_suspensions/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego zawieszenia.", "operationId" : "escalation_suspensions_read_permissions", "parameters" : [ { "description" : "Identyfikator zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `escalation_suspension_not_found` (4042901): Nie znaleziono zawieszenia.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego zawieszenia.", "tags" : [ "permissions", "escalation_suspensions" ] } }, "/escalation_weekly_suspensions" : { "get" : { "description" : "Zwraca listę tygodniowych zawieszeń eskalacji.", "operationId" : "escalation_weekly_suspensions_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "escalation_id", "id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "escalation.name", "escalation_id", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_minute", "-description", "-end_minute", "-escalation.name", "-escalation_id", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_minute" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "escalation.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_weekly_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę tygodniowych zawieszeń eskalacji.", "tags" : [ "escalation_suspensions" ] }, "post" : { "description" : "Tworzy nowe tygodniowe zawieszenie eskalacji.", "operationId" : "escalation_weekly_suspensions_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_weekly_suspension_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_weekly_suspension_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_not_found` (4046655): Nie znaleziono eskalacji." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe tygodniowe zawieszenie eskalacji.", "tags" : [ "escalation_suspensions" ] } }, "/escalation_weekly_suspensions/search" : { "post" : { "description" : "Zaawansowane pobieranie tygodniowych zawieszeń eskalacji.", "operationId" : "escalation_weekly_suspensions_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_weekly_suspension_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_weekly_suspensions" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie tygodniowych zawieszeń eskalacji.", "tags" : [ "escalation_suspensions" ] } }, "/escalation_weekly_suspensions/{_id}" : { "delete" : { "description" : "Usuwa tygodniowe zawieszenie eskalacji.", "operationId" : "escalation_weekly_suspensions_delete", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_weekly_suspension_not_found` (4048625): Nie znaleziono zawieszenia tygodniowego." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa tygodniowe zawieszenie eskalacji.", "tags" : [ "escalation_suspensions" ] }, "get" : { "description" : "Zwraca pojedyncze tygodniowe zawieszenie eskalacji.", "operationId" : "escalation_weekly_suspensions_read", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "escalation_id", "id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_weekly_suspension" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_weekly_suspension_not_found` (4048625): Nie znaleziono zawieszenia tygodniowego." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze tygodniowe zawieszenie eskalacji.", "tags" : [ "escalation_suspensions" ] }, "put" : { "description" : "Modyfikuje tygodniowe zawieszenie eskalacji.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `escalation_id` oraz `id`.", "operationId" : "escalation_weekly_suspensions_update", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_weekly_suspension" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_weekly_suspension_not_found` (4048625): Nie znaleziono zawieszenia tygodniowego." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje tygodniowe zawieszenie eskalacji.", "tags" : [ "escalation_suspensions" ] } }, "/escalation_weekly_suspensions/{_id}/escalation" : { "get" : { "description" : "Zwraca eskalację, której dotyczy wybrane tygodniowe zawieszenie.", "operationId" : "escalation_weekly_suspensions_read_escalation", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_groups", "contacts", "description", "end_notifications_delay", "event_id", "id", "is_enabled", "name", "repeated_notifications_interval", "repeated_notifications_limit", "start_notifications_delay" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `escalation_not_found` (4046655): Nie znaleziono eskalacji.\n* `escalation_weekly_suspension_not_found` (4048625): Nie znaleziono zawieszenia tygodniowego." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca eskalację, której dotyczy wybrane tygodniowe zawieszenie.", "tags" : [ "escalations", "escalation_suspensions" ] } }, "/escalation_weekly_suspensions/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego zawieszenia tygodniowego.", "operationId" : "escalation_weekly_suspensions_read_permissions", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `escalation_weekly_suspension_not_found` (4048625): Nie znaleziono zawieszenia tygodniowego.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego zawieszenia tygodniowego.", "tags" : [ "escalation_suspensions" ] } }, "/escalations" : { "get" : { "description" : "Zwraca listę eskalacji.", "operationId" : "escalations_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_groups", "contacts", "description", "end_notifications_delay", "event_id", "id", "is_enabled", "name", "repeated_notifications_interval", "repeated_notifications_limit", "start_notifications_delay" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_notifications_delay", "event.name", "event.owner_id", "event_id", "id", "is_enabled", "name", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "repeated_notifications_interval", "repeated_notifications_limit", "start_notifications_delay", "-description", "-end_notifications_delay", "-event.name", "-event.owner_id", "-event_id", "-id", "-is_enabled", "-name", "-permissions.create_suspensions", "-permissions.create_weekly_suspensions", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-repeated_notifications_interval", "-repeated_notifications_limit", "-start_notifications_delay" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_notifications_delay", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_notifications_delay!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "repeated_notifications_interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "repeated_notifications_interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "repeated_notifications_limit", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "repeated_notifications_limit!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_notifications_delay", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_notifications_delay!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "event.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_weekly_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_weekly_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalations" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę eskalacji.", "tags" : [ "escalations" ] }, "post" : { "description" : "Tworzy nową eskalację.\n\nJeśli nie zostanie określony atrybut `owner_id`, zostanie użyty identyfikator konta wywołującego użytkownika.\n\nUwaga: Kontakty i zdarzenia muszą należeć do tego samego konta, co eskalacja.", "operationId" : "escalations_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `contact_channel_not_found` (4047880): Nie znaleziono kanału.\n* `contact_group_not_found` (4042471): Nie znaleziono grupy kontaktów.\n* `contact_not_found` (4045290): Nie znaleziono kontaktu.\n* `event_not_found` (4047333): Nie znaleziono zdarzenia." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nową eskalację.", "tags" : [ "escalations" ] } }, "/escalations/search" : { "post" : { "description" : "Zaawansowane pobieranie eskalacji.", "operationId" : "escalations_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalations" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie eskalacji.", "tags" : [ "escalations" ] } }, "/escalations/{_id}" : { "delete" : { "description" : "Usuwa eskalację.", "operationId" : "escalations_delete", "parameters" : [ { "description" : "Identyfikator eskalacji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_not_found` (4046655): Nie znaleziono eskalacji." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa eskalację.", "tags" : [ "escalations" ] }, "get" : { "description" : "Zwraca pojedynczą eskalację.", "operationId" : "escalations_read", "parameters" : [ { "description" : "Identyfikator eskalacji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_groups", "contacts", "description", "end_notifications_delay", "event_id", "id", "is_enabled", "name", "repeated_notifications_interval", "repeated_notifications_limit", "start_notifications_delay" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_not_found` (4046655): Nie znaleziono eskalacji." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczą eskalację.", "tags" : [ "escalations" ] }, "put" : { "description" : "Modyfikuje eskalację.\n\nUwaga: Kontakty, grupy kontaktów i zdarzenie muszą należeć do tego samego konta, co eskalacja.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `event_id` oraz `id`.", "operationId" : "escalations_update", "parameters" : [ { "description" : "Identyfikator eskalacji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `contact_channel_not_found` (4047880): Nie znaleziono kanału.\n* `contact_group_not_found` (4042471): Nie znaleziono grupy kontaktów.\n* `contact_not_found` (4045290): Nie znaleziono kontaktu.\n* `escalation_not_found` (4046655): Nie znaleziono eskalacji.\n* `event_not_found` (4047333): Nie znaleziono zdarzenia." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje eskalację.", "tags" : [ "escalations" ] } }, "/escalations/{_id}/event" : { "get" : { "description" : "Zwraca zdarzenie, o którym należy powiadamiać.", "operationId" : "escalations_read_event", "parameters" : [ { "description" : "Identyfikator eskalacji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "error_type_categories", "error_type_categories.description", "error_type_categories.id", "error_type_categories.name", "excluded_error_type_categories", "excluded_error_type_categories.description", "excluded_error_type_categories.id", "excluded_error_type_categories.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "required_events", "required_events.account_ids", "required_events.description", "required_events.disable_elements", "required_events.disable_main_content", "required_events.disable_steps", "required_events.error_on_elements", "required_events.error_type_category_ids", "required_events.excluded_error_type_category_ids", "required_events.group_ids", "required_events.id", "required_events.is_persistent", "required_events.maximum_sensors_percentage", "required_events.metrics", "required_events.minimum_response_time", "required_events.name", "required_events.owner_id", "required_events.priority", "required_events.required_event_ids", "required_events.sensors_percentage", "required_events.service_ids", "required_events.unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_ids", "description", "disable_elements", "disable_main_content", "disable_steps", "error_on_elements", "error_type_category_ids", "excluded_error_type_category_ids", "group_ids", "id", "is_persistent", "maximum_sensors_percentage", "metrics", "minimum_response_time", "name", "owner_id", "priority", "required_event_ids", "sensors_percentage", "service_ids", "unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `escalation_not_found` (4046655): Nie znaleziono eskalacji.\n* `event_not_found` (4047333): Nie znaleziono zdarzenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca zdarzenie, o którym należy powiadamiać.", "tags" : [ "events", "escalations" ] } }, "/escalations/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranej eskalacji.", "operationId" : "escalations_read_permissions", "parameters" : [ { "description" : "Identyfikator eskalacji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "create_suspensions", "create_weekly_suspensions", "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `escalation_not_found` (4046655): Nie znaleziono eskalacji.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranej eskalacji.", "tags" : [ "permissions", "escalations" ] } }, "/escalations/{_id}/statuses" : { "get" : { "description" : "Zwraca listę aktualnych statusów eskalacji dla usług.", "operationId" : "escalations_read_escalation_statuses", "parameters" : [ { "description" : "Identyfikator eskalacji", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "escalation_id", "event_id", "sent_notifications", "service_id", "summary", "times_notified" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "escalation.name", "escalation_id", "event_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "sent_notifications", "service.name", "service_id", "summary", "times_notified", "-escalation.name", "-escalation_id", "-event_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-sent_notifications", "-service.name", "-service_id", "-summary", "-times_notified" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "escalation_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sent_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sent_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "times_notified", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "times_notified!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "escalation.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_statuses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_not_found` (4046655): Nie znaleziono eskalacji." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę aktualnych statusów eskalacji dla usług.", "tags" : [ "escalations" ] } }, "/escalations/{_id}/suspensions" : { "get" : { "description" : "Zwraca listę zawieszeń eskalacji.", "operationId" : "escalations_read_escalation_suspensions", "parameters" : [ { "description" : "Identyfikator eskalacji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "escalation_id", "id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "escalation.name", "escalation_id", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_time", "-description", "-end_time", "-escalation.name", "-escalation_id", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "escalation.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_not_found` (4046655): Nie znaleziono eskalacji." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zawieszeń eskalacji.", "tags" : [ "escalation_suspensions", "escalations" ] } }, "/escalations/{_id}/weekly_suspensions" : { "get" : { "description" : "Zwraca listę tygodniowych zawieszeń eskalacji.", "operationId" : "escalations_read_escalation_weekly_suspensions", "parameters" : [ { "description" : "Identyfikator eskalacji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "escalation_id", "id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "escalation.name", "escalation_id", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_minute", "-description", "-end_minute", "-escalation.name", "-escalation_id", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_minute" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "escalation.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_weekly_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_not_found` (4046655): Nie znaleziono eskalacji." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę tygodniowych zawieszeń eskalacji.", "tags" : [ "escalation_suspensions", "escalations" ] } }, "/event_statuses" : { "get" : { "description" : "Zwraca listę aktualnych statusów zdarzeń.", "operationId" : "event_statuses_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.delete", "permissions.disable", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "event_id", "service_id", "summary", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "event.name", "event.priority", "event_id", "permissions.delete", "permissions.disable", "permissions.own", "permissions.read", "permissions.update", "service.name", "service_id", "summary", "time", "-event.name", "-event.priority", "-event_id", "-permissions.delete", "-permissions.disable", "-permissions.own", "-permissions.read", "-permissions.update", "-service.name", "-service_id", "-summary", "-time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "event.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.priority", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.disable", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.disable!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_event_statuses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę aktualnych statusów zdarzeń.", "tags" : [ "events" ] } }, "/event_statuses/search" : { "post" : { "description" : "Zaawansowane pobieranie statusów zdarzeń.", "operationId" : "event_statuses_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event_status_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_event_statuses" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie statusów zdarzeń.", "tags" : [ "events" ] } }, "/events" : { "get" : { "description" : "Zwraca listę zdarzeń.", "operationId" : "events_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "error_type_categories", "error_type_categories.description", "error_type_categories.id", "error_type_categories.name", "excluded_error_type_categories", "excluded_error_type_categories.description", "excluded_error_type_categories.id", "excluded_error_type_categories.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "required_events", "required_events.account_ids", "required_events.description", "required_events.disable_elements", "required_events.disable_main_content", "required_events.disable_steps", "required_events.error_on_elements", "required_events.error_type_category_ids", "required_events.excluded_error_type_category_ids", "required_events.group_ids", "required_events.id", "required_events.is_persistent", "required_events.maximum_sensors_percentage", "required_events.metrics", "required_events.minimum_response_time", "required_events.name", "required_events.owner_id", "required_events.priority", "required_events.required_event_ids", "required_events.sensors_percentage", "required_events.service_ids", "required_events.unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_ids", "description", "disable_elements", "disable_main_content", "disable_steps", "error_on_elements", "error_type_category_ids", "excluded_error_type_category_ids", "group_ids", "id", "is_persistent", "maximum_sensors_percentage", "metrics", "minimum_response_time", "name", "owner_id", "priority", "required_event_ids", "sensors_percentage", "service_ids", "unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "disable_elements", "disable_main_content", "error_on_elements", "id", "is_persistent", "maximum_sensors_percentage", "minimum_response_time", "name", "owner.name", "owner.username", "owner_id", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "priority", "sensors_percentage", "unknown_check_results", "-description", "-disable_elements", "-disable_main_content", "-error_on_elements", "-id", "-is_persistent", "-maximum_sensors_percentage", "-minimum_response_time", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.create_escalations", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-priority", "-sensors_percentage", "-unknown_check_results" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "disable_elements", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "disable_elements!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "disable_main_content", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "disable_main_content!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_on_elements", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_on_elements!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_persistent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_persistent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_sensors_percentage", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_sensors_percentage!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum_response_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum_response_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "priority", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sensors_percentage", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensors_percentage!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "unknown_check_results", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "unknown_check_results!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "unknown_check_results~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_escalations", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_escalations!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_events" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zdarzeń.", "tags" : [ "events" ] }, "post" : { "description" : "Tworzy nowe zdarzenie.\n\nJeśli nie zostanie określony atrybut `owner_id`, zostanie użyty identyfikator konta wywołującego użytkownika.", "operationId" : "events_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `error_type_category_not_found` (4042758): Nie znaleziono kategorii typów błędu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe zdarzenie.", "tags" : [ "events" ] } }, "/events/search" : { "post" : { "description" : "Zaawansowane pobieranie zdarzeń.", "operationId" : "events_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_events" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie zdarzeń.", "tags" : [ "events" ] } }, "/events/{_id}" : { "delete" : { "description" : "Usuwa zdarzenie razem z jego eskalacjami.", "operationId" : "events_delete", "parameters" : [ { "description" : "Identyfikator zdarzenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`event_not_found` (4047333): Nie znaleziono zdarzenia." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa zdarzenie razem z jego eskalacjami.", "tags" : [ "events" ] }, "get" : { "description" : "Zwraca pojedyncze zdarzenie.", "operationId" : "events_read", "parameters" : [ { "description" : "Identyfikator zdarzenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "error_type_categories", "error_type_categories.description", "error_type_categories.id", "error_type_categories.name", "excluded_error_type_categories", "excluded_error_type_categories.description", "excluded_error_type_categories.id", "excluded_error_type_categories.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "required_events", "required_events.account_ids", "required_events.description", "required_events.disable_elements", "required_events.disable_main_content", "required_events.disable_steps", "required_events.error_on_elements", "required_events.error_type_category_ids", "required_events.excluded_error_type_category_ids", "required_events.group_ids", "required_events.id", "required_events.is_persistent", "required_events.maximum_sensors_percentage", "required_events.metrics", "required_events.minimum_response_time", "required_events.name", "required_events.owner_id", "required_events.priority", "required_events.required_event_ids", "required_events.sensors_percentage", "required_events.service_ids", "required_events.unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_ids", "description", "disable_elements", "disable_main_content", "disable_steps", "error_on_elements", "error_type_category_ids", "excluded_error_type_category_ids", "group_ids", "id", "is_persistent", "maximum_sensors_percentage", "metrics", "minimum_response_time", "name", "owner_id", "priority", "required_event_ids", "sensors_percentage", "service_ids", "unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`event_not_found` (4047333): Nie znaleziono zdarzenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze zdarzenie.", "tags" : [ "events" ] }, "put" : { "description" : "Modyfikuje zdarzenie.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `owner_id`.", "operationId" : "events_update", "parameters" : [ { "description" : "Identyfikator zdarzenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `error_type_category_not_found` (4042758): Nie znaleziono kategorii typów błędu.\n* `event_not_found` (4047333): Nie znaleziono zdarzenia." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `cyclic_event_dependencies` (4222251): Cykliczna zależność zdarzeń.\n* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje zdarzenie.", "tags" : [ "events" ] } }, "/events/{_id}/escalations" : { "get" : { "description" : "Zwraca listę eskalacji przypisanych do zdarzenia.", "operationId" : "events_read_escalations", "parameters" : [ { "description" : "Identyfikator zdarzenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "contact_groups", "contacts", "description", "end_notifications_delay", "event_id", "id", "is_enabled", "name", "repeated_notifications_interval", "repeated_notifications_limit", "start_notifications_delay" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_notifications_delay", "event.name", "event.owner_id", "event_id", "id", "is_enabled", "name", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "repeated_notifications_interval", "repeated_notifications_limit", "start_notifications_delay", "-description", "-end_notifications_delay", "-event.name", "-event.owner_id", "-event_id", "-id", "-is_enabled", "-name", "-permissions.create_suspensions", "-permissions.create_weekly_suspensions", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-repeated_notifications_interval", "-repeated_notifications_limit", "-start_notifications_delay" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_notifications_delay", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_notifications_delay!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "repeated_notifications_interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "repeated_notifications_interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "repeated_notifications_limit", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "repeated_notifications_limit!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_notifications_delay", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_notifications_delay!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "event.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_weekly_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_weekly_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalations" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`event_not_found` (4047333): Nie znaleziono zdarzenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę eskalacji przypisanych do zdarzenia.", "tags" : [ "escalations", "events" ] } }, "/events/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy wybrane zdarzenie.", "operationId" : "events_read_owner", "parameters" : [ { "description" : "Identyfikator zdarzenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `event_not_found` (4047333): Nie znaleziono zdarzenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy wybrane zdarzenie.", "tags" : [ "accounts", "events" ] } }, "/events/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego zdarzenia.", "operationId" : "events_read_permissions", "parameters" : [ { "description" : "Identyfikator zdarzenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "create_escalations", "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `event_not_found` (4047333): Nie znaleziono zdarzenia.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego zdarzenia.", "tags" : [ "permissions", "events" ] } }, "/events/{_id}/possible_conditions" : { "get" : { "description" : "Zwraca listę zdarzeń od których może zależeć wybrane zdarzenie.", "operationId" : "events_read_possible_conditions", "parameters" : [ { "description" : "Identyfikator zdarzenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "error_type_categories", "error_type_categories.description", "error_type_categories.id", "error_type_categories.name", "excluded_error_type_categories", "excluded_error_type_categories.description", "excluded_error_type_categories.id", "excluded_error_type_categories.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "required_events", "required_events.account_ids", "required_events.description", "required_events.disable_elements", "required_events.disable_main_content", "required_events.disable_steps", "required_events.error_on_elements", "required_events.error_type_category_ids", "required_events.excluded_error_type_category_ids", "required_events.group_ids", "required_events.id", "required_events.is_persistent", "required_events.maximum_sensors_percentage", "required_events.metrics", "required_events.minimum_response_time", "required_events.name", "required_events.owner_id", "required_events.priority", "required_events.required_event_ids", "required_events.sensors_percentage", "required_events.service_ids", "required_events.unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_ids", "description", "disable_elements", "disable_main_content", "disable_steps", "error_on_elements", "error_type_category_ids", "excluded_error_type_category_ids", "group_ids", "id", "is_persistent", "maximum_sensors_percentage", "metrics", "minimum_response_time", "name", "owner_id", "priority", "required_event_ids", "sensors_percentage", "service_ids", "unknown_check_results" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "disable_elements", "disable_main_content", "error_on_elements", "id", "is_persistent", "maximum_sensors_percentage", "minimum_response_time", "name", "owner.name", "owner.username", "owner_id", "permissions.create_escalations", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "priority", "sensors_percentage", "unknown_check_results", "-description", "-disable_elements", "-disable_main_content", "-error_on_elements", "-id", "-is_persistent", "-maximum_sensors_percentage", "-minimum_response_time", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.create_escalations", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-priority", "-sensors_percentage", "-unknown_check_results" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "disable_elements", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "disable_elements!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "disable_main_content", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "disable_main_content!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_on_elements", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_on_elements!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_persistent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_persistent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_sensors_percentage", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_sensors_percentage!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum_response_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum_response_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "priority", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sensors_percentage", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensors_percentage!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "unknown_check_results", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "unknown_check_results!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "unknown_check_results~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_escalations", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_escalations!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_events" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`event_not_found` (4047333): Nie znaleziono zdarzenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zdarzeń od których może zależeć wybrane zdarzenie.", "tags" : [ "events" ] } }, "/events/{_id}/statuses" : { "get" : { "description" : "Zwraca listę aktualnych statusów zdarzenia dla poszczególnych usług.", "operationId" : "events_read_event_statuses", "parameters" : [ { "description" : "Identyfikator zdarzenia", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.delete", "permissions.disable", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "event_id", "service_id", "summary", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "event.name", "event.priority", "event_id", "permissions.delete", "permissions.disable", "permissions.own", "permissions.read", "permissions.update", "service.name", "service_id", "summary", "time", "-event.name", "-event.priority", "-event_id", "-permissions.delete", "-permissions.disable", "-permissions.own", "-permissions.read", "-permissions.update", "-service.name", "-service_id", "-summary", "-time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "event.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.priority", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.disable", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.disable!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_event_statuses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`event_not_found` (4047333): Nie znaleziono zdarzenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę aktualnych statusów zdarzenia dla poszczególnych usług.", "tags" : [ "events" ] } }, "/group_stats" : { "get" : { "description" : "Zwraca listę statystyk grup.", "operationId" : "group_stats_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "id", "sensors_count", "services_count", "services_count_archived", "services_count_failure", "services_count_ok", "services_count_paused", "services_count_suspended", "services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "sensors_count", "services_count", "services_count_archived", "services_count_failure", "services_count_ok", "services_count_paused", "services_count_suspended", "services_count_unknown", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-sensors_count", "-services_count", "-services_count_archived", "-services_count_failure", "-services_count_ok", "-services_count_paused", "-services_count_suspended", "-services_count_unknown" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensors_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "services_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "services_count_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "services_count_failure!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "services_count_ok!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "services_count_paused!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "services_count_suspended!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "services_count_unknown!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_group_stats" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę statystyk grup.", "tags" : [ "group_stats" ] } }, "/group_stats/search" : { "post" : { "description" : "Zaawansowane pobieranie statystyk grup.", "operationId" : "group_stats_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group_stat_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_group_stats" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie statystyk grup.", "tags" : [ "group_stats" ] } }, "/group_stats/{_id}" : { "get" : { "description" : "Zwraca aktualne statystyki pojedynczej grupy.", "operationId" : "group_stats_read", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "id", "sensors_count", "services_count", "services_count_archived", "services_count_failure", "services_count_ok", "services_count_paused", "services_count_suspended", "services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group_stat" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_stats_not_found` (4040765): Nie znaleziono statystyk grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca aktualne statystyki pojedynczej grupy.", "tags" : [ "group_stats" ] } }, "/group_stats/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do statystyk wybranej grupy.", "operationId" : "group_stats_read_permissions", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_stats_not_found` (4040765): Nie znaleziono statystyk grupy.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do statystyk wybranej grupy.", "tags" : [ "permissions", "group_stats" ] } }, "/groups" : { "get" : { "description" : "Zwraca listę grup usług.", "operationId" : "groups_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "stats", "stats.id", "stats.sensors_count", "stats.services_count", "stats.services_count_archived", "stats.services_count_failure", "stats.services_count_ok", "stats.services_count_paused", "stats.services_count_suspended", "stats.services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "assigned_sensor_ids", "id", "is_default", "name", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "sensor_ids" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "id", "is_default", "name", "owner.name", "owner.username", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "stats.sensors_count", "stats.services_count", "-archived_services_in_periodic_reports", "-id", "-is_default", "-name", "-owner.name", "-owner.username", "-owner_id", "-periodic_daily_reports", "-periodic_monthly_reports", "-periodic_weekly_reports", "-permissions.create_notification_addresses", "-permissions.create_periodic_report_addresses", "-permissions.create_services", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.send_test_sms_notifications", "-permissions.share", "-permissions.update", "-stats.sensors_count", "-stats.services_count" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "archived_services_in_periodic_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "archived_services_in_periodic_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_default", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_default!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "periodic_daily_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "periodic_daily_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "periodic_monthly_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "periodic_monthly_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "periodic_weekly_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "periodic_weekly_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_notification_addresses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_notification_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_periodic_report_addresses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_periodic_report_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.share", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.share!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.sensors_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.services_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_groups" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę grup usług.", "tags" : [ "groups" ] }, "post" : { "description" : "Tworzy nową grupę.\n\nJeśli nie zostanie określony atrybut `owner_id`, zostanie użyty identyfikator konta wywołującego użytkownika.\n\nJeśli nie zostanie określony atrybut `sensor_ids`, do grupy zostaną przydzielone dwie stacje monitorujące wybrane losowo spośród dostępnych, o ile pakiet konta na to pozwala i istnieje wystarczająca liczba dostępnych stacji.", "operationId" : "groups_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `sensor_not_available` (4037635): Wybrana stacja monitorująca nie jest dostępna.\n* `sensor_not_available_for_account` (4030863): Wybrana stacja monitorująca nie jest dostępna dla konta.\n* `too_many_sensors` (4033810): Wybrano więcej stacji monitorujących niż dozwolone w pakiecie." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `sensor_not_found` (4049807): Nie znaleziono stacji monitorującej.\n* `service_type_category_not_found` (4043944): Nie znaleziono kategorii typów usług." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_short` (4225465): Tablica jest zbyt krótka.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nową grupę.", "tags" : [ "groups" ] } }, "/groups/bulk_delete" : { "post" : { "description" : "Usuwa wiele grup jednocześnie.\n\nW treści zapytania należy podać tablicę identyfikatorów grup, do których posiadamy uprawnienie `delete`.\n\nUWAGA: Ta operacja usuwa także wszystkie usługi, adresy powiadomień i raportów przypisane do usuwanych grup.", "operationId" : "groups_bulk_delete", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa wiele grup jednocześnie.", "tags" : [ "groups" ] } }, "/groups/search" : { "post" : { "description" : "Zaawansowane pobieranie grup usług.", "operationId" : "groups_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_groups" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie grup usług.", "tags" : [ "groups" ] } }, "/groups/{_id}" : { "delete" : { "description" : "Usuwa grupę usług.\n\nUsuwa grupę usług razem z należącymi do niej usługami oraz przypisanymi adresami powiadomień i raportów.\n\nNie jest możliwe usunięcie grupy domyślnej.", "operationId" : "groups_delete", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa grupę usług.", "tags" : [ "groups" ] }, "get" : { "description" : "Zwraca pojedynczą grupę usług.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_read", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "stats", "stats.id", "stats.sensors_count", "stats.services_count", "stats.services_count_archived", "stats.services_count_failure", "stats.services_count_ok", "stats.services_count_paused", "stats.services_count_suspended", "stats.services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "assigned_sensor_ids", "id", "is_default", "name", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "sensor_ids" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczą grupę usług.", "tags" : [ "groups" ] }, "put" : { "description" : "Modyfikuje grupę.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id`, `is_default` oraz `owner_id`.", "operationId" : "groups_update", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `sensor_not_available` (4037635): Wybrana stacja monitorująca nie jest dostępna.\n* `sensor_not_available_for_account` (4030863): Wybrana stacja monitorująca nie jest dostępna dla konta.\n* `too_many_sensors` (4033810): Wybrano więcej stacji monitorujących niż dozwolone w pakiecie.\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `sensor_not_found` (4049807): Nie znaleziono stacji monitorującej.\n* `service_type_category_not_found` (4043944): Nie znaleziono kategorii typów usług." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_short` (4225465): Tablica jest zbyt krótka.\n* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje grupę.", "tags" : [ "groups" ] } }, "/groups/{_id}/available_sensors" : { "get" : { "description" : "Zwraca listę stacji monitorujących dostępnych dla grupy.\n\n\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "groups_read_available_sensors", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę stacji monitorujących dostępnych dla grupy.", "tags" : [ "sensors", "groups" ] } }, "/groups/{_id}/available_sensors/by_service_type/{_service_type_id}" : { "get" : { "description" : "Zwraca listę stacji monitorujących dostępnych dla usług danego typu w grupie.\n\n\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "groups_read_available_type_sensors", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator typu usługi.", "in" : "path", "name" : "_service_type_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `service_type_not_found` (4048434): Nie znaleziono typu usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę stacji monitorujących dostępnych dla usług danego typu w grupie.", "tags" : [ "sensors", "groups" ] } }, "/groups/{_id}/available_service_types" : { "get" : { "description" : "Zwraca listę typów usług do wykorzystania dla konta, do którego należy grupa.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych po identyfikatorze typu.", "operationId" : "groups_read_available_service_types", "parameters" : [ { "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "service_type", "service_type.address_prefix", "service_type.category_id", "service_type.customizable_step_names", "service_type.description", "service_type.id", "service_type.manual_schedule", "service_type.name", "service_type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "minimum_interval", "remaining_services", "service_type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "minimum_interval", "service_type_id", "-account_id", "-minimum_interval", "-service_type_id" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "account_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum_interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum_interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "remaining_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_type_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_type_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service_type_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_service_type_limits" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę typów usług do wykorzystania dla konta, do którego należy grupa.", "tags" : [ "service_types", "groups" ] } }, "/groups/{_id}/mobile_devices_count" : { "get" : { "description" : "Zwraca liczbę urządzeń mobilnych otrzymujących powiadomienia o usługach z grupy.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_read_mobile_devices_count", "parameters" : [ { "description" : "Identyfikator grupy", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "minimum" : 0, "type" : "integer" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca liczbę urządzeń mobilnych otrzymujących powiadomienia o usługach z grupy.", "tags" : [ "mobile" ] } }, "/groups/{_id}/notification_addresses" : { "get" : { "description" : "Zwraca listę adresów powiadomień przypisanych do grupy.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_read_notification_addresses", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "notification_channel", "notification_channel.description", "notification_channel.id", "notification_channel.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group_id", "id", "notification_channel_id", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group.name", "group_id", "id", "notification_channel_id", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update", "-address", "-description", "-group.name", "-group_id", "-id", "-notification_channel_id", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.send_test_sms_notifications", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "notification_channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "notification_channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "notification_channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów powiadomień przypisanych do grupy.", "tags" : [ "notification_addresses", "groups" ] } }, "/groups/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy wybrana grupa.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_read_owner", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `group_not_found` (4046627): Nie znaleziono grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy wybrana grupa.", "tags" : [ "accounts", "groups" ] } }, "/groups/{_id}/periodic_report_addresses" : { "get" : { "description" : "Zwraca listę adresów raportów okresowych przypisanych do grupy.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_read_periodic_report_addresses", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "report_frequency" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "report_frequency", "-address", "-group_id", "-id", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-report_frequency" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "report_frequency", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "report_frequency!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "report_frequency~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_periodic_report_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów raportów okresowych przypisanych do grupy.", "tags" : [ "periodic_report_addresses", "groups" ] } }, "/groups/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranej grupy usług.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_read_permissions", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "create_notification_addresses", "create_periodic_report_addresses", "create_services", "delete", "own", "read", "send_test_sms_notifications", "share", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranej grupy usług.", "tags" : [ "permissions", "groups" ] } }, "/groups/{_id}/send_test_sms_notification" : { "post" : { "description" : "Wysyła testowe powiadomienie SMS na numery telefonu przypisane do grupy.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_send_test_sms", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/test_sms_notification_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `sms_test_not_allowed` (4031215): Brak uprawnień do wysyłania testowych powiadomień SMS." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wysyła testowe powiadomienie SMS na numery telefonu przypisane do grupy.", "tags" : [ "groups" ] } }, "/groups/{_id}/sensors" : { "get" : { "description" : "Zwraca listę stacji monitorujących przypisanych do grupy w kategorii `default`.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "groups_read_sensors", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę stacji monitorujących przypisanych do grupy w kategorii `default`.", "tags" : [ "sensors", "groups" ] } }, "/groups/{_id}/services" : { "get" : { "description" : "Zwraca listę usług należących do grupy.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_read_services", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "monitoring_sensors", "monitoring_sensors.city", "monitoring_sensors.continent", "monitoring_sensors.country", "monitoring_sensors.dns_diagnostics_available", "monitoring_sensors.id", "monitoring_sensors.ip_address", "monitoring_sensors.ipv6_address", "monitoring_sensors.is_available", "monitoring_sensors.is_enabled", "monitoring_sensors.links", "monitoring_sensors.name", "monitoring_sensors.service_type_category_ids", "monitoring_sensors.traceroute_diagnostics_available", "notification_channels", "notification_channels.description", "notification_channels.id", "notification_channels.name", "notification_conditions", "notification_conditions.description", "notification_conditions.id", "notification_conditions.name", "notification_mode", "notification_mode.description", "notification_mode.id", "notification_mode.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "recovery_notification_mode", "recovery_notification_mode.description", "recovery_notification_mode.id", "recovery_notification_mode.name", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "status", "status.average_response_time", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.id", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.last_failure_analysis_id", "status.last_failure_analysis_time", "status.last_ok_analysis_id", "status.last_ok_analysis_time", "status.monitoring_status", "status.notifications_status", "status.summary", "type", "type.address_prefix", "type.category_id", "type.customizable_step_names", "type.description", "type.id", "type.manual_schedule", "type.name", "type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "extended_settings", "group_id", "id", "interval", "is_active", "is_archived", "name", "notification_channel_ids", "notification_condition_ids", "notification_mode_id", "owner_id", "recovery_notification_mode_id", "sensor_ids", "silent_hours", "step_names", "suspension_hours", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group.is_default", "group.name", "group_id", "id", "interval", "is_active", "is_archived", "name", "owner.name", "owner.username", "owner_id", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.monitoring_status", "status.summary", "type.category_id", "type.name", "type_id", "-address", "-description", "-group.is_default", "-group.name", "-group_id", "-id", "-interval", "-is_active", "-is_archived", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.archive", "-permissions.create_corrections", "-permissions.create_scheduled_suspensions", "-permissions.create_suspensions", "-permissions.create_weekly_suspensions", "-permissions.delete", "-permissions.force_analyses", "-permissions.force_custom_analyses", "-permissions.own", "-permissions.read", "-permissions.restore", "-permissions.send_test_sms_notifications", "-permissions.update", "-permissions.update_step_names", "-status.check_status", "-status.check_status_is_up_to_date", "-status.highest_active_event_priority", "-status.last_analysis_id", "-status.last_analysis_time", "-status.last_check_status_change_time", "-status.monitoring_status", "-status.summary", "-type.category_id", "-type.name", "-type_id" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "notification_mode_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "recovery_notification_mode_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "silent_hours!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "suspension_hours!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.is_default", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.is_default!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.archive", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.archive!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_corrections", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_corrections!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_scheduled_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_scheduled_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_weekly_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_weekly_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.force_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.force_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.force_custom_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.force_custom_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.restore", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.restore!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update_step_names", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update_step_names!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.check_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.check_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.check_status_is_up_to_date", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.check_status_is_up_to_date!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.check_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.highest_active_event_priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.last_analysis_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.last_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.last_analysis_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.last_analysis_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.last_check_status_change_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.last_check_status_change_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.monitoring_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.monitoring_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.monitoring_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type.category_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type.category_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type.category_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_services" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę usług należących do grupy.", "tags" : [ "services", "groups" ] } }, "/groups/{_id}/shares" : { "get" : { "description" : "Zwraca ustawienia udostępniania grupy.", "operationId" : "groups_read_group_shares", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "account", "account.disable_legacy_notifications", "account.id", "account.is_activated", "account.is_blocked", "account.is_read_only", "account.language_id", "account.name", "account.package_id", "account.parent_account_id", "account.time_zone_id", "account.username", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "can_archive_services", "can_create_services", "can_delete_services", "can_force_analyses", "can_modify_group", "can_modify_services", "group_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "account.name", "account.username", "account_id", "can_archive_services", "can_create_services", "can_delete_services", "can_force_analyses", "can_modify_group", "can_modify_services", "group.is_default", "group.name", "group.owner_id", "group_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-account.name", "-account.username", "-account_id", "-can_archive_services", "-can_create_services", "-can_delete_services", "-can_force_analyses", "-can_modify_group", "-can_modify_services", "-group.is_default", "-group.name", "-group.owner_id", "-group_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "account_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_archive_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_archive_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_create_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_create_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_delete_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_delete_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_force_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_force_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_modify_group", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_modify_group!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "can_modify_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_modify_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "account.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "account.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "account.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "account.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.is_default", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.is_default!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_group_shares" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_not_found` (4046627): Nie znaleziono grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca ustawienia udostępniania grupy.", "tags" : [ "accounts", "groups" ] } }, "/groups/{_id}/shares/{_account_id}" : { "delete" : { "description" : "Usuwa udostępnienie grupy użytkownikowi.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_delete_share", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_share_not_found` (4044979): Nie znaleziono udostępnienia grupy." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa udostępnienie grupy użytkownikowi.", "tags" : [ "accounts", "groups" ] }, "get" : { "description" : "Zwraca ustawienia udostępnienia grupy wybranemu użytkownikowi.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_read_share", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "account", "account.disable_legacy_notifications", "account.id", "account.is_activated", "account.is_blocked", "account.is_read_only", "account.language_id", "account.name", "account.package_id", "account.parent_account_id", "account.time_zone_id", "account.username", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_id", "can_archive_services", "can_create_services", "can_delete_services", "can_force_analyses", "can_modify_group", "can_modify_services", "group_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group_share" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`group_share_not_found` (4044979): Nie znaleziono udostępnienia grupy." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca ustawienia udostępnienia grupy wybranemu użytkownikowi.", "tags" : [ "accounts", "groups" ] }, "put" : { "description" : "Tworzy lub modyfikuje udostępnienie grupy użytkownikowi.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `account_id` oraz `group_id`.", "operationId" : "groups_update_share", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group_share" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `replace_not_allowed` (4035613): Brak uprawnień do modyfikacji lub utworzenia obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `group_not_found` (4046627): Nie znaleziono grupy." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `id_mismatch` (4226426): Identyfikator obiektu zawarty w adresie URL nie jest zgodny z wartością identyfikatora w samym obiekcie.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy lub modyfikuje udostępnienie grupy użytkownikowi.", "tags" : [ "accounts", "groups" ] } }, "/groups/{_id}/shares/{_account_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do ustawień udostępnienia grupy wybranemu użytkownikowi.\n\nMożliwe jest użycie specjalnej wartości \"my_default_group\" zamiast identyfikatora, aby wybrać własną grupę domyślną.", "operationId" : "groups_read_share_permissions", "parameters" : [ { "description" : "Identyfikator grupy.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator konta.", "in" : "path", "name" : "_account_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_share_not_found` (4044979): Nie znaleziono udostępnienia grupy.\n* `not_found` (4048233): Nie znaleziono zasobu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do ustawień udostępnienia grupy wybranemu użytkownikowi.", "tags" : [ "accounts", "permissions", "groups" ] } }, "/mobile/devices/{_id}" : { "delete" : { "description" : "Wyrejestrowuje urządzenie mobilne z powiadomień push.", "operationId" : "mobile_unregister_device", "parameters" : [ { "description" : "Identyfikator urządzenia (FCM registration token).", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wyrejestrowuje urządzenie mobilne z powiadomień push.", "tags" : [ "mobile" ] }, "put" : { "description" : "Rejestruje urządzenie mobilne do powiadomień push.", "operationId" : "mobile_register_device", "parameters" : [ { "description" : "Identyfikator urządzenia (FCM registration token).", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_mobile_device_id` (4228361): Niepoprawny token rejestracji FCM." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Rejestruje urządzenie mobilne do powiadomień push.", "tags" : [ "mobile" ] } }, "/mobile/notifications/{_id}" : { "get" : { "description" : "Zwraca pełną treść powiadomienia push.", "operationId" : "mobile_read_notification", "parameters" : [ { "description" : "Identyfikator powiadomienia, otrzymany w treści wiadomości push.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/any" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`mobile_notification_not_found` (4040402): Nie znaleziono powiadomienia aplikacji mobilnej." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pełną treść powiadomienia push.", "tags" : [ "mobile" ] } }, "/notification_addresses" : { "get" : { "description" : "Zwraca listę adresów powiadomień.", "operationId" : "notification_addresses_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "notification_channel", "notification_channel.description", "notification_channel.id", "notification_channel.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group_id", "id", "notification_channel_id", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group.name", "group_id", "id", "notification_channel_id", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update", "-address", "-description", "-group.name", "-group_id", "-id", "-notification_channel_id", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.send_test_sms_notifications", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "notification_channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "notification_channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "notification_channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów powiadomień.", "tags" : [ "notification_addresses" ] }, "post" : { "description" : "Tworzy nowy adres powiadomień.\n\nLiczba adresów SMS możliwych do stworzenia może być ograniczona pakietem konta, do którego należy grupa.\n\nZa pomocą tej operacji nie jest możliwe tworzenie adresów dla kanału push - aby zarejestrować urządzenie mobilne należy skorzystać z operacji `PUT /mobile/devices/{_id}`.\n\nJeśli nie zostanie podany atrybut `owner_id`, a zostanie podany `group_id`, domyślną wartością `owner_id` jest identyfikator konta, do którego należy wybrana grupa.\n\nJeśli zostanie podany atrybut `owner_id`, a nie `group_id`, domyślną wartością `group_id` jest identyfikator grupy domyślnej wybranego konta.\n\nJeśli nie zostanie podany atrybut `owner_id` ani `group_id`, domyślną wartością `owner_id` jest identyfikator konta wywołującego użytkownika, a `group_id` - identyfikator jego grupy domyślnej.\n\nGrupa o identyfikatorze określonym w `group_id` musi należeć do konta o identyfikatorze `owner_id`.", "operationId" : "notification_addresses_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_address_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_address_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `notification_channel_unavailable` (4039451): Wybrany kanał powiadomień nie jest dostępny w pakiecie.\n* `sms_numbers_limit_reached` (4036531): Osiągnięto limit numerów SMS dla grupy określony w pakiecie." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `group_not_found` (4046627): Nie znaleziono grupy.\n* `notification_channel_not_found` (4041457): Nie znaleziono kanału powiadomień." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_in_account` (4226950): Grupa nie należy do wybranego konta.\n* `incorrect_notification_address` (4226443): Niepoprawny adres powiadomień.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowy adres powiadomień.", "tags" : [ "notification_addresses" ] } }, "/notification_addresses/search" : { "post" : { "description" : "Zaawansowane pobieranie adresów powiadomień.", "operationId" : "notification_addresses_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_address_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_addresses" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie adresów powiadomień.", "tags" : [ "notification_addresses" ] } }, "/notification_addresses/{_id}" : { "delete" : { "description" : "Usuwa adres powiadomień.", "operationId" : "notification_addresses_delete", "parameters" : [ { "description" : "Identyfikator adresu powiadomień.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`notification_address_not_found` (4046845): Nie znaleziono adresu powiadomień." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa adres powiadomień.", "tags" : [ "notification_addresses" ] }, "get" : { "description" : "Zwraca pojedynczy adres powiadomień.", "operationId" : "notification_addresses_read", "parameters" : [ { "description" : "Identyfikator adresu powiadomień.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "notification_channel", "notification_channel.description", "notification_channel.id", "notification_channel.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group_id", "id", "notification_channel_id", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_address" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`notification_address_not_found` (4046845): Nie znaleziono adresu powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy adres powiadomień.", "tags" : [ "notification_addresses" ] }, "put" : { "description" : "Modyfikuje adres powiadomień.\n\nW przypadku zmiany grupy, nowa grupa musi należeć do tego samego konta, co poprzednia.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `owner_id`.", "operationId" : "notification_addresses_update", "parameters" : [ { "description" : "Identyfikator adresu powiadomień.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_address" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `move_not_allowed` (4038858): Brak uprawnień do przeniesienia obiektu.\n* `notification_channel_unavailable` (4039451): Wybrany kanał powiadomień nie jest dostępny w pakiecie.\n* `sms_numbers_limit_reached` (4036531): Osiągnięto limit numerów SMS dla grupy określony w pakiecie.\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `notification_address_not_found` (4046845): Nie znaleziono adresu powiadomień.\n* `notification_channel_not_found` (4041457): Nie znaleziono kanału powiadomień." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `group_not_in_account` (4226950): Grupa nie należy do wybranego konta.\n* `incorrect_notification_address` (4226443): Niepoprawny adres powiadomień.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje adres powiadomień.", "tags" : [ "notification_addresses" ] } }, "/notification_addresses/{_id}/group" : { "get" : { "description" : "Zwraca grupę, do której jest przypisany adres powiadomień.", "operationId" : "notification_addresses_read_group", "parameters" : [ { "description" : "Identyfikator adresu powiadomień.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "stats", "stats.id", "stats.sensors_count", "stats.services_count", "stats.services_count_archived", "stats.services_count_failure", "stats.services_count_ok", "stats.services_count_paused", "stats.services_count_suspended", "stats.services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "assigned_sensor_ids", "id", "is_default", "name", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "sensor_ids" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `notification_address_not_found` (4046845): Nie znaleziono adresu powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca grupę, do której jest przypisany adres powiadomień.", "tags" : [ "groups", "notification_addresses" ] } }, "/notification_addresses/{_id}/notification_channel" : { "get" : { "description" : "Zwraca kanał powiadomień dla wybranego adresu.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "notification_addresses_read_notification_channel", "parameters" : [ { "description" : "Identyfikator adresu powiadomień.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_channel" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `notification_address_not_found` (4046845): Nie znaleziono adresu powiadomień.\n* `notification_channel_not_found` (4041457): Nie znaleziono kanału powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca kanał powiadomień dla wybranego adresu.", "tags" : [ "notification_addresses" ] } }, "/notification_addresses/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy adres powiadomień.", "operationId" : "notification_addresses_read_owner", "parameters" : [ { "description" : "Identyfikator adresu powiadomień.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `notification_address_not_found` (4046845): Nie znaleziono adresu powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy adres powiadomień.", "tags" : [ "accounts", "notification_addresses" ] } }, "/notification_addresses/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do adresu powiadomień.", "operationId" : "notification_addresses_read_permissions", "parameters" : [ { "description" : "Identyfikator adresu powiadomień.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "send_test_sms_notifications", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_address_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `notification_address_not_found` (4046845): Nie znaleziono adresu powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do adresu powiadomień.", "tags" : [ "permissions", "notification_addresses" ] } }, "/notification_addresses/{_id}/send_test_sms_notification" : { "post" : { "description" : "Wysyła testowe powiadomienie SMS.", "operationId" : "notification_addresses_send_test_sms", "parameters" : [ { "description" : "Identyfikator adresu powiadomień.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/test_sms_notification_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `sms_test_not_allowed` (4031215): Brak uprawnień do wysyłania testowych powiadomień SMS." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`notification_address_not_found` (4046845): Nie znaleziono adresu powiadomień." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wysyła testowe powiadomienie SMS.", "tags" : [ "notification_addresses" ] } }, "/packages" : { "get" : { "description" : "Zwraca listę pakietów.", "operationId" : "packages_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channels", "available_notification_channels.description", "available_notification_channels.id", "available_notification_channels.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channel_ids", "available_service_types", "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-can_force_custom_analyses", "-id", "-is_available_for_new_accounts", "-maximum_sensors", "-maximum_services", "-maximum_sms_numbers", "-minimum_interval", "-monthly_reports_limit", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "can_force_custom_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_force_custom_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available_for_new_accounts", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available_for_new_accounts!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_sensors", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_sensors!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_sms_numbers", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_sms_numbers!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum_interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum_interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "monthly_reports_limit", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "monthly_reports_limit!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_packages" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę pakietów.", "tags" : [ "packages" ] } }, "/packages/available_for_new_accounts" : { "get" : { "description" : "Zwraca listę pakietów dostępnych przy rejestracji nowego konta.\n\nUwaga: Ta lista dotyczy jedynie kont zakładanych przez publiczną operację `POST /accounts/register`, wymagającą potwierdzenia adresu e-mail.\n\nNie dotyczy kont dodatkowych użytkowników ani kont zakładanych z poziomu API administracyjnego.", "operationId" : "packages_read_available_for_new_accounts", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channels", "available_notification_channels.description", "available_notification_channels.id", "available_notification_channels.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channel_ids", "available_service_types", "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-can_force_custom_analyses", "-id", "-is_available_for_new_accounts", "-maximum_sensors", "-maximum_services", "-maximum_sms_numbers", "-minimum_interval", "-monthly_reports_limit", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "can_force_custom_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "can_force_custom_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available_for_new_accounts", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available_for_new_accounts!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_sensors", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_sensors!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_sms_numbers", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_sms_numbers!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum_interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum_interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "monthly_reports_limit", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "monthly_reports_limit!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_packages" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę pakietów dostępnych przy rejestracji nowego konta.", "tags" : [ "packages" ] } }, "/packages/search" : { "post" : { "description" : "Zaawansowane pobieranie pakietów.", "operationId" : "packages_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/package_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_packages" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie pakietów.", "tags" : [ "packages" ] } }, "/packages/{_id}" : { "get" : { "description" : "Zwraca pojedynczy pakiet.\n\nMożliwe jest użycie specjalnej wartości \"my_package\" zamiast identyfikatora, aby wybrać własny pakiet.", "operationId" : "packages_read", "parameters" : [ { "description" : "Identyfikator pakietu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channels", "available_notification_channels.description", "available_notification_channels.id", "available_notification_channels.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "available_notification_channel_ids", "available_service_types", "can_force_custom_analyses", "id", "is_available_for_new_accounts", "maximum_sensors", "maximum_services", "maximum_sms_numbers", "minimum_interval", "monthly_reports_limit", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/package" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`package_not_found` (4046424): Nie znaleziono pakietu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy pakiet.", "tags" : [ "packages" ] } }, "/packages/{_id}/available_notification_channels" : { "get" : { "description" : "Zwraca listę kanałów powiadomień dostępnych w pakiecie.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "packages_read_available_notification_channels", "parameters" : [ { "description" : "Identyfikator pakietu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_channels" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`package_not_found` (4046424): Nie znaleziono pakietu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę kanałów powiadomień dostępnych w pakiecie.", "tags" : [ "packages" ] } }, "/packages/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego pakietu.\n\nMożliwe jest użycie specjalnej wartości \"my_package\" zamiast identyfikatora, aby wybrać własny pakiet.", "operationId" : "packages_read_permissions", "parameters" : [ { "description" : "Identyfikator pakietu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `package_not_found` (4046424): Nie znaleziono pakietu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego pakietu.", "tags" : [ "permissions", "packages" ] } }, "/periodic_report_addresses" : { "get" : { "description" : "Zwraca listę adresów raportów okresowych.", "operationId" : "periodic_report_addresses_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "report_frequency" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "report_frequency", "-address", "-group_id", "-id", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-report_frequency" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "report_frequency", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "report_frequency!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "report_frequency~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_periodic_report_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów raportów okresowych.", "tags" : [ "periodic_report_addresses" ] }, "post" : { "description" : "Tworzy nowy adres raportów okresowych.\n\nJeśli nie zostanie podany atrybut `owner_id`, a zostanie podany `group_id`, domyślną wartością `owner_id` jest identyfikator konta, do którego należy wybrana grupa.\n\nJeśli zostanie podany atrybut `owner_id`, a nie `group_id`, domyślną wartością `group_id` jest identyfikator grupy domyślnej wybranego konta.\n\nJeśli nie zostanie podany atrybut `owner_id` ani `group_id`, domyślną wartością `owner_id` jest identyfikator konta wywołującego użytkownika, a `group_id` - identyfikator jego grupy domyślnej.\n\nGrupa o identyfikatorze określonym w `group_id` musi należeć do konta o identyfikatorze `owner_id`.", "operationId" : "periodic_report_addresses_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/periodic_report_address_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/periodic_report_address_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `group_not_found` (4046627): Nie znaleziono grupy." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_in_account` (4226950): Grupa nie należy do wybranego konta.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowy adres raportów okresowych.", "tags" : [ "periodic_report_addresses" ] } }, "/periodic_report_addresses/search" : { "post" : { "description" : "Zaawansowane pobieranie adresów raportów okresowych.", "operationId" : "periodic_report_addresses_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/periodic_report_address_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_periodic_report_addresses" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie adresów raportów okresowych.", "tags" : [ "periodic_report_addresses" ] } }, "/periodic_report_addresses/{_id}" : { "delete" : { "description" : "Usuwa adres raportów okresowych.", "operationId" : "periodic_report_addresses_delete", "parameters" : [ { "description" : "Identyfikator adresu raportów okresowych.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`periodic_report_address_not_found` (4045845): Nie znaleziono adresu raportów okresowych." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa adres raportów okresowych.", "tags" : [ "periodic_report_addresses" ] }, "get" : { "description" : "Zwraca pojedynczy adres raportów okresowych.", "operationId" : "periodic_report_addresses_read", "parameters" : [ { "description" : "Identyfikator adresu raportów okresowych.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "report_frequency" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/periodic_report_address" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`periodic_report_address_not_found` (4045845): Nie znaleziono adresu raportów okresowych." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy adres raportów okresowych.", "tags" : [ "periodic_report_addresses" ] }, "put" : { "description" : "Modyfikuje adres raportów okresowych.\n\nW przypadku zmiany grupy, nowa grupa musi należeć do tego samego konta, co poprzednia.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `owner_id`.", "operationId" : "periodic_report_addresses_update", "parameters" : [ { "description" : "Identyfikator adresu raportów okresowych.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/periodic_report_address" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `move_not_allowed` (4038858): Brak uprawnień do przeniesienia obiektu.\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `periodic_report_address_not_found` (4045845): Nie znaleziono adresu raportów okresowych." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `group_not_in_account` (4226950): Grupa nie należy do wybranego konta.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje adres raportów okresowych.", "tags" : [ "periodic_report_addresses" ] } }, "/periodic_report_addresses/{_id}/group" : { "get" : { "description" : "Zwraca grupę, do której jest przypisany adres raportów okresowych.", "operationId" : "periodic_report_addresses_read_group", "parameters" : [ { "description" : "Identyfikator adresu raportów okresowych.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "stats", "stats.id", "stats.sensors_count", "stats.services_count", "stats.services_count_archived", "stats.services_count_failure", "stats.services_count_ok", "stats.services_count_paused", "stats.services_count_suspended", "stats.services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "assigned_sensor_ids", "id", "is_default", "name", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "sensor_ids" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `periodic_report_address_not_found` (4045845): Nie znaleziono adresu raportów okresowych." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca grupę, do której jest przypisany adres raportów okresowych.", "tags" : [ "groups", "periodic_report_addresses" ] } }, "/periodic_report_addresses/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy adres raportów okresowych.", "operationId" : "periodic_report_addresses_read_owner", "parameters" : [ { "description" : "Identyfikator adresu raportów okresowych.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `periodic_report_address_not_found` (4045845): Nie znaleziono adresu raportów okresowych." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy adres raportów okresowych.", "tags" : [ "accounts", "periodic_report_addresses" ] } }, "/periodic_report_addresses/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do adresu raportów okresowych.", "operationId" : "periodic_report_addresses_read_permissions", "parameters" : [ { "description" : "Identyfikator adresu raportów okresowych.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `periodic_report_address_not_found` (4045845): Nie znaleziono adresu raportów okresowych." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do adresu raportów okresowych.", "tags" : [ "permissions", "periodic_report_addresses" ] } }, "/report_templates" : { "get" : { "description" : "Zwraca listę szablonów.", "operationId" : "report_templates_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_reports", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plans", "reporting_plans.description", "reporting_plans.id", "reporting_plans.name", "sections", "sections.description", "sections.id", "sections.name", "stats", "stats.created_at", "stats.id", "stats.last_report_generated_at", "stats.reports_count" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name_template", "generate_pdf", "group_info", "id", "owner_id", "reporting_plan_ids", "requested_scope", "section_ids", "service_level_events", "summary", "title", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "context_data", "delay", "description", "email_subject_template", "email_template", "file_name_template", "generate_pdf", "group_info", "id", "owner.name", "owner.username", "owner_id", "permissions.create_reports", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "stats.created_at", "stats.last_report_generated_at", "stats.reports_count", "summary", "title", "-account_info", "-archived_services", "-context_data", "-delay", "-description", "-email_subject_template", "-email_template", "-file_name_template", "-generate_pdf", "-group_info", "-id", "-owner.name", "-owner.username", "-owner_id", "-permissions.create_reports", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-stats.created_at", "-stats.last_report_generated_at", "-stats.reports_count", "-summary", "-title" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "account_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "account_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "archived_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "archived_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "context_data", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "context_data!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "delay", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "delay!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_subject_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_subject_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_subject_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generate_pdf", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generate_pdf!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "title", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "title!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "title~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.created_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.last_report_generated_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.reports_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_report_templates" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę szablonów.", "tags" : [ "report_templates" ] }, "post" : { "description" : "Dodaje nowy szablon.", "operationId" : "report_templates_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_template_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_template_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Dodaje nowy szablon.", "tags" : [ "report_templates" ] } }, "/report_templates/search" : { "post" : { "description" : "Zaawansowane pobieranie szablonów.", "operationId" : "report_templates_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_template_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_report_templates" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie szablonów.", "tags" : [ "report_templates" ] } }, "/report_templates/{_id}" : { "delete" : { "description" : "Usuwa szablon razem z jego raportami.", "operationId" : "report_templates_delete", "parameters" : [ { "description" : "Identyfikator szablonu raportów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa szablon razem z jego raportami.", "tags" : [ "report_templates" ] }, "get" : { "description" : "Zwraca pojedynczy szablon.", "operationId" : "report_templates_read", "parameters" : [ { "description" : "Identyfikator szablonu raportów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_reports", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plans", "reporting_plans.description", "reporting_plans.id", "reporting_plans.name", "sections", "sections.description", "sections.id", "sections.name", "stats", "stats.created_at", "stats.id", "stats.last_report_generated_at", "stats.reports_count" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name_template", "generate_pdf", "group_info", "id", "owner_id", "reporting_plan_ids", "requested_scope", "section_ids", "service_level_events", "summary", "title", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_template" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy szablon.", "tags" : [ "report_templates" ] }, "put" : { "description" : "Modyfikuje szablon.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `owner_id`.", "operationId" : "report_templates_update", "parameters" : [ { "description" : "Identyfikator szablonu raportów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_template" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje szablon.", "tags" : [ "report_templates" ] } }, "/report_templates/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy szablon.", "operationId" : "report_templates_read_owner", "parameters" : [ { "description" : "Identyfikator szablonu raportów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy szablon.", "tags" : [ "accounts", "report_templates" ] } }, "/report_templates/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do szablonu.", "operationId" : "report_templates_read_permissions", "parameters" : [ { "description" : "Identyfikator szablonu raportów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "create_reports", "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_template_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do szablonu.", "tags" : [ "permissions", "report_templates" ] } }, "/report_templates/{_id}/reporting_plans" : { "get" : { "description" : "Zwraca listę aktywnych planów generowania raportów według szablonu.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "report_templates_read_reporting_plans", "parameters" : [ { "description" : "Identyfikator szablonu raportów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_reporting_plans" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę aktywnych planów generowania raportów według szablonu.", "tags" : [ "report_templates" ] } }, "/report_templates/{_id}/reports" : { "get" : { "description" : "Zwraca listę raportów utworzonych według szablonu.\n\n\n\nPole `reporting_plan.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "report_templates_read_reports", "parameters" : [ { "description" : "Identyfikator szablonu raportów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "generated_attachments", "generated_attachments.content_type", "generated_attachments.file_name", "generated_attachments.report_id", "generated_attachments.type_id", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plan", "reporting_plan.description", "reporting_plan.id", "reporting_plan.name", "sections", "sections.description", "sections.id", "sections.name", "template", "template.account_info", "template.archived_services", "template.attachment_type_ids", "template.context_data", "template.delay", "template.description", "template.email_addresses", "template.email_subject_template", "template.email_template", "template.file_name_template", "template.generate_pdf", "template.group_info", "template.id", "template.owner_id", "template.reporting_plan_ids", "template.requested_scope", "template.section_ids", "template.service_level_events", "template.summary", "template.title", "template.weekly_suspensions", "token", "token.report_id", "token.session_id", "token.suggested_file_name", "token.token" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "created_at", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name", "file_name_template", "from", "generate_pdf", "generated_at", "generated_attachment_ids", "generating_progress", "generating_status", "group_info", "id", "owner_id", "progress", "rendering_progress", "rendering_status", "reporting_plan_id", "requested_scope", "section_ids", "service_level_events", "status", "summary", "template_id", "title", "to", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "context_data", "created_at", "delay", "description", "email_subject_template", "email_template", "file_name", "file_name_template", "from", "generate_pdf", "generated_at", "generating_progress", "generating_status", "group_info", "id", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "progress", "rendering_progress", "rendering_status", "reporting_plan.name", "reporting_plan_id", "status", "summary", "template.title", "template_id", "title", "to", "-account_info", "-archived_services", "-context_data", "-created_at", "-delay", "-description", "-email_subject_template", "-email_template", "-file_name", "-file_name_template", "-from", "-generate_pdf", "-generated_at", "-generating_progress", "-generating_status", "-group_info", "-id", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-progress", "-rendering_progress", "-rendering_status", "-reporting_plan.name", "-reporting_plan_id", "-status", "-summary", "-template.title", "-template_id", "-title", "-to" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "account_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "account_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "archived_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "archived_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "context_data", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "context_data!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "created_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "delay", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "delay!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_subject_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_subject_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_subject_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "from!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generate_pdf", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generate_pdf!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generated_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generating_progress", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generating_progress!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generating_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generating_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "generating_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "progress", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "progress!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "rendering_progress", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "rendering_progress!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "rendering_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "rendering_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "rendering_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "reporting_plan_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "reporting_plan_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "reporting_plan_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "template_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "template_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "title", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "title!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "title~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "to!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "reporting_plan.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "reporting_plan.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "reporting_plan.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "template.title", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "template.title!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "template.title~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_reports" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę raportów utworzonych według szablonu.", "tags" : [ "reports", "report_templates" ] } }, "/report_templates/{_id}/sections" : { "get" : { "description" : "Zwraca listę sekcji w raportach generowanych według szablonu.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "report_templates_read_sections", "parameters" : [ { "description" : "Identyfikator szablonu raportów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_report_sections" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę sekcji w raportach generowanych według szablonu.", "tags" : [ "report_templates" ] } }, "/report_templates/{_id}/stats" : { "get" : { "description" : "Zwraca statystyki wybranego szablonu.", "operationId" : "report_templates_read_stats", "parameters" : [ { "description" : "Identyfikator szablonu raportów.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "created_at", "id", "last_report_generated_at", "reports_count" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_template_stat" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca statystyki wybranego szablonu.", "tags" : [ "report_templates" ] } }, "/reports" : { "get" : { "description" : "Zwraca listę raportów.\n\n\n\nPole `reporting_plan.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "reports_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "generated_attachments", "generated_attachments.content_type", "generated_attachments.file_name", "generated_attachments.report_id", "generated_attachments.type_id", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plan", "reporting_plan.description", "reporting_plan.id", "reporting_plan.name", "sections", "sections.description", "sections.id", "sections.name", "template", "template.account_info", "template.archived_services", "template.attachment_type_ids", "template.context_data", "template.delay", "template.description", "template.email_addresses", "template.email_subject_template", "template.email_template", "template.file_name_template", "template.generate_pdf", "template.group_info", "template.id", "template.owner_id", "template.reporting_plan_ids", "template.requested_scope", "template.section_ids", "template.service_level_events", "template.summary", "template.title", "template.weekly_suspensions", "token", "token.report_id", "token.session_id", "token.suggested_file_name", "token.token" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "created_at", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name", "file_name_template", "from", "generate_pdf", "generated_at", "generated_attachment_ids", "generating_progress", "generating_status", "group_info", "id", "owner_id", "progress", "rendering_progress", "rendering_status", "reporting_plan_id", "requested_scope", "section_ids", "service_level_events", "status", "summary", "template_id", "title", "to", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "context_data", "created_at", "delay", "description", "email_subject_template", "email_template", "file_name", "file_name_template", "from", "generate_pdf", "generated_at", "generating_progress", "generating_status", "group_info", "id", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "progress", "rendering_progress", "rendering_status", "reporting_plan.name", "reporting_plan_id", "status", "summary", "template.title", "template_id", "title", "to", "-account_info", "-archived_services", "-context_data", "-created_at", "-delay", "-description", "-email_subject_template", "-email_template", "-file_name", "-file_name_template", "-from", "-generate_pdf", "-generated_at", "-generating_progress", "-generating_status", "-group_info", "-id", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-progress", "-rendering_progress", "-rendering_status", "-reporting_plan.name", "-reporting_plan_id", "-status", "-summary", "-template.title", "-template_id", "-title", "-to" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "account_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "account_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "archived_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "archived_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "context_data", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "context_data!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "created_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "delay", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "delay!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_subject_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_subject_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_subject_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "email_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "email_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "email_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "from!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generate_pdf", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generate_pdf!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generated_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generating_progress", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generating_progress!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "generating_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "generating_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "generating_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "progress", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "progress!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "rendering_progress", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "rendering_progress!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "rendering_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "rendering_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "rendering_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "reporting_plan_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "reporting_plan_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "reporting_plan_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "template_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "template_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "title", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "title!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "title~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "to!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "reporting_plan.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "reporting_plan.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "reporting_plan.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "template.title", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "template.title!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "template.title~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_reports" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę raportów.", "tags" : [ "reports" ] }, "post" : { "description" : "Zleca wygenerowanie nowego raportu na podstawie szablonu.\n\nRaport zostanie wygenerowany dla wszystkich usług z wybranych kont, grup lub podanych jawnie, do których konto ma dostęp.\n\nPrzedział czasowy nie może być dłuższy niż 400 dni.\n\nPostęp generowania raportu można śledzić za pomocą atrybutu `status` utworzonego obiektu.", "operationId" : "reports_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `reports_limit_reached` (4035677): Osiągnięty limit liczby raportów określony w pakiecie.\n* `time_range_too_long` (4031991): Podano zbyt długi przedział czasowy." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zleca wygenerowanie nowego raportu na podstawie szablonu.", "tags" : [ "reports" ] } }, "/reports/search" : { "post" : { "description" : "Zaawansowane pobieranie raportów.\n\n\n\nPole `reporting_plan.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "reports_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_reports" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie raportów.", "tags" : [ "reports" ] } }, "/reports/{_id}" : { "delete" : { "description" : "Usuwa raport.", "operationId" : "reports_delete", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_not_found` (4049931): Nie znaleziono raportu." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa raport.", "tags" : [ "reports" ] }, "get" : { "description" : "Zwraca pojedynczy raport.\n\n\n\nPole `reporting_plan.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "reports_read", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "generated_attachments", "generated_attachments.content_type", "generated_attachments.file_name", "generated_attachments.report_id", "generated_attachments.type_id", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plan", "reporting_plan.description", "reporting_plan.id", "reporting_plan.name", "sections", "sections.description", "sections.id", "sections.name", "template", "template.account_info", "template.archived_services", "template.attachment_type_ids", "template.context_data", "template.delay", "template.description", "template.email_addresses", "template.email_subject_template", "template.email_template", "template.file_name_template", "template.generate_pdf", "template.group_info", "template.id", "template.owner_id", "template.reporting_plan_ids", "template.requested_scope", "template.section_ids", "template.service_level_events", "template.summary", "template.title", "template.weekly_suspensions", "token", "token.report_id", "token.session_id", "token.suggested_file_name", "token.token" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "created_at", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name", "file_name_template", "from", "generate_pdf", "generated_at", "generated_attachment_ids", "generating_progress", "generating_status", "group_info", "id", "owner_id", "progress", "rendering_progress", "rendering_status", "reporting_plan_id", "requested_scope", "section_ids", "service_level_events", "status", "summary", "template_id", "title", "to", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_not_found` (4049931): Nie znaleziono raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy raport.", "tags" : [ "reports" ] } }, "/reports/{_id}/generated_attachments" : { "get" : { "description" : "Zwraca listę załączników do raportu.", "operationId" : "reports_read_report_attachments", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "type", "type.description", "type.id", "type.name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "content_type", "file_name", "report_id", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "content_type", "file_name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "report_id", "type_id", "-content_type", "-file_name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-report_id", "-type_id" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "content_type", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "content_type!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "content_type~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "report_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "report_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_report_attachments" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_not_found` (4049931): Nie znaleziono raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę załączników do raportu.", "tags" : [ "reports" ] } }, "/reports/{_id}/generated_attachments/{_type_id}/by_token/{file_name}" : { "get" : { "description" : "Zwraca wybrany załącznik do raportu za pomocą tokena.", "operationId" : "reports_read_attachment_by_token", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator typu załącznika.", "in" : "path", "name" : "_type_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Nazwa pobieranego pliku.", "in" : "path", "name" : "file_name", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator sesji.", "in" : "query", "name" : "session_id", "required" : false, "schema" : { "maxLength" : 40, "minLength" : 40, "pattern" : "^[0-9a-f]*$", "type" : "string" } }, { "description" : "Token dostępowy do pliku z załącznikiem dla sesji.", "in" : "query", "name" : "token", "required" : false, "schema" : { "maxLength" : 64, "minLength" : 64, "pattern" : "^[0-9a-f]*$", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "Content-Disposition" : { "description" : "Określa sposób pobrania pliku przez klienta API.", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`invalid_token` (4034645): Niepoprawny token dostępowy do pliku." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca wybrany załącznik do raportu za pomocą tokena.", "tags" : [ "reports" ] } }, "/reports/{_id}/generated_attachments/{_type_id}/plain" : { "get" : { "description" : "Zwraca zawartość wybranego załącznika do raportu.", "operationId" : "reports_read_attachment_content", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator typu załącznika.", "in" : "path", "name" : "_type_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `report_attachment_not_found` (4044418): Nie znaleziono załącznika do raportu.\n* `report_not_found` (4049931): Nie znaleziono raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca zawartość wybranego załącznika do raportu.", "tags" : [ "reports" ] } }, "/reports/{_id}/json" : { "get" : { "description" : "Zwraca plik z raportem w formacie JSON.\n\n\n\nPole `reporting_plan.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "reports_read_json_file", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_data" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `report_file_unavailable` (4042563): Nie znaleziono pliku raportu.\n* `report_not_found` (4049931): Nie znaleziono raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca plik z raportem w formacie JSON.", "tags" : [ "reports" ] } }, "/reports/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy raport.", "operationId" : "reports_read_owner", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `report_not_found` (4049931): Nie znaleziono raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy raport.", "tags" : [ "accounts", "reports" ] } }, "/reports/{_id}/pdf" : { "get" : { "description" : "Zwraca plik z raportem w formacie PDF.\n\n\n\nPole `reporting_plan.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "reports_read_pdf_file", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/pdf" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `report_file_unavailable` (4042563): Nie znaleziono pliku raportu.\n* `report_not_found` (4049931): Nie znaleziono raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca plik z raportem w formacie PDF.", "tags" : [ "reports" ] } }, "/reports/{_id}/pdf/by_token/{file_name}" : { "get" : { "description" : "Zwraca plik z raportem w formacie PDF za pomocą tokena.\n\n\n\nPole `reporting_plan.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "reports_read_pdf_file_by_token", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Nazwa pobieranego pliku.", "in" : "path", "name" : "file_name", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator sesji.", "in" : "query", "name" : "session_id", "required" : false, "schema" : { "maxLength" : 40, "minLength" : 40, "pattern" : "^[0-9a-f]*$", "type" : "string" } }, { "description" : "Token dostępowy do pliku z raportem dla sesji.", "in" : "query", "name" : "token", "required" : false, "schema" : { "maxLength" : 64, "minLength" : 64, "pattern" : "^[0-9a-f]*$", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/pdf" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "Content-Disposition" : { "description" : "Określa sposób pobrania pliku przez klienta API.", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`invalid_token` (4034645): Niepoprawny token dostępowy do pliku." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_not_found` (4049931): Nie znaleziono raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca plik z raportem w formacie PDF za pomocą tokena.", "tags" : [ "reports" ] } }, "/reports/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do raportu.", "operationId" : "reports_read_permissions", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `report_not_found` (4049931): Nie znaleziono raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do raportu.", "tags" : [ "permissions", "reports" ] } }, "/reports/{_id}/sections" : { "get" : { "description" : "Zwraca listę sekcji w raporcie.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "reports_read_sections", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_report_sections" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_not_found` (4049931): Nie znaleziono raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę sekcji w raporcie.", "tags" : [ "reports" ] } }, "/reports/{_id}/template" : { "get" : { "description" : "Zwraca szablon, według którego raport został utworzony.", "operationId" : "reports_read_template", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_reports", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "reporting_plans", "reporting_plans.description", "reporting_plans.id", "reporting_plans.name", "sections", "sections.description", "sections.id", "sections.name", "stats", "stats.created_at", "stats.id", "stats.last_report_generated_at", "stats.reports_count" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "account_info", "archived_services", "attachment_type_ids", "context_data", "delay", "description", "email_addresses", "email_subject_template", "email_template", "file_name_template", "generate_pdf", "group_info", "id", "owner_id", "reporting_plan_ids", "requested_scope", "section_ids", "service_level_events", "summary", "title", "weekly_suspensions" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_template" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `report_not_found` (4049931): Nie znaleziono raportu.\n* `report_template_not_found` (4045408): Nie znaleziono szablonu raportów." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca szablon, według którego raport został utworzony.", "tags" : [ "report_templates", "reports" ] } }, "/reports/{_report_id}/generated_attachments/{_type_id}" : { "get" : { "description" : "Zwraca dane pojedynczego załącznika do raportu.", "operationId" : "reports_read_attachment", "parameters" : [ { "description" : "Identyfikator raportu.", "in" : "path", "name" : "_report_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator typu załącznika.", "in" : "path", "name" : "_type_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "type", "type.description", "type.id", "type.name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "content_type", "file_name", "report_id", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/report_attachment" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`report_attachment_not_found` (4044418): Nie znaleziono załącznika do raportu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca dane pojedynczego załącznika do raportu.", "tags" : [ "reports" ] } }, "/scheduled_suspensions" : { "get" : { "deprecated" : true, "description" : "Zwraca listę zaplanowanych zawieszeń.\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.", "operationId" : "scheduled_suspensions_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end", "id", "only_notifications", "service_id", "start" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end", "id", "only_notifications", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start", "-description", "-end", "-id", "-only_notifications", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service.id", "-service.interval", "-service.is_active", "-service.is_archived", "-service.name", "-service.owner_id", "-service_id", "-start" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "end_from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Data i czas.", "in" : "query", "name" : "end_to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "only_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "only_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "start_from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Data i czas.", "in" : "query", "name" : "start_to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_scheduled_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zaplanowanych zawieszeń.", "tags" : [ "service_suspensions", "deprecated" ] }, "post" : { "deprecated" : true, "description" : "Tworzy nowe zawieszenie.\n\nJeśli nie zostanie określony atrybut `start`, zawieszenie rozpocznie się w momencie jego utworzenia (zostanie użyty aktualny czas).\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.", "operationId" : "scheduled_suspensions_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/scheduled_suspension_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/scheduled_suspension_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe zawieszenie.", "tags" : [ "service_suspensions", "deprecated" ] } }, "/scheduled_suspensions/bulk_create" : { "post" : { "deprecated" : true, "description" : "Dodaje zaplanowane zawieszenie do wielu usług jednocześnie.\n\nZamiast pola `service_id` należy podać pole `service_ids` - tablicę identyfikatorów usług, do których posiadamy uprawnienie `create_scheduled_suspensions`.\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.", "operationId" : "scheduled_suspensions_bulk_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/scheduled_suspension_bulk_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Dodaje zaplanowane zawieszenie do wielu usług jednocześnie.", "tags" : [ "service_suspensions", "deprecated" ] } }, "/scheduled_suspensions/bulk_delete" : { "post" : { "deprecated" : true, "description" : "Usuwa wiele zawieszeń jednocześnie.\n\nW treści zapytania należy podać tablicę identyfikatorów zawieszeń, do których posiadamy uprawnienie `delete`.\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.", "operationId" : "scheduled_suspensions_bulk_delete", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`scheduled_suspension_not_found` (4041456): Nie znaleziono zaplanowanego zawieszenia monitoringu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa wiele zawieszeń jednocześnie.", "tags" : [ "service_suspensions", "deprecated" ] } }, "/scheduled_suspensions/search" : { "post" : { "deprecated" : true, "description" : "Zaawansowane pobieranie zaplanowanych zawieszeń.\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.", "operationId" : "scheduled_suspensions_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/scheduled_suspension_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_scheduled_suspensions" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie zaplanowanych zawieszeń.", "tags" : [ "service_suspensions", "deprecated" ] } }, "/scheduled_suspensions/{_id}" : { "delete" : { "deprecated" : true, "description" : "Usuwa zaplanowane zawieszenie.\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.", "operationId" : "scheduled_suspensions_delete", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`scheduled_suspension_not_found` (4041456): Nie znaleziono zaplanowanego zawieszenia monitoringu." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa zaplanowane zawieszenie.", "tags" : [ "service_suspensions", "deprecated" ] }, "get" : { "deprecated" : true, "description" : "Zwraca pojedyncze zaplanowane zawieszenie.\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.", "operationId" : "scheduled_suspensions_read", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end", "id", "only_notifications", "service_id", "start" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/scheduled_suspension" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`scheduled_suspension_not_found` (4041456): Nie znaleziono zaplanowanego zawieszenia monitoringu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze zaplanowane zawieszenie.", "tags" : [ "service_suspensions", "deprecated" ] }, "put" : { "deprecated" : true, "description" : "Modyfikuje zaplanowane zawieszenie.\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `service_id`.", "operationId" : "scheduled_suspensions_update", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/scheduled_suspension" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`scheduled_suspension_not_found` (4041456): Nie znaleziono zaplanowanego zawieszenia monitoringu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje zaplanowane zawieszenie.", "tags" : [ "service_suspensions", "deprecated" ] } }, "/scheduled_suspensions/{_id}/permissions" : { "get" : { "deprecated" : true, "description" : "Zwraca uprawnienia do wybranego zawieszenia.\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.", "operationId" : "scheduled_suspensions_read_permissions", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `scheduled_suspension_not_found` (4041456): Nie znaleziono zaplanowanego zawieszenia monitoringu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego zawieszenia.", "tags" : [ "service_suspensions", "deprecated" ] } }, "/scheduled_suspensions/{_id}/service" : { "get" : { "deprecated" : true, "description" : "Zwraca usługę, której dotyczy wybrane zawieszenie.", "operationId" : "scheduled_suspensions_read_service", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "monitoring_sensors", "monitoring_sensors.city", "monitoring_sensors.continent", "monitoring_sensors.country", "monitoring_sensors.dns_diagnostics_available", "monitoring_sensors.id", "monitoring_sensors.ip_address", "monitoring_sensors.ipv6_address", "monitoring_sensors.is_available", "monitoring_sensors.is_enabled", "monitoring_sensors.links", "monitoring_sensors.name", "monitoring_sensors.service_type_category_ids", "monitoring_sensors.traceroute_diagnostics_available", "notification_channels", "notification_channels.description", "notification_channels.id", "notification_channels.name", "notification_conditions", "notification_conditions.description", "notification_conditions.id", "notification_conditions.name", "notification_mode", "notification_mode.description", "notification_mode.id", "notification_mode.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "recovery_notification_mode", "recovery_notification_mode.description", "recovery_notification_mode.id", "recovery_notification_mode.name", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "status", "status.average_response_time", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.id", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.last_failure_analysis_id", "status.last_failure_analysis_time", "status.last_ok_analysis_id", "status.last_ok_analysis_time", "status.monitoring_status", "status.notifications_status", "status.summary", "type", "type.address_prefix", "type.category_id", "type.customizable_step_names", "type.description", "type.id", "type.manual_schedule", "type.name", "type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "extended_settings", "group_id", "id", "interval", "is_active", "is_archived", "name", "notification_channel_ids", "notification_condition_ids", "notification_mode_id", "owner_id", "recovery_notification_mode_id", "sensor_ids", "silent_hours", "step_names", "suspension_hours", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `scheduled_suspension_not_found` (4041456): Nie znaleziono zaplanowanego zawieszenia monitoringu.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca usługę, której dotyczy wybrane zawieszenie.", "tags" : [ "services", "service_suspensions", "deprecated" ] } }, "/sensors" : { "get" : { "description" : "Zwraca listę stacji monitorujących.\n\n\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "sensors_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca listę stacji monitorujących.", "tags" : [ "sensors" ] } }, "/sensors/search" : { "post" : { "description" : "Zaawansowane pobieranie stacji monitorujących.\n\n\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "sensors_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/sensor_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zaawansowane pobieranie stacji monitorujących.", "tags" : [ "sensors" ] } }, "/sensors/{_id}" : { "get" : { "description" : "Zwraca pojedynczą stację monitorującą.\n\n\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "sensors_read", "parameters" : [ { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/sensor" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`sensor_not_found` (4049807): Nie znaleziono stacji monitorującej." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca pojedynczą stację monitorującą.", "tags" : [ "sensors" ] } }, "/sensors/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranej stacji monitorującej.", "operationId" : "sensors_read_permissions", "parameters" : [ { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `sensor_not_found` (4049807): Nie znaleziono stacji monitorującej." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca uprawnienia do wybranej stacji monitorującej.", "tags" : [ "permissions", "sensors" ] } }, "/sensors/{_id}/status" : { "get" : { "description" : "Zwraca aktualny status działania wybranej stacji monitorującej.", "operationId" : "sensors_read_status", "parameters" : [ { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "id", "is_connected", "is_suspended", "summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/sensor_status" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`sensor_not_found` (4049807): Nie znaleziono stacji monitorującej." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca aktualny status działania wybranej stacji monitorującej.", "tags" : [ "sensors" ] } }, "/service_statuses" : { "get" : { "description" : "Zwraca listę aktualnych statusów usług.", "operationId" : "service_statuses_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "average_response_time", "check_status", "check_status_is_up_to_date", "highest_active_event_priority", "id", "last_analysis_id", "last_analysis_time", "last_check_status_change_time", "last_failure_analysis_id", "last_failure_analysis_time", "last_ok_analysis_id", "last_ok_analysis_time", "monitoring_status", "notifications_status", "summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "average_response_time", "check_status", "check_status_is_up_to_date", "highest_active_event_priority", "id", "last_check_status_change_time", "monitoring_status", "notifications_status", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.name", "service.owner_id", "summary", "-average_response_time", "-check_status", "-check_status_is_up_to_date", "-highest_active_event_priority", "-id", "-last_check_status_change_time", "-monitoring_status", "-notifications_status", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service.id", "-service.interval", "-service.is_active", "-service.name", "-service.owner_id", "-summary" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "average_response_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "average_response_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "check_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "check_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "check_status_is_up_to_date", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "check_status_is_up_to_date!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "check_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "highest_active_event_priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "last_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "last_analysis_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "last_check_status_change_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "last_failure_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "last_failure_analysis_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "last_ok_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "last_ok_analysis_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "monitoring_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "monitoring_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "monitoring_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "notifications_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "notifications_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "notifications_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_service_statuses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę aktualnych statusów usług.", "tags" : [ "service_statuses" ] } }, "/service_statuses/search" : { "post" : { "description" : "Zaawansowane pobieranie aktualnych statusów usług.", "operationId" : "service_statuses_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_status_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_service_statuses" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie aktualnych statusów usług.", "tags" : [ "service_statuses" ] } }, "/service_statuses/{_id}" : { "get" : { "description" : "Zwraca aktualny status pojedynczej usługi.", "operationId" : "service_statuses_read", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "average_response_time", "check_status", "check_status_is_up_to_date", "highest_active_event_priority", "id", "last_analysis_id", "last_analysis_time", "last_check_status_change_time", "last_failure_analysis_id", "last_failure_analysis_time", "last_ok_analysis_id", "last_ok_analysis_time", "monitoring_status", "notifications_status", "summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_status" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_status_not_found` (4043638): Nie znaleziono statusu usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca aktualny status pojedynczej usługi.", "tags" : [ "service_statuses" ] } }, "/service_statuses/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do aktualnego statusu wybranej usługi.", "operationId" : "service_statuses_read_permissions", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `service_status_not_found` (4043638): Nie znaleziono statusu usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do aktualnego statusu wybranej usługi.", "tags" : [ "permissions", "service_statuses" ] } }, "/service_types" : { "get" : { "description" : "Zwraca listę dostępnych typów usług.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPole `description` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "service_types_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "category", "category.description", "category.id", "category.name", "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address_prefix", "category_id", "customizable_step_names", "description", "id", "manual_schedule", "name", "step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address_prefix", "category_id", "customizable_step_names", "id", "manual_schedule", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-address_prefix", "-category_id", "-customizable_step_names", "-id", "-manual_schedule", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address_prefix", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address_prefix!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address_prefix~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "category_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "category_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "category_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "customizable_step_names", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "customizable_step_names!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "manual_schedule", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "manual_schedule!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_service_types" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę dostępnych typów usług.", "tags" : [ "service_types" ] } }, "/service_types/search" : { "post" : { "description" : "Zaawansowane pobieranie dostępnych typów usług.\n\nUwaga: Ta operacja domyślnie nie zwraca wyników posortowanych rosnąco po `id`.\n\nPole `description` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "service_types_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_type_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_service_types" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie dostępnych typów usług.", "tags" : [ "service_types" ] } }, "/service_types/{_id}" : { "get" : { "description" : "Zwraca pojedynczy typ usługi.\n\n\n\nPole `description` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "service_types_read", "parameters" : [ { "description" : "Identyfikator typu usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "category", "category.description", "category.id", "category.name", "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address_prefix", "category_id", "customizable_step_names", "description", "id", "manual_schedule", "name", "step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_type" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_type_not_found` (4048434): Nie znaleziono typu usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy typ usługi.", "tags" : [ "service_types" ] } }, "/service_types/{_id}/extended_setting_formats" : { "get" : { "description" : "Zwraca listę specyfikacji formatów zaawansowanych ustawień usług wybranego typu.\n\n\n\nPola wyniku `description` oraz `pattern_error_message` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "service_types_read_extended_setting_formats", "parameters" : [ { "description" : "Identyfikator typu usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "default", "description", "enum", "is_hidden", "is_nullable", "json_schema", "maximum", "maximum_length", "minimum", "minimum_length", "pattern", "pattern_error_message", "service_type_id", "setting_id", "suggested_form_element", "type" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "is_hidden", "is_nullable", "maximum", "maximum_length", "minimum", "minimum_length", "pattern", "pattern_error_message", "service_type_id", "setting_id", "suggested_form_element", "type", "-description", "-is_hidden", "-is_nullable", "-maximum", "-maximum_length", "-minimum", "-minimum_length", "-pattern", "-pattern_error_message", "-service_type_id", "-setting_id", "-suggested_form_element", "-type" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_hidden", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_hidden!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_nullable", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_nullable!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "maximum_length", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "maximum_length!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "minimum_length", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "minimum_length!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "pattern", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "pattern!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "pattern_error_message", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "pattern_error_message!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "pattern_error_message~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "pattern~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_type_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_type_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service_type_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "setting_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "setting_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "setting_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "suggested_form_element", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "suggested_form_element!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "suggested_form_element~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_extended_setting_formats" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_type_not_found` (4048434): Nie znaleziono typu usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę specyfikacji formatów zaawansowanych ustawień usług wybranego typu.", "tags" : [ "service_types" ] } }, "/service_types/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego typu usługi.", "operationId" : "service_types_read_permissions", "parameters" : [ { "description" : "Identyfikator typu usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `service_type_not_found` (4048434): Nie znaleziono typu usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego typu usługi.", "tags" : [ "permissions", "service_types" ] } }, "/services" : { "get" : { "description" : "Zwraca listę usług.", "operationId" : "services_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "monitoring_sensors", "monitoring_sensors.city", "monitoring_sensors.continent", "monitoring_sensors.country", "monitoring_sensors.dns_diagnostics_available", "monitoring_sensors.id", "monitoring_sensors.ip_address", "monitoring_sensors.ipv6_address", "monitoring_sensors.is_available", "monitoring_sensors.is_enabled", "monitoring_sensors.links", "monitoring_sensors.name", "monitoring_sensors.service_type_category_ids", "monitoring_sensors.traceroute_diagnostics_available", "notification_channels", "notification_channels.description", "notification_channels.id", "notification_channels.name", "notification_conditions", "notification_conditions.description", "notification_conditions.id", "notification_conditions.name", "notification_mode", "notification_mode.description", "notification_mode.id", "notification_mode.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "recovery_notification_mode", "recovery_notification_mode.description", "recovery_notification_mode.id", "recovery_notification_mode.name", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "status", "status.average_response_time", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.id", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.last_failure_analysis_id", "status.last_failure_analysis_time", "status.last_ok_analysis_id", "status.last_ok_analysis_time", "status.monitoring_status", "status.notifications_status", "status.summary", "type", "type.address_prefix", "type.category_id", "type.customizable_step_names", "type.description", "type.id", "type.manual_schedule", "type.name", "type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "extended_settings", "group_id", "id", "interval", "is_active", "is_archived", "name", "notification_channel_ids", "notification_condition_ids", "notification_mode_id", "owner_id", "recovery_notification_mode_id", "sensor_ids", "silent_hours", "step_names", "suspension_hours", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group.is_default", "group.name", "group_id", "id", "interval", "is_active", "is_archived", "name", "owner.name", "owner.username", "owner_id", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.monitoring_status", "status.summary", "type.category_id", "type.name", "type_id", "-address", "-description", "-group.is_default", "-group.name", "-group_id", "-id", "-interval", "-is_active", "-is_archived", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.archive", "-permissions.create_corrections", "-permissions.create_scheduled_suspensions", "-permissions.create_suspensions", "-permissions.create_weekly_suspensions", "-permissions.delete", "-permissions.force_analyses", "-permissions.force_custom_analyses", "-permissions.own", "-permissions.read", "-permissions.restore", "-permissions.send_test_sms_notifications", "-permissions.update", "-permissions.update_step_names", "-status.check_status", "-status.check_status_is_up_to_date", "-status.highest_active_event_priority", "-status.last_analysis_id", "-status.last_analysis_time", "-status.last_check_status_change_time", "-status.monitoring_status", "-status.summary", "-type.category_id", "-type.name", "-type_id" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "notification_mode_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "recovery_notification_mode_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "silent_hours!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "suspension_hours!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.is_default", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.is_default!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.archive", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.archive!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_corrections", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_corrections!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_scheduled_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_scheduled_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_weekly_suspensions", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_weekly_suspensions!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.force_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.force_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.force_custom_analyses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.force_custom_analyses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.restore", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.restore!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update_step_names", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update_step_names!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.check_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.check_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.check_status_is_up_to_date", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.check_status_is_up_to_date!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.check_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.highest_active_event_priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.last_analysis_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.last_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.last_analysis_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.last_analysis_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.last_check_status_change_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.last_check_status_change_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.monitoring_status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.monitoring_status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.monitoring_status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type.category_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type.category_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type.category_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "type.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "type.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "type.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_services" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę usług.", "tags" : [ "services" ] }, "post" : { "description" : "Tworzy nową usługę.\n\nJeśli nie zostanie podany atrybut `owner_id`, a zostanie podany `group_id`, domyślną wartością `owner_id` jest identyfikator konta, do którego należy wybrana grupa.\n\nJeśli zostanie podany atrybut `owner_id`, a nie `group_id`, domyślną wartością `group_id` jest identyfikator grupy domyślnej wybranego konta.\n\nJeśli nie zostanie podany atrybut `owner_id` ani `group_id`, domyślną wartością `owner_id` jest identyfikator konta wywołującego użytkownika, a `group_id` - identyfikator jego grupy domyślnej.\n\nGrupa o identyfikatorze określonym w `group_id` musi należeć do konta o identyfikatorze `owner_id`.\n\nNie można uruchomić monitoringu usług archiwalnych.", "operationId" : "services_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `interval_too_low` (4038653): Częstotliwość sprawdzeń zbyt wysoka (niedostępna w pakiecie).\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `sensor_not_available` (4037635): Wybrana stacja monitorująca nie jest dostępna.\n* `sensor_not_available_for_account` (4030863): Wybrana stacja monitorująca nie jest dostępna dla konta.\n* `services_limit_reached` (4037286): Osiągnięty limit liczby usług w pakiecie.\n* `services_type_limit_reached` (4037135): Osiągnięty limit liczby usług określonego typu w pakiecie.\n* `too_many_sensors` (4033810): Wybrano więcej stacji monitorujących niż dozwolone w pakiecie.\n* `type_interval_too_low` (4038095): Częstotliwość sprawdzeń zbyt wysoka dla wybranego typu usługi (niedostępna w pakiecie)." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `group_not_found` (4046627): Nie znaleziono grupy.\n* `notification_channel_not_found` (4041457): Nie znaleziono kanału powiadomień.\n* `notification_condition_not_found` (4046371): Nie znaleziono warunku powiadomień.\n* `notification_mode_not_found` (4046208): Nie znaleziono trybu powiadomień.\n* `recovery_notification_mode_not_found` (4045477): Nie znaleziono trybu powiadomień o końcu awarii.\n* `sensor_not_found` (4049807): Nie znaleziono stacji monitorującej.\n* `service_type_not_found` (4048434): Nie znaleziono typu usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_short` (4225465): Tablica jest zbyt krótka.\n* `extended_setting_required` (4227491): Ustawienie wymagane.\n* `group_not_in_account` (4226950): Grupa nie należy do wybranego konta.\n* `incorrect_extended_setting` (4224583): Niepoprawna wartość ustawienia usługi.\n* `incorrect_service_address` (4224144): Niepoprawny adres monitorowanej usługi.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut.\n* `unknown_extended_setting` (4227971): Niepoprawne ustawienie usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nową usługę.", "tags" : [ "services" ] } }, "/services/bulk_activate" : { "post" : { "description" : "Włącza monitoring wielu usług jednocześnie.\n\nW treści zapytania należy podać tablicę identyfikatorów usług, do których posiadamy uprawnienie `update`.", "operationId" : "services_bulk_activate", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Włącza monitoring wielu usług jednocześnie.", "tags" : [ "services" ] } }, "/services/bulk_change_group" : { "post" : { "description" : "Przenosi wiele usług do grupy jednocześnie.\n\nWszystkie przenoszone usługi muszą należeć do tego samego konta, co grupa. Aby zmienić grupę usługi, wymagane jest uprawnienie `update` do usługi oraz `create_services` do grupy.", "operationId" : "services_bulk_change_group", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/bulk_group_change_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `move_not_allowed` (4038858): Brak uprawnień do przeniesienia obiektu.\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Przenosi wiele usług do grupy jednocześnie.", "tags" : [ "services" ] } }, "/services/bulk_delete" : { "post" : { "description" : "Usuwa wiele usług jednocześnie.\n\nW treści zapytania należy podać tablicę identyfikatorów usług, do których posiadamy uprawnienie `delete`.", "operationId" : "services_bulk_delete", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa wiele usług jednocześnie.", "tags" : [ "services" ] } }, "/services/bulk_force_analysis" : { "post" : { "description" : "Wymusza wykonanie analizy działania wielu usług jednocześnie poza zaplanowanym harmonogramem.\n\nWymuszanie wykonywania dodatkowych analiz służy przede wszystkim do przetestowania działania usługi po zmianie jej ustawień. Limity wymuszonych analiz dla pojedynczej usługi są zależne od jej typu; dla większości typów wynoszą 1 na minutę, 10 na godzinę i 25 na dobę. Limity te są liczone dla okrągłych minut, godzin i dób w UTC.", "operationId" : "services_bulk_force_analysis", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `force_analysis_not_allowed` (4031261): Brak uprawnień do wymuszenia analizy działania usługi.\n* `forced_analyses_limit_reached` (4031997): Wyczerpany limit wymuszeń analizy działania usługi w przedziale czasowym.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wymusza wykonanie analizy działania wielu usług jednocześnie poza zaplanowanym harmonogramem.", "tags" : [ "services" ] } }, "/services/bulk_pause" : { "post" : { "description" : "Wyłącza monitoring wielu usług jednocześnie.\n\nW treści zapytania należy podać tablicę identyfikatorów usług, do których posiadamy uprawnienie `update`.", "operationId" : "services_bulk_pause", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wyłącza monitoring wielu usług jednocześnie.", "tags" : [ "services" ] } }, "/services/search" : { "post" : { "description" : "Zaawansowane pobieranie usług.", "operationId" : "services_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_services" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie usług.", "tags" : [ "services" ] } }, "/services/{_id}" : { "delete" : { "description" : "Usuwa usługę.", "operationId" : "services_delete", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa usługę.", "tags" : [ "services" ] }, "get" : { "description" : "Zwraca pojedynczą usługę.", "operationId" : "services_read", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "monitoring_sensors", "monitoring_sensors.city", "monitoring_sensors.continent", "monitoring_sensors.country", "monitoring_sensors.dns_diagnostics_available", "monitoring_sensors.id", "monitoring_sensors.ip_address", "monitoring_sensors.ipv6_address", "monitoring_sensors.is_available", "monitoring_sensors.is_enabled", "monitoring_sensors.links", "monitoring_sensors.name", "monitoring_sensors.service_type_category_ids", "monitoring_sensors.traceroute_diagnostics_available", "notification_channels", "notification_channels.description", "notification_channels.id", "notification_channels.name", "notification_conditions", "notification_conditions.description", "notification_conditions.id", "notification_conditions.name", "notification_mode", "notification_mode.description", "notification_mode.id", "notification_mode.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "recovery_notification_mode", "recovery_notification_mode.description", "recovery_notification_mode.id", "recovery_notification_mode.name", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "status", "status.average_response_time", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.id", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.last_failure_analysis_id", "status.last_failure_analysis_time", "status.last_ok_analysis_id", "status.last_ok_analysis_time", "status.monitoring_status", "status.notifications_status", "status.summary", "type", "type.address_prefix", "type.category_id", "type.customizable_step_names", "type.description", "type.id", "type.manual_schedule", "type.name", "type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "extended_settings", "group_id", "id", "interval", "is_active", "is_archived", "name", "notification_channel_ids", "notification_condition_ids", "notification_mode_id", "owner_id", "recovery_notification_mode_id", "sensor_ids", "silent_hours", "step_names", "suspension_hours", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczą usługę.", "tags" : [ "services" ] }, "put" : { "description" : "Modyfikuje ustawienia usługi.\n\nW przypadku zmiany grupy, nowa grupa musi należeć do tego samego konta, co poprzednia.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id`, `is_archived`, `owner_id` oraz `type_id`.", "operationId" : "services_update", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `interval_too_low` (4038653): Częstotliwość sprawdzeń zbyt wysoka (niedostępna w pakiecie).\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `move_not_allowed` (4038858): Brak uprawnień do przeniesienia obiektu.\n* `sensor_not_available` (4037635): Wybrana stacja monitorująca nie jest dostępna.\n* `sensor_not_available_for_account` (4030863): Wybrana stacja monitorująca nie jest dostępna dla konta.\n* `too_many_sensors` (4033810): Wybrano więcej stacji monitorujących niż dozwolone w pakiecie.\n* `type_interval_too_low` (4038095): Częstotliwość sprawdzeń zbyt wysoka dla wybranego typu usługi (niedostępna w pakiecie).\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `notification_channel_not_found` (4041457): Nie znaleziono kanału powiadomień.\n* `notification_condition_not_found` (4046371): Nie znaleziono warunku powiadomień.\n* `notification_mode_not_found` (4046208): Nie znaleziono trybu powiadomień.\n* `recovery_notification_mode_not_found` (4045477): Nie znaleziono trybu powiadomień o końcu awarii.\n* `sensor_not_found` (4049807): Nie znaleziono stacji monitorującej.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_archived` (4097737): Nie można uruchomić monitoringu usługi zarchiwizowanej." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_short` (4225465): Tablica jest zbyt krótka.\n* `extended_setting_required` (4227491): Ustawienie wymagane.\n* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `group_not_in_account` (4226950): Grupa nie należy do wybranego konta.\n* `incorrect_extended_setting` (4224583): Niepoprawna wartość ustawienia usługi.\n* `incorrect_service_address` (4224144): Niepoprawny adres monitorowanej usługi.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unknown_extended_setting` (4227971): Niepoprawne ustawienie usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje ustawienia usługi.", "tags" : [ "services" ] } }, "/services/{_id}/archive" : { "post" : { "description" : "Archiwizuje usługę.\n\nUsługi zarchiwizowane mają zatrzymany monitoring, nie można ich edytować oraz nie wliczają się do zużycia zasobów.", "operationId" : "services_archive", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "201" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `archive_not_allowed` (4032567): Nie można zarchiwizować usługi (jest już zarchiwizowana lub brak uprawnień).\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Archiwizuje usługę.", "tags" : [ "services" ] } }, "/services/{_id}/available_groups" : { "get" : { "description" : "Zwraca listę grup, do których można przenieść wybraną usługę.", "operationId" : "services_read_available_groups", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "stats", "stats.id", "stats.sensors_count", "stats.services_count", "stats.services_count_archived", "stats.services_count_failure", "stats.services_count_ok", "stats.services_count_paused", "stats.services_count_suspended", "stats.services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "assigned_sensor_ids", "id", "is_default", "name", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "sensor_ids" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "id", "is_default", "name", "owner.name", "owner.username", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "stats.sensors_count", "stats.services_count", "-archived_services_in_periodic_reports", "-id", "-is_default", "-name", "-owner.name", "-owner.username", "-owner_id", "-periodic_daily_reports", "-periodic_monthly_reports", "-periodic_weekly_reports", "-permissions.create_notification_addresses", "-permissions.create_periodic_report_addresses", "-permissions.create_services", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.send_test_sms_notifications", "-permissions.share", "-permissions.update", "-stats.sensors_count", "-stats.services_count" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "archived_services_in_periodic_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "archived_services_in_periodic_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_default", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_default!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "periodic_daily_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "periodic_daily_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "periodic_monthly_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "periodic_monthly_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "periodic_weekly_reports", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "periodic_weekly_reports!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_notification_addresses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_notification_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_periodic_report_addresses", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_periodic_report_addresses!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.create_services", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.create_services!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.share", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.share!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.sensors_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "stats.services_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_groups" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę grup, do których można przenieść wybraną usługę.", "tags" : [ "groups", "services" ] } }, "/services/{_id}/available_sensors" : { "get" : { "description" : "Zwraca listę stacji monitorujących dostępnych dla usługi.\n\n\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_available_sensors", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę stacji monitorujących dostępnych dla usługi.", "tags" : [ "sensors", "services" ] } }, "/services/{_id}/charts/availability" : { "get" : { "description" : "Zwraca dane do wykresu Service Level.\n\nZwraca tablicę danych o dostępności (Service Level) dla wybranej usługi w wybranym przedziale czasowym.\nPrzedział jest dzielony na `limit` podprzedziałów o możliwie równych długościach będących dodatnimi liczbami całkowitymi sekund.\nJeśli `limit` jest dzielnikiem liczby sekund w przedziale, będą one równej długości.", "operationId" : "services_availability_chart", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Maksymalna liczba podprzedziałów, jaka ma zostać zwrócona, domyślnie 24. Ta wartość nie może być większa niż długość wybranego przedziału w sekundach.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 24, "maximum" : 1000, "minimum" : 1, "type" : "integer" } }, { "description" : "Początek przedziału czasowego, domyślnie 24 godziny przed `to`.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Koniec przedziału czasowego, domyślnie aktualny czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_service_level_intervals" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca dane do wykresu Service Level.", "tags" : [ "charts" ] } }, "/services/{_id}/charts/availability/range" : { "get" : { "description" : "Zwraca przedział czasowy, z którego są dostępne dane o dostępności usługi.", "operationId" : "services_availability_chart_range", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/availability_time_range" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca przedział czasowy, z którego są dostępne dane o dostępności usługi.", "tags" : [ "charts" ] } }, "/services/{_id}/charts/performance" : { "get" : { "description" : "Zwraca dane do wykresu czasu odpowiedzi, z automatyczną agregacją.\n\nZwraca dane w formacie takim, jak operacje `GET /services/{_id}/charts/performance/river` lub `GET /services/{_id}/charts/performance/checks` (dla odpowiednio krótkich przedziałów czasowych).\nNagłówek `X-Aggregated-Data` wskazuje, czy zwrócone dane są zagregowane (\"rzeka\"), czy rozbite na pojedyncze sprawdzenia.", "operationId" : "services_performance_chart", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Początek przedziału czasowego, domyślnie 1 doba przed `to`.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Numer kroku w scenariuszu, zaczynając od 1. Jeśli nie zostanie podany, zostaną zwrócone dane dla wszystkich kroków.", "in" : "query", "name" : "path_step", "required" : false, "schema" : { "minimum" : 1, "type" : "integer" } }, { "description" : "Preferowana liczba punktów zwróconych w wyniku.", "in" : "query", "name" : "points", "required" : false, "schema" : { "default" : 150, "description" : "Preferowana liczba punktów zwróconych w wyniku.", "maximum" : 1000, "minimum" : 10, "type" : "integer" } }, { "description" : "Identyfikator stacji monitorującej. Jeśli nie zostanie podany, zostaną zwrócone dane dla wszystkich stacji.", "in" : "query", "name" : "sensor_id", "required" : false, "schema" : { "minimum" : 1, "type" : "integer" } }, { "description" : "Koniec przedziału czasowego, domyślnie aktualny czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_performance_chart_series" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Aggregated-Data" : { "description" : "Określa, czy zwrócone dane są zagregowane.", "schema" : { "type" : "boolean" } }, "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `sensor_not_found` (4049807): Nie znaleziono stacji monitorującej.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca dane do wykresu czasu odpowiedzi, z automatyczną agregacją.", "tags" : [ "charts" ] } }, "/services/{_id}/charts/performance/checks" : { "get" : { "description" : "Zwraca dane do wykresu czasu odpowiedzi pojedynczych sprawdzeń.\n\nZwraca po jednej serii danych dla każdej stacji monitorującej, z której usługa była monitorowana w wybranym przedziale czasowym.\nWartości oznaczają czasy pojedynczych sprawdzeń z danej stacji.\nJeśli w wybranym przedziale było zbyt dużo sprawdzeń, zostanie zwrócony błąd `too_many_points`.\n\nMożliwe jest zwrócenie jednego punktu na lewo od wybranego przedziału i jednego na prawo dla każdej z serii.", "operationId" : "services_performance_checks_chart", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Początek przedziału czasowego, domyślnie 1 doba przed `to`.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Numer kroku w scenariuszu, zaczynając od 1. Jeśli nie zostanie podany, zostaną zwrócone dane dla wszystkich kroków.", "in" : "query", "name" : "path_step", "required" : false, "schema" : { "minimum" : 1, "type" : "integer" } }, { "description" : "Identyfikator stacji monitorującej. Jeśli nie zostanie podany, zostaną zwrócone dane dla wszystkich stacji.", "in" : "query", "name" : "sensor_id", "required" : false, "schema" : { "minimum" : 1, "type" : "integer" } }, { "description" : "Koniec przedziału czasowego, domyślnie aktualny czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_performance_chart_series" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `too_many_points` (4036550): Zbyt dużo punktów na wykresie." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `sensor_not_found` (4049807): Nie znaleziono stacji monitorującej.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca dane do wykresu czasu odpowiedzi pojedynczych sprawdzeń.", "tags" : [ "charts" ] } }, "/services/{_id}/charts/performance/range" : { "get" : { "description" : "Zwraca przedział czasowy, z którego są dostępne dane do wykresu czasu odpowiedzi.", "operationId" : "services_performance_chart_range", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/performance_time_range" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca przedział czasowy, z którego są dostępne dane do wykresu czasu odpowiedzi.", "tags" : [ "charts" ] } }, "/services/{_id}/charts/performance/river" : { "get" : { "description" : "Zwraca zagregowane dane do wykresu czasu odpowiedzi.\n\nZwraca 3 serie zagregowanych danych opisujących szybkość działania usługi w czasie:\n\n* `min` - minimalny czas odpowiedzi,\n* `avg` - średni czas odpowiedzi,\n* `max` - maksymalny czas odpowiedzi.\n\nWszystkie serie będą zawierały dokładnie te same kolejne wartości na osi odciętych, posortowane rosnąco.\n\nMożliwe jest zwrócenie jednego punktu na lewo od wybranego przedziału i jednego na prawo.", "operationId" : "services_performance_river_chart", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Początek przedziału czasowego, domyślnie 1 doba przed `to`.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Numer kroku w scenariuszu, zaczynając od 1. Jeśli nie zostanie podany, zostaną zwrócone dane dla wszystkich kroków.", "in" : "query", "name" : "path_step", "required" : false, "schema" : { "minimum" : 1, "type" : "integer" } }, { "description" : "Preferowana liczba punktów zwróconych w wyniku.", "in" : "query", "name" : "points", "required" : false, "schema" : { "default" : 150, "description" : "Preferowana liczba punktów zwróconych w wyniku.", "maximum" : 1000, "minimum" : 10, "type" : "integer" } }, { "description" : "Identyfikator stacji monitorującej. Jeśli nie zostanie podany, zostaną zwrócone dane dla wszystkich stacji.", "in" : "query", "name" : "sensor_id", "required" : false, "schema" : { "minimum" : 1, "type" : "integer" } }, { "description" : "Koniec przedziału czasowego, domyślnie aktualny czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_performance_chart_series" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `sensor_not_found` (4049807): Nie znaleziono stacji monitorującej.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca zagregowane dane do wykresu czasu odpowiedzi.", "tags" : [ "charts" ] } }, "/services/{_id}/charts/performance/steps" : { "get" : { "description" : "Zwraca dane do wykresu czasu odpowiedzi, z podziałem na kroki.\n\nZwraca po jednej serii danych dla każdego kroku w scenariuszu w wybranym przedziale czasowym.\nWartości oznaczają czasy przejścia danego kroku.\n\nMożliwe jest zwrócenie jednego punktu na lewo od wybranego przedziału i jednego na prawo dla każdej z serii.", "operationId" : "services_performance_steps_chart", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Początek przedziału czasowego, domyślnie 1 doba przed `to`.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Lista numerów kroków, dla których należy zwrócić wyniki. Jeśli nie zostanie podana, zostaną zwrócone dane dla wszystkich kroków.", "explode" : false, "in" : "query", "name" : "path_steps", "required" : false, "schema" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Preferowana liczba punktów zwróconych w wyniku.", "in" : "query", "name" : "points", "required" : false, "schema" : { "default" : 150, "description" : "Preferowana liczba punktów zwróconych w wyniku.", "maximum" : 1000, "minimum" : 10, "type" : "integer" } }, { "description" : "Identyfikator stacji monitorującej. Jeśli nie zostanie podany, zostaną zwrócone dane dla wszystkich stacji.", "in" : "query", "name" : "sensor_id", "required" : false, "schema" : { "minimum" : 1, "type" : "integer" } }, { "description" : "Koniec przedziału czasowego, domyślnie aktualny czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_performance_chart_series" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `sensor_not_found` (4049807): Nie znaleziono stacji monitorującej.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca dane do wykresu czasu odpowiedzi, z podziałem na kroki.", "tags" : [ "charts" ] } }, "/services/{_id}/charts/performance/used_sensors" : { "get" : { "description" : "Zwraca stacje monitorujące, z których usługa była monitorowana.\n\nTa operacja zwraca listę stacji monitorujących do wyświetlenia w polu wyboru stacji przy wykresie szybkości działania.\n\nWynik jest jedynie przybliżony ze względu na agregacje danych: możliwe jest zwrócenie stacji, z których usługa nie była monitorowana w wybranym przedziale.\n\nDomyślny przedział czasowy: ostatnia doba.\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_performance_chart_sensors", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca stacje monitorujące, z których usługa była monitorowana.", "tags" : [ "charts" ] } }, "/services/{_id}/corrections" : { "get" : { "description" : "Zwraca listę korekt Service Level usługi.", "operationId" : "services_read_corrections", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "created_at", "description", "end_time", "id", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "created_at", "description", "end_time", "id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start_time", "status", "-created_at", "-description", "-end_time", "-id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service.id", "-service.interval", "-service.is_active", "-service.is_archived", "-service.name", "-service.owner_id", "-service_id", "-start_time", "-status" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "created_at", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "created_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "created_at~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "end_time_from", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "end_time_to", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "from", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Sposób wyszukiwania korekt w wybranym przedziale (okreśonym za pomocą parametrów `from` i `to`): rozpoczynające się w nim (`starting`) lub mające z nim niepuste przecięcie (`overlapping`).", "in" : "query", "name" : "intervals", "required" : false, "schema" : { "default" : "starting", "description" : "Sposób wyszukiwania korekt w wybranym przedziale (okreśonym za pomocą parametrów `from` i `to`): rozpoczynające się w nim (`starting`) lub mające z nim niepuste przecięcie (`overlapping`).", "enum" : [ "overlapping", "starting" ], "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "start_time_from", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "start_time_to", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "to", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_corrections" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę korekt Service Level usługi.", "tags" : [ "corrections" ] } }, "/services/{_id}/corrections/bulk_create" : { "post" : { "description" : "Tworzy wiele korekt SL usługi jednocześnie.", "operationId" : "services_bulk_create_intervals", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/correction_intervals_create_type" }, "maxItems" : 1000, "type" : "array" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy wiele korekt SL usługi jednocześnie.", "tags" : [ "corrections", "services" ] } }, "/services/{_id}/escalation_statuses" : { "get" : { "description" : "Zwraca listę aktualnych statusów eskalacji dla usługi.", "operationId" : "services_read_escalation_statuses", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "escalation_id", "event_id", "sent_notifications", "service_id", "summary", "times_notified" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "escalation.name", "escalation_id", "event_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "sent_notifications", "service.name", "service_id", "summary", "times_notified", "-escalation.name", "-escalation_id", "-event_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-sent_notifications", "-service.name", "-service_id", "-summary", "-times_notified" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "escalation_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sent_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sent_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "times_notified", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "times_notified!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "escalation.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "escalation.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "escalation.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_escalation_statuses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę aktualnych statusów eskalacji dla usługi.", "tags" : [ "services" ] } }, "/services/{_id}/escalation_statuses/{_escalation_id}" : { "get" : { "description" : "Zwraca aktualny status pojedynczej eskalacji dla usługi.", "operationId" : "services_read_escalation_status", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator eskalacji", "in" : "path", "name" : "_escalation_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "escalation", "escalation.contact_groups", "escalation.contacts", "escalation.description", "escalation.end_notifications_delay", "escalation.event_id", "escalation.id", "escalation.is_enabled", "escalation.name", "escalation.repeated_notifications_interval", "escalation.repeated_notifications_limit", "escalation.start_notifications_delay", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "escalation_id", "event_id", "sent_notifications", "service_id", "summary", "times_notified" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/escalation_status" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`escalation_status_not_found` (4047797): Nie znaleziono statusu eskalacji." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca aktualny status pojedynczej eskalacji dla usługi.", "tags" : [ "escalations", "services" ] } }, "/services/{_id}/event_charts/{_event_id}/availability" : { "get" : { "description" : "Zwraca dane do wykresu Service Level dla wybranego zdarzenia.\n\nZwraca tablicę danych o dostępności (Service Level) dla wybranej pary usługa-zdarzenie w wybranym przedziale czasowym.\nPrzedział jest dzielony na `limit` podprzedziałów o możliwie równych długościach będących dodatnimi liczbami całkowitymi sekund.\nJeśli `limit` jest dzielnikiem liczby sekund w przedziale, będą one równej długości.", "operationId" : "services_event_availability_chart", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zdarzenia", "in" : "path", "name" : "_event_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Maksymalna liczba podprzedziałów, jaka ma zostać zwrócona, domyślnie 24. Ta wartość nie może być większa niż długość wybranego przedziału w sekundach.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 24, "maximum" : 1000, "minimum" : 1, "type" : "integer" } }, { "description" : "Początek przedziału czasowego, domyślnie 24 godziny przed `to`.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Koniec przedziału czasowego, domyślnie aktualny czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_event_service_level_intervals" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `event_not_found` (4047333): Nie znaleziono zdarzenia.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca dane do wykresu Service Level dla wybranego zdarzenia.", "tags" : [ "charts" ] } }, "/services/{_id}/event_charts/{_event_id}/availability/range" : { "get" : { "description" : "Zwraca przedział czasowy, z którego są dostępne dane Service Level dla zdarzenia.", "operationId" : "services_event_availability_chart_range", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zdarzenia", "in" : "path", "name" : "_event_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event_availability_time_range" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `event_not_found` (4047333): Nie znaleziono zdarzenia.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca przedział czasowy, z którego są dostępne dane Service Level dla zdarzenia.", "tags" : [ "charts" ] } }, "/services/{_id}/event_history/{_event_id}/service_level" : { "get" : { "description" : "Zwraca Service Level dla danej usługi i zdarzenia w wybranym przedziale czasowym.", "operationId" : "services_event_service_level", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zdarzenia", "in" : "path", "name" : "_event_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Początek przedziału czasowego. Domyślnie początek przedziału dla którego są dostępne dane Service Level dla usługi i zdarzenia.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Koniec przedziału czasowego. Domyślnie koniec przedziału dla którego są dostępne dane Service Level dla usługi i zdarzenia.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event_service_level_data" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `event_not_found` (4047333): Nie znaleziono zdarzenia.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca Service Level dla danej usługi i zdarzenia w wybranym przedziale czasowym.", "tags" : [ "history" ] } }, "/services/{_id}/event_history/{_event_id}/status_changes" : { "get" : { "description" : "Zwraca historię zmian stanów zdarzenia dla usługi z wybranego przedziału czasowego.\n\nPrzedział czasowy może zostać zawężony przez opcjonalne parametry `from` (początek przedziału czasowego, w którym zdarzenie przeszło w dany stan dla usługi) oraz `to` (koniec przedziału).\n\nDomyślnie wyniki są sortowane rosnąco po czasie przejścia usługi w dany stan (`start_time`).", "operationId" : "services_read_event_status_changes", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zdarzenia.", "in" : "path", "name" : "_event_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "duration", "end_time", "event_id", "first_analysis_id", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "duration", "end_time", "event_id", "first_analysis_id", "service_id", "start_time", "status", "-change_id", "-duration", "-end_time", "-event_id", "-first_analysis_id", "-service_id", "-start_time", "-status" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "change_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "change_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "change_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "duration", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "duration!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "first_analysis_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "first_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "first_analysis_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "from", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Sposób wyszukiwania zmian w wybranym przedziale: rozpoczynające się w nim (`starting`) lub mające z nim niepuste przecięcie (`overlapping`).", "in" : "query", "name" : "intervals", "required" : false, "schema" : { "default" : "starting", "description" : "Sposób wyszukiwania zmian w wybranym przedziale: rozpoczynające się w nim (`starting`) lub mające z nim niepuste przecięcie (`overlapping`).", "enum" : [ "overlapping", "starting" ], "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "to", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_event_status_changes" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `event_not_found` (4047333): Nie znaleziono zdarzenia.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca historię zmian stanów zdarzenia dla usługi z wybranego przedziału czasowego.", "tags" : [ "history" ] } }, "/services/{_id}/event_history/{_event_id}/status_changes/{_change_id}" : { "get" : { "description" : "Zwraca wybraną zmianę stanu zdarzenia dla usługi.", "operationId" : "services_read_event_status_change", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zdarzenia", "in" : "path", "name" : "_event_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zmiany stanu zdarzenia.", "in" : "path", "name" : "_change_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "duration", "end_time", "event_id", "first_analysis_id", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event_status_change" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `event_not_found` (4047333): Nie znaleziono zdarzenia.\n* `event_status_change_not_found` (4046994): Nie znaleziono zmiany stanu zdarzenia.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca wybraną zmianę stanu zdarzenia dla usługi.", "tags" : [ "history" ] } }, "/services/{_id}/event_statuses" : { "get" : { "description" : "Zwraca listę aktualnych statusów zdarzeń dla usługi.", "operationId" : "services_read_event_statuses", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.delete", "permissions.disable", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "event_id", "service_id", "summary", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "event.name", "event.priority", "event_id", "permissions.delete", "permissions.disable", "permissions.own", "permissions.read", "permissions.update", "service.name", "service_id", "summary", "time", "-event.name", "-event.priority", "-event_id", "-permissions.delete", "-permissions.disable", "-permissions.own", "-permissions.read", "-permissions.update", "-service.name", "-service_id", "-summary", "-time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "event_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "event.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "event.priority", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "event.priority!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.disable", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.disable!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_event_statuses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę aktualnych statusów zdarzeń dla usługi.", "tags" : [ "services" ] } }, "/services/{_id}/event_statuses/{_event_id}" : { "get" : { "description" : "Zwraca aktualny status pojedynczego zdarzenia dla usługi.", "operationId" : "services_read_event_status", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zdarzenia", "in" : "path", "name" : "_event_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "event", "event.account_ids", "event.description", "event.disable_elements", "event.disable_main_content", "event.disable_steps", "event.error_on_elements", "event.error_type_category_ids", "event.excluded_error_type_category_ids", "event.group_ids", "event.id", "event.is_persistent", "event.maximum_sensors_percentage", "event.metrics", "event.minimum_response_time", "event.name", "event.owner_id", "event.priority", "event.required_event_ids", "event.sensors_percentage", "event.service_ids", "event.unknown_check_results", "permissions", "permissions.delete", "permissions.disable", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id", "service_status", "service_status.average_response_time", "service_status.check_status", "service_status.check_status_is_up_to_date", "service_status.highest_active_event_priority", "service_status.id", "service_status.last_analysis_id", "service_status.last_analysis_time", "service_status.last_check_status_change_time", "service_status.last_failure_analysis_id", "service_status.last_failure_analysis_time", "service_status.last_ok_analysis_id", "service_status.last_ok_analysis_time", "service_status.monitoring_status", "service_status.notifications_status", "service_status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "event_id", "service_id", "summary", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/event_status" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`event_status_not_found` (4049278): Nie znaleziono statusu zdarzenia." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca aktualny status pojedynczego zdarzenia dla usługi.", "tags" : [ "events", "services" ] } }, "/services/{_id}/event_statuses/{_event_id}/disable" : { "post" : { "description" : "Wyłącza zachodzenie zdarzenia.", "operationId" : "services_disable_event", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zdarzenia", "in" : "path", "name" : "_event_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "201" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wyłącza zachodzenie zdarzenia.", "tags" : [ "events", "services" ] } }, "/services/{_id}/force_analysis" : { "post" : { "description" : "Wymusza wykonanie analizy działania usługi poza zaplanowanym harmonogramem.\n\nWymuszanie wykonywania dodatkowych analiz służy przede wszystkim do przetestowania działania usługi po zmianie jej ustawień. Limity wymuszonych analiz dla pojedynczej usługi są zależne od jej typu; dla większości typów wynoszą 1 na minutę, 10 na godzinę i 25 na dobę. Limity te są liczone dla okrągłych minut, godzin i dób w UTC.", "operationId" : "services_force_analysis", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `force_analysis_not_allowed` (4031261): Brak uprawnień do wymuszenia analizy działania usługi.\n* `forced_analyses_limit_reached` (4031997): Wyczerpany limit wymuszeń analizy działania usługi w przedziale czasowym.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wymusza wykonanie analizy działania usługi poza zaplanowanym harmonogramem.", "tags" : [ "services" ] } }, "/services/{_id}/force_custom_analysis" : { "post" : { "description" : "Wymusza wykonanie analizy działania usługi poza zaplanowanym harmonogramem, z niestandardowymi ustawieniami.\n\nTa operacja gwarantuje natychmiastowe wykonanie analizy i nie zużywa limitów wymuszonych analiz dla usługi.", "operationId" : "services_force_custom_analysis", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/extended_settings" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `force_custom_analysis_not_allowed` (4032655): Brak uprawnień do wymuszenia niestandardowej analizy działania usługi.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `extended_setting_required` (4227491): Ustawienie wymagane.\n* `incorrect_extended_setting` (4224583): Niepoprawna wartość ustawienia usługi.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `unknown_extended_setting` (4227971): Niepoprawne ustawienie usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wymusza wykonanie analizy działania usługi poza zaplanowanym harmonogramem, z niestandardowymi ustawieniami.", "tags" : [ "services" ] } }, "/services/{_id}/group" : { "get" : { "description" : "Zwraca grupę, do której należy wybrana usługa.", "operationId" : "services_read_group", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.create_notification_addresses", "permissions.create_periodic_report_addresses", "permissions.create_services", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.share", "permissions.update", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "stats", "stats.id", "stats.sensors_count", "stats.services_count", "stats.services_count_archived", "stats.services_count_failure", "stats.services_count_ok", "stats.services_count_paused", "stats.services_count_suspended", "stats.services_count_unknown" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "archived_services_in_periodic_reports", "assigned_sensor_ids", "id", "is_default", "name", "owner_id", "periodic_daily_reports", "periodic_monthly_reports", "periodic_weekly_reports", "sensor_ids" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/group" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `group_not_found` (4046627): Nie znaleziono grupy.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca grupę, do której należy wybrana usługa.", "tags" : [ "groups", "services" ] } }, "/services/{_id}/history/analyses" : { "get" : { "description" : "Zwraca historię analiz działania usługi z wybranego przedziału czasowego.\n\nPojedyncza analiza jest jednoznacznie identyfikowana przez parę: id usługi (`service_id`) i id analizy w obrębie usługi (`analysis_id`).\n\nPrzedział czasowy jest określany przez parametry `from` (początek przedziału, domyślnie 1 doba przed `to`) oraz `to` (koniec przedziału, domyślnie aktualny czas).\nDługość przedziału jest ograniczona ze względu na wydajność.\nDla wybranego przedziału można pobrać informację o dostępności historii analiz za pomocą operacji `GET /services/{_id}/history/time_range_info`.\nHistoria analiz jest zawsze dostępna dla przedziałów o długości nie większej niż 40 dni.\n\nDomyślnie wyniki są sortowane malejąco po czasie wykonania analizy (`time`).", "operationId" : "services_read_analyses", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "error_checks_count", "error_tolerance", "failure", "ok_checks_count", "service_id", "time", "unknown_checks_count" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "error_checks_count", "error_tolerance", "failure", "ok_checks_count", "service_id", "time", "unknown_checks_count", "-analysis_id", "-error_checks_count", "-error_tolerance", "-failure", "-ok_checks_count", "-service_id", "-time", "-unknown_checks_count" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_checks_count", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_checks_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_tolerance", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_tolerance!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "failure", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "failure!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "ok_checks_count", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ok_checks_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "unknown_checks_count", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "unknown_checks_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_analyses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `time_range_too_long` (4031991): Podano zbyt długi przedział czasowy." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca historię analiz działania usługi z wybranego przedziału czasowego.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}" : { "get" : { "description" : "Zwraca pojedynczą analizę działania usługi.\n\nAnaliza jest jednoznacznie identyfikowana przez parę: id usługi (`service_id`) i id analizy w obrębie usługi (`analysis_id`).", "operationId" : "services_read_analysis", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "error_checks_count", "error_tolerance", "failure", "ok_checks_count", "service_id", "time", "unknown_checks_count" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/analysis" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczą analizę działania usługi.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks" : { "get" : { "description" : "Zwraca listę sprawdzeń usługi należących do wybranej analizy.\n\nSprawdzenie jest jednoznacznie identyfikowane przez trójkę: id usługi (`service_id`), id analizy (`analysis_id`) i id stacji monitorującej (`sensor_id`).\n\nDomyślnie wyniki są sortowane rosnąco po identyfikatorze stacji monitorującej.\n\nPole `error_type.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_analysis_checks", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "error_type", "error_type.category_ids", "error_type.description", "error_type.diagnosis", "error_type.extra_info", "error_type.id", "error_type.name", "sensor", "sensor.city", "sensor.continent", "sensor.country", "sensor.dns_diagnostics_available", "sensor.id", "sensor.ip_address", "sensor.ipv6_address", "sensor.is_available", "sensor.is_enabled", "sensor.links", "sensor.name", "sensor.service_type_category_ids", "sensor.traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "data_size", "error_message", "error_type_id", "har_available", "path_step", "response_time", "result", "sensor_id", "service_id", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "data_size", "error_message", "error_type.name", "error_type_id", "har_available", "path_step", "response_time", "result", "sensor.name", "sensor_id", "service_id", "time", "-analysis_id", "-data_size", "-error_message", "-error_type.name", "-error_type_id", "-har_available", "-path_step", "-response_time", "-result", "-sensor.name", "-sensor_id", "-service_id", "-time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "data_size", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "data_size!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_message", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_message!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "error_message~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_type_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_type_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "har_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "har_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "path_step", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "path_step!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "response_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "response_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "result", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "result!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "result~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sensor_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensor_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_type.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_type.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "error_type.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sensor.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensor.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "sensor.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_checks" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę sprawdzeń usługi należących do wybranej analizy.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}" : { "get" : { "description" : "Zwraca pojedyncze sprawdzenie usługi.\n\nSprawdzenie jest jednoznacznie identyfikowane przez trójkę: id usługi (`service_id`), id analizy (`analysis_id`) i id stacji monitorującej (`sensor_id`).\n\n\n\nPole `error_type.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_check", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "error_type", "error_type.category_ids", "error_type.description", "error_type.diagnosis", "error_type.extra_info", "error_type.id", "error_type.name", "sensor", "sensor.city", "sensor.continent", "sensor.country", "sensor.dns_diagnostics_available", "sensor.id", "sensor.ip_address", "sensor.ipv6_address", "sensor.is_available", "sensor.is_enabled", "sensor.links", "sensor.name", "sensor.service_type_category_ids", "sensor.traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "data_size", "error_message", "error_type_id", "har_available", "path_step", "response_time", "result", "sensor_id", "service_id", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/check" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze sprawdzenie usługi.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/artifacts" : { "get" : { "description" : "Zwraca listę artefaktów dla wybranego sprawdzenia.", "operationId" : "services_read_artifacts", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "artifact_type", "artifact_type.description", "artifact_type.id", "artifact_type.name", "token", "token.analysis_id", "token.artifact_id", "token.sensor_id", "token.service_id", "token.session_id", "token.suggested_file_name", "token.token" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "artifact_id", "content_type", "file_name", "sensor_id", "service_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "artifact_id", "content_type", "file_name", "sensor_id", "service_id", "-analysis_id", "-artifact_id", "-content_type", "-file_name", "-sensor_id", "-service_id" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "analysis_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "analysis_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "artifact_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "artifact_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "artifact_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "content_type", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "content_type!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "content_type~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "file_name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "file_name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "file_name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sensor_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensor_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_artifacts" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę artefaktów dla wybranego sprawdzenia.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/artifacts/{_artifact_id}" : { "get" : { "description" : "Zwraca informacje o wybranym artefakcie.", "operationId" : "services_read_artifact", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator artefaktu, unikalny w obrębie jednego sprawdzenia.", "in" : "path", "name" : "_artifact_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "artifact_type", "artifact_type.description", "artifact_type.id", "artifact_type.name", "token", "token.analysis_id", "token.artifact_id", "token.sensor_id", "token.service_id", "token.session_id", "token.suggested_file_name", "token.token" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "artifact_id", "content_type", "file_name", "sensor_id", "service_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/artifact" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `artifact_not_found` (4045309): Nie znaleziono artefaktu.\n* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca informacje o wybranym artefakcie.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/artifacts/{_artifact_id}/by_token/{file_name}" : { "get" : { "description" : "Zwraca zawartość wybranego artefaktu na podstawie tokenu.", "operationId" : "services_read_artifact_by_token", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator artefaktu, unikalny w obrębie jednego sprawdzenia.", "in" : "path", "name" : "_artifact_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Nazwa pobieranego pliku.", "in" : "path", "name" : "file_name", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator sesji.", "in" : "query", "name" : "session_id", "required" : false, "schema" : { "maxLength" : 40, "minLength" : 40, "pattern" : "^[0-9a-f]*$", "type" : "string" } }, { "description" : "Token dostępowy do artefaktu dla sesji.", "in" : "query", "name" : "token", "required" : false, "schema" : { "maxLength" : 64, "minLength" : 64, "pattern" : "^[0-9a-f]*$", "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "Content-Disposition" : { "description" : "Określa sposób pobierania artefaktu przez klienta API.", "schema" : { "type" : "string" } } } }, "206" : { "description" : "Częściowa odpowiedź.", "headers" : { "Content-Range" : { "description" : "Zakres zwróconej odpowiedzi.", "schema" : { "type" : "string" } } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `artifact_not_found` (4045309): Nie znaleziono artefaktu.\n* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca zawartość wybranego artefaktu na podstawie tokenu.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/artifacts/{_artifact_id}/plain" : { "get" : { "description" : "Zwraca zawartość wybranego artefaktu.", "operationId" : "services_read_artifact_plain", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator artefaktu, unikalny w obrębie jednego sprawdzenia.", "in" : "path", "name" : "_artifact_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "206" : { "description" : "Częściowa odpowiedź.", "headers" : { "Content-Range" : { "description" : "Zakres zwróconej odpowiedzi.", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `artifact_not_found` (4045309): Nie znaleziono artefaktu.\n* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca zawartość wybranego artefaktu.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/artifacts/{_artifact_id}/zip" : { "get" : { "description" : "Zwraca zawartość wybranego artefaktu w postaci archiwum ZIP.", "operationId" : "services_read_artifact_zip", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator artefaktu, unikalny w obrębie jednego sprawdzenia.", "in" : "path", "name" : "_artifact_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/zip" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "206" : { "description" : "Częściowa odpowiedź.", "headers" : { "Content-Range" : { "description" : "Zakres zwróconej odpowiedzi.", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `artifact_not_found` (4045309): Nie znaleziono artefaktu.\n* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca zawartość wybranego artefaktu w postaci archiwum ZIP.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/content" : { "get" : { "deprecated" : true, "description" : "Zwraca treść strony z momentu awarii.\n\nSprawdzenie jest jednoznacznie identyfikowane przez trójkę: id usługi (`service_id`), id analizy (`analysis_id`) i id stacji monitorującej (`sensor_id`).\n\nTreść strony jest skompresowana algorytmem zip.\n\nOperacja zostanie usunięta w API 4.0. Zamiast niej należy korzystać z operacji pobierania skompresowanego artefaktu `content`: `GET /services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/artifacts/content/zip`.", "operationId" : "services_read_check_content", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/zip" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "206" : { "description" : "Częściowa odpowiedź.", "headers" : { "Content-Range" : { "description" : "Zakres zwróconej odpowiedzi.", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `artifact_not_found` (4045309): Nie znaleziono artefaktu.\n* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca treść strony z momentu awarii.", "tags" : [ "history", "deprecated" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/details" : { "get" : { "description" : "Zwraca szczegóły pojedynczego sprawdzenia usługi.\n\nSprawdzenie jest jednoznacznie identyfikowane przez trójkę: id usługi (`service_id`), id analizy (`analysis_id`) i id stacji monitorującej (`sensor_id`).\n\nWiększość informacji szczegółowych jest dostępna jedynie dla błędnych sprawdzeń i służy do diagnostyki problemów z monitorowaną usługą.", "operationId" : "services_read_check_details", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "sensor", "sensor.city", "sensor.continent", "sensor.country", "sensor.dns_diagnostics_available", "sensor.id", "sensor.ip_address", "sensor.ipv6_address", "sensor.is_available", "sensor.is_enabled", "sensor.links", "sensor.name", "sensor.service_type_category_ids", "sensor.traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "base_url", "content_available", "content_type", "file_name", "metrics", "response_headers", "sensor_id", "service_id", "step_data" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/check_detail" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca szczegóły pojedynczego sprawdzenia usługi.", "tags" : [ "history" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/har" : { "get" : { "deprecated" : true, "description" : "Zwraca plik HAR dla sprawdzenia.\n\nSprawdzenie jest jednoznacznie identyfikowane przez trójkę: id usługi (`service_id`), id analizy (`analysis_id`) i id stacji monitorującej (`sensor_id`).\n\n\n\nOperacja zostanie usunięta w API 4.0. Zamiast niej należy korzystać z operacji pobierania artefaktu `har`: `GET /services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/artifacts/har/plain`.\n\nPole `error_type.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_check_har", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json+har" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `har_unavailable` (4043632): Plik HAR nie jest dostępny dla wybranego sprawdzenia.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca plik HAR dla sprawdzenia.", "tags" : [ "history", "deprecated" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/uncompressed_content" : { "get" : { "deprecated" : true, "description" : "Zwraca treść strony z momentu awarii (bez kompresji).\n\nSprawdzenie jest jednoznacznie identyfikowane przez trójkę: id usługi (`service_id`), id analizy (`analysis_id`) i id stacji monitorującej (`sensor_id`).\n\nTreść nie jest skompresowana jak w przypadku operacji `GET /services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/content`.\n\nOperacja zostanie usunięta w API 4.0. Zamiast niej należy korzystać z operacji pobierania artefaktu `content`: `GET /services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/artifacts/content/plain`.", "operationId" : "services_read_uncompressed_check_content", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator stacji monitorującej.", "in" : "path", "name" : "_sensor_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "206" : { "description" : "Częściowa odpowiedź.", "headers" : { "Content-Range" : { "description" : "Zakres zwróconej odpowiedzi.", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `artifact_not_found` (4045309): Nie znaleziono artefaktu.\n* `check_not_found` (4043870): Nie znaleziono sprawdzenia usługi.\n* `content_unavailable` (4044838): Treść strony nie jest dostępna dla wybranego sprawdzenia.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca treść strony z momentu awarii (bez kompresji).", "tags" : [ "history", "deprecated" ] } }, "/services/{_id}/history/analyses/{_analysis_id}/steps_summary" : { "get" : { "description" : "Zwraca statystyki kroków scenariusza dla wybranej analizy.", "operationId" : "services_read_analysis_steps_summary", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator analizy, unikalny w obrębie jednej usługi.", "in" : "path", "name" : "_analysis_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "additionalProperties" : false, "properties" : { "average_response_time" : { "description" : "Średni czas przejścia kroku", "minimum" : 0, "type" : "integer" }, "error_checks" : { "description" : "Liczba sprawdzeń w analizie, w których wystąpił błąd na kroku", "minimum" : 0, "type" : "integer" }, "name" : { "description" : "Nazwa kroku", "type" : "string" }, "ok_checks" : { "description" : "Liczba sprawdzeń w analizie, w których nie wystąpił błąd na kroku", "minimum" : 0, "type" : "integer" }, "unknown_checks" : { "description" : "Liczba sprawdzeń w analizie, dla których stan kroku jest nieznany", "minimum" : 0, "type" : "integer" } }, "type" : "object" }, "type" : "array" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `analysis_not_found` (4049316): Nie znaleziono analizy.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca statystyki kroków scenariusza dla wybranej analizy.", "tags" : [ "history" ] } }, "/services/{_id}/history/checks" : { "get" : { "description" : "Zwraca historię sprawdzeń usługi z wybranego przedziału czasowego.\n\nSprawdzenie jest jednoznacznie identyfikowane przez trójkę: id usługi (`service_id`), id analizy (`analysis_id`) i id stacji monitorującej (`sensor_id`).\n\nPrzedział czasowy jest określany przez parametry `from` (początek przedziału, domyślnie 1 doba przed `to`) oraz `to` (koniec przedziału, domyślnie aktualny czas).\nDługość przedziału jest ograniczona ze względu na wydajność.\nDla wybranego przedziału można pobrać informację o dostępności historii sprawdzeń za pomocą operacji `GET /services/{_id}/history/time_range_info`.\nHistoria sprawdzeń jest zawsze dostępna dla przedziałów o długości nie większej niż 10 dni.\n\nPrzy dużej liczbie wyników całkowita liczba sprawdzeń (nagłówek `X-Total-Count`) może być jedynie szacunkowa - mówi o tym nagłówek odpowiedzi `X-Total-Count-Estimated`.\n\nDomyślnie wyniki są sortowane malejąco po czasie wykonania analizy (`time`).\n\nPole `error_type.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_checks", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "error_type", "error_type.category_ids", "error_type.description", "error_type.diagnosis", "error_type.extra_info", "error_type.id", "error_type.name", "sensor", "sensor.city", "sensor.continent", "sensor.country", "sensor.dns_diagnostics_available", "sensor.id", "sensor.ip_address", "sensor.ipv6_address", "sensor.is_available", "sensor.is_enabled", "sensor.links", "sensor.name", "sensor.service_type_category_ids", "sensor.traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "data_size", "error_message", "error_type_id", "har_available", "path_step", "response_time", "result", "sensor_id", "service_id", "time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "analysis_id", "data_size", "error_message", "error_type.name", "error_type_id", "har_available", "path_step", "response_time", "result", "sensor.name", "sensor_id", "service_id", "time", "-analysis_id", "-data_size", "-error_message", "-error_type.name", "-error_type_id", "-har_available", "-path_step", "-response_time", "-result", "-sensor.name", "-sensor_id", "-service_id", "-time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "data_size", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "data_size!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_message", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_message!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "error_message~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_type_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_type_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "har_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "har_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "path_step", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "path_step!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "response_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "response_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "result", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "result!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "result~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sensor_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensor_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "error_type.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "error_type.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "error_type.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "sensor.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensor.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "sensor.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_checks" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Time-Range-From" : { "description" : "Początek przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Time-Range-To" : { "description" : "Koniec przedziału czasowego.", "schema" : { "format" : "dateTime", "type" : "string" } }, "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } }, "X-Total-Count-Estimated" : { "description" : "Określa, czy wartość nagłówka X-Total-Count jest jedynie przybliżona.", "schema" : { "type" : "boolean" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `time_range_too_long` (4031991): Podano zbyt długi przedział czasowy." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca historię sprawdzeń usługi z wybranego przedziału czasowego.", "tags" : [ "history" ] } }, "/services/{_id}/history/detected_error_types" : { "get" : { "description" : "Zwraca błędy wykryte podczas monitoringu usługi.\n\nTa operacja zwraca listę typów błędów wykrytych podczas monitoringu usługi w wybranym przedziale czasowym.\n\nDomyślny przedział czasowy: ostatnia doba.\n\nMaksymalna długość przedziału jest taka, jak dla operacji pobierania listy sprawdzeń.\n\nPola wyniku `description`, `diagnosis`, `extra_info` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_detected_error_types", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "categories", "categories.description", "categories.id", "categories.name", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "category_ids", "description", "diagnosis", "extra_info", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "diagnosis", "extra_info", "id", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "-description", "-diagnosis", "-extra_info", "-id", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "diagnosis", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "diagnosis!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "diagnosis~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "extra_info", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "extra_info!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "extra_info~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_error_types" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `time_range_too_long` (4031991): Podano zbyt długi przedział czasowy." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca błędy wykryte podczas monitoringu usługi.", "tags" : [ "history" ] } }, "/services/{_id}/history/service_level" : { "get" : { "description" : "Zwraca dostępność usługi w wybranym przedziale czasowym.", "operationId" : "services_service_level", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Początek przedziału czasowego. Domyślnie początek przedziału dla którego są dostępne dane Service Level dla usługi.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Koniec przedziału czasowego. Domyślnie koniec przedziału dla którego są dostępne dane Service Level dla usługi.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_level_data" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca dostępność usługi w wybranym przedziale czasowym.", "tags" : [ "history" ] } }, "/services/{_id}/history/status_changes" : { "get" : { "description" : "Zwraca historię zmian stanów działania usługi z wybranego przedziału czasowego.\n\nPrzedział czasowy może zostać zawężony przez opcjonalne parametry `from` (początek przedziału czasowego, w którym usługa przeszła w dany stan) oraz `to` (koniec przedziału).\n\nDomyślnie wyniki są sortowane rosnąco po czasie przejścia usługi w dany stan (`start_time`).", "operationId" : "services_read_status_changes", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "correction_stats", "correction_stats.count", "correction_stats.duration", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "description", "duration", "end_time", "first_analysis_id", "pause_reason", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "description", "duration", "end_time", "first_analysis_id", "pause_reason", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_id", "start_time", "status", "-change_id", "-description", "-duration", "-end_time", "-first_analysis_id", "-pause_reason", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service_id", "-start_time", "-status" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "change_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "change_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "change_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "duration", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "duration!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "first_analysis_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "from", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Sposób wyszukiwania zmian w wybranym przedziale: rozpoczynające się w nim (`starting`) lub mające z nim niepuste przecięcie (`overlapping`).", "in" : "query", "name" : "intervals", "required" : false, "schema" : { "default" : "starting", "description" : "Sposób wyszukiwania zmian w wybranym przedziale: rozpoczynające się w nim (`starting`) lub mające z nim niepuste przecięcie (`overlapping`).", "enum" : [ "overlapping", "starting" ], "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "pause_reason", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "pause_reason!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "pause_reason~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas lub NULL.", "in" : "query", "name" : "to", "required" : false, "schema" : { "description" : "Data i czas lub NULL.", "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_status_changes" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca historię zmian stanów działania usługi z wybranego przedziału czasowego.", "tags" : [ "history" ] } }, "/services/{_id}/history/status_changes/bulk_update" : { "post" : { "description" : "Aktualizuje opisy wielu zmian stanów jednocześnie.", "operationId" : "services_bulk_update_status_changes", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/status_change_bulk_update_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Aktualizuje opisy wielu zmian stanów jednocześnie.", "tags" : [ "history" ] } }, "/services/{_id}/history/status_changes/{_change_id}" : { "get" : { "description" : "Zwraca wybraną zmianę stanu działania usługi.", "operationId" : "services_read_status_change", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zmiany stanu", "in" : "path", "name" : "_change_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "correction_stats", "correction_stats.count", "correction_stats.duration", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "description", "duration", "end_time", "first_analysis_id", "pause_reason", "service_id", "start_time", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/status_change" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`status_change_not_found` (4044169): Nie znaleziono zmiany statusu działania usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca wybraną zmianę stanu działania usługi.", "tags" : [ "history" ] }, "put" : { "description" : "Modyfikuje wybraną zmianę stanu działania usługi.\n\nUmożliwia modyfikację opisu wybranej zmiany stanu działania usługi.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `change_id`, `duration`, `end_time`, `first_analysis_id`, `pause_reason`, `service_id`, `start_time` oraz `status`.", "operationId" : "services_update_status_change", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zmiany stanu", "in" : "path", "name" : "_change_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/status_change" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`status_change_not_found` (4044169): Nie znaleziono zmiany statusu działania usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje wybraną zmianę stanu działania usługi.", "tags" : [ "history" ] } }, "/services/{_id}/history/status_changes/{_change_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do historycznej zmiany stanu działania usługi.", "operationId" : "services_read_status_change_permissions", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zmiany stanu", "in" : "path", "name" : "_change_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `status_change_not_found` (4044169): Nie znaleziono zmiany statusu działania usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do historycznej zmiany stanu działania usługi.", "tags" : [ "history", "permissions" ] } }, "/services/{_id}/history/status_changes/{_change_id}/stats" : { "get" : { "description" : "Zwraca statystyki liczby sprawdzeń w wybranym stanie działania usługi.", "operationId" : "services_read_status_change_stats", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator zmiany stanu działania usługi.", "in" : "path", "name" : "_change_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "sensor", "sensor.city", "sensor.continent", "sensor.country", "sensor.dns_diagnostics_available", "sensor.id", "sensor.ip_address", "sensor.ipv6_address", "sensor.is_available", "sensor.is_enabled", "sensor.links", "sensor.name", "sensor.service_type_category_ids", "sensor.traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "checks_count", "sensor_id", "service_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "change_id", "checks_count", "sensor_id", "service_id", "-change_id", "-checks_count", "-sensor_id", "-service_id" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "change_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "checks_count", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "checks_count!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "sensor_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_status_change_stats" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `service_not_found` (4046121): Nie znaleziono usługi.\n* `status_change_not_found` (4044169): Nie znaleziono zmiany statusu działania usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca statystyki liczby sprawdzeń w wybranym stanie działania usługi.", "tags" : [ "history" ] } }, "/services/{_id}/history/time_range_info" : { "get" : { "description" : "Zwraca informacje o dostępności historii w danym przedziale czasowym.\n\nDla wybranego przedziału czasowego zwraca zbiorcze informacje o dostępności historii działania usługi: przybliżoną liczbę wykonanych sprawdzeń wykonanych w przedziale oraz czy dla przedziału jest dostępna do pobrania historia sprawdzeń (czy przedział nie jest zbyt długi dla `GET /services/{_id}/history/checks`) i analiz (`GET /services/{_id}/history/analyses`).\n\nDla przedziałów nie dłuższych niż 10 dni historia sprawdzeń jest zawsze dostępna. Dla analiz limit ten wynosi 40 dni.", "operationId" : "services_time_range_info", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Początek przedziału czasowego.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Koniec przedziału czasowego.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/time_range_info" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca informacje o dostępności historii w danym przedziale czasowym.", "tags" : [ "history" ] } }, "/services/{_id}/history/used_sensors" : { "get" : { "description" : "Zwraca stacje monitorujące, z których usługa była monitorowana.\n\nTa operacja zwraca listę stacji monitorujących wykorzystanych do monitoringu usługi w wybranym przedziale czasowym.\n\nDomyślny przedział czasowy: ostatnia doba.\n\nMaksymalna długość przedziału jest taka, jak dla operacji pobierania listy sprawdzeń.\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_used_sensors", "parameters" : [ { "description" : "Identyfikator usługi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `time_range_too_long` (4031991): Podano zbyt długi przedział czasowy." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca stacje monitorujące, z których usługa była monitorowana.", "tags" : [ "history" ] } }, "/services/{_id}/mobile_devices_count" : { "get" : { "description" : "Zwraca liczbę urządzeń mobilnych otrzymujących powiadomienia o usłudze.", "operationId" : "services_read_mobile_devices_count", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "minimum" : 0, "type" : "integer" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca liczbę urządzeń mobilnych otrzymujących powiadomienia o usłudze.", "tags" : [ "mobile" ] } }, "/services/{_id}/monitoring_sensors" : { "get" : { "description" : "Zwraca listę stacji monitorujących, z których usługa jest monitorowana.\n\nInne stacje mogą być wykorzystywane w przypadku korzystania z opcji losowania zastępczych stacji w przypadku awarii stacji.\n\nPola wyniku `city`, `continent` oraz `country` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_monitoring_sensors", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service_type_categories", "service_type_categories.description", "service_type_categories.id", "service_type_categories.name", "status", "status.id", "status.is_connected", "status.is_suspended", "status.summary" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "service_type_category_ids", "traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "city", "continent", "country", "dns_diagnostics_available", "id", "ip_address", "ipv6_address", "is_available", "is_enabled", "links", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "status.is_connected", "status.summary", "traceroute_diagnostics_available", "-city", "-continent", "-country", "-dns_diagnostics_available", "-id", "-ip_address", "-ipv6_address", "-is_available", "-is_enabled", "-links", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-status.is_connected", "-status.summary", "-traceroute_diagnostics_available" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "city", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "city!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "city~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "continent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "continent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "continent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "country", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "country!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "country~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "dns_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "dns_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ip_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ip_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ip_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "ipv6_address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "ipv6_address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "ipv6_address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_enabled", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_enabled!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "links", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "links!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "links~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "traceroute_diagnostics_available", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "traceroute_diagnostics_available!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.is_connected", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.is_connected!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "status.summary", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "status.summary!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "status.summary~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sensors" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę stacji monitorujących, z których usługa jest monitorowana.", "tags" : [ "sensors", "services" ] } }, "/services/{_id}/notification_addresses" : { "get" : { "description" : "Zwraca listę adresów powiadomień włączonych dla usługi.", "operationId" : "services_read_notification_addresses", "parameters" : [ { "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "notification_channel", "notification_channel.description", "notification_channel.id", "notification_channel.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group_id", "id", "notification_channel_id", "owner_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "group.name", "group_id", "id", "notification_channel_id", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.send_test_sms_notifications", "permissions.update", "-address", "-description", "-group.name", "-group_id", "-id", "-notification_channel_id", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.send_test_sms_notifications", "-permissions.update" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "notification_channel_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "notification_channel_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "notification_channel_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "group.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.send_test_sms_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.send_test_sms_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów powiadomień włączonych dla usługi.", "tags" : [ "notification_addresses", "services" ] } }, "/services/{_id}/notification_channels" : { "get" : { "description" : "Zwraca listę kanałów powiadomień włączonych dla usługi.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_notification_channels", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_channels" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę kanałów powiadomień włączonych dla usługi.", "tags" : [ "services" ] } }, "/services/{_id}/notification_conditions" : { "get" : { "description" : "Zwraca listę warunków powiadomień włączonych dla usługi.\n\n\n\nPole `name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_notification_conditions", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name", "-description", "-id", "-name" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_notification_conditions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę warunków powiadomień włączonych dla usługi.", "tags" : [ "services" ] } }, "/services/{_id}/notification_mode" : { "get" : { "description" : "Zwraca tryb powiadomień usługi.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_notification_mode", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/notification_mode" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `notification_mode_not_found` (4046208): Nie znaleziono trybu powiadomień.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca tryb powiadomień usługi.", "tags" : [ "services" ] } }, "/services/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy wybrana usługa.", "operationId" : "services_read_owner", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy wybrana usługa.", "tags" : [ "accounts", "services" ] } }, "/services/{_id}/periodic_report_addresses" : { "get" : { "description" : "Zwraca listę adresów, na które są wysyłane raporty okresowe dla usługi.\n\nZwraca listę adresów e-mail, na które będą wysyłane raporty okresowe dla usługi. Uwzględnia ustawienia \"periodic_daily_reports\", \"periodic_weekly_reports\" i \"periodic_monthly_reports\" z grupy, do której należy usługa.", "operationId" : "services_read_periodic_report_addresses", "parameters" : [ { "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "report_frequency" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "address", "group_id", "id", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "report_frequency", "-address", "-group_id", "-id", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-report_frequency" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "address", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "address!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "address~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "group_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "group_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "report_frequency", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "report_frequency!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "report_frequency~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_periodic_report_addresses" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę adresów, na które są wysyłane raporty okresowe dla usługi.", "tags" : [ "periodic_report_addresses", "services" ] } }, "/services/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranej usługi.", "operationId" : "services_read_permissions", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "archive", "create_corrections", "create_scheduled_suspensions", "create_suspensions", "create_weekly_suspensions", "delete", "force_analyses", "force_custom_analyses", "own", "read", "restore", "send_test_sms_notifications", "update", "update_step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranej usługi.", "tags" : [ "permissions", "services" ] } }, "/services/{_id}/recovery_notification_mode" : { "get" : { "description" : "Zwraca tryb powiadomień o końcu awarii dla usługi.\n\n\n\nPola wyniku `description` oraz `name` mogą przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_recovery_notification_mode", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "id", "name" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/recovery_notification_mode" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `recovery_notification_mode_not_found` (4045477): Nie znaleziono trybu powiadomień o końcu awarii.\n* `service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca tryb powiadomień o końcu awarii dla usługi.", "tags" : [ "services" ] } }, "/services/{_id}/restore" : { "post" : { "description" : "Przywraca zarchiwizowaną usługę.\n\nTa operacja wymaga uprawnienia `restore` do usługi oraz niewykorzystanego limitu usług w pakiecie konta, do którego należy usługa.", "operationId" : "services_restore", "parameters" : [ { "description" : "Identyfikator usługi", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "201" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `interval_too_low` (4038653): Częstotliwość sprawdzeń zbyt wysoka (niedostępna w pakiecie).\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `restore_not_allowed` (4037671): Nie można przywrócić usługi (nie jest zarchiwizowana lub brak uprawnień).\n* `services_limit_reached` (4037286): Osiągnięty limit liczby usług w pakiecie.\n* `services_type_limit_reached` (4037135): Osiągnięty limit liczby usług określonego typu w pakiecie.\n* `type_interval_too_low` (4038095): Częstotliwość sprawdzeń zbyt wysoka dla wybranego typu usługi (niedostępna w pakiecie)." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Przywraca zarchiwizowaną usługę.", "tags" : [ "services" ] } }, "/services/{_id}/schedule_custom_analysis" : { "post" : { "description" : "Wymusza wykonanie analizy działania usługi poza zaplanowanym harmonogramem, z niestandardowymi ustawieniami.\n\n[BETA] Ta operacja gwarantuje zlecenie sprawdzeń z pominięciem kolejki i nie zużywa limitów wymuszonych analiz dla usługi.", "operationId" : "services_schedule_custom_analysis", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "additionalProperties" : false, "properties" : { "delay" : { "default" : 0, "description" : "Opóźnienie wykonania analizy, w sekundach", "maximum" : 34560000, "minimum" : 0, "type" : "integer" }, "extended_settings" : { "$ref" : "#/components/schemas/extended_settings" } }, "type" : "object" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `force_custom_analysis_not_allowed` (4032655): Brak uprawnień do wymuszenia niestandardowej analizy działania usługi.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `extended_setting_required` (4227491): Ustawienie wymagane.\n* `incorrect_extended_setting` (4224583): Niepoprawna wartość ustawienia usługi.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut.\n* `unknown_extended_setting` (4227971): Niepoprawne ustawienie usługi." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wymusza wykonanie analizy działania usługi poza zaplanowanym harmonogramem, z niestandardowymi ustawieniami.", "tags" : [ "services" ] } }, "/services/{_id}/scheduled_suspensions" : { "get" : { "deprecated" : true, "description" : "Zwraca listę zaplanowanych zawieszeń dla usługi.\n\nUwaga: Operacje `/scheduled_suspensions` zostały zastąpione analogicznymi w tagu `suspensions`, dodatkowo uspójniającymi nazewnictwo pól `start_time` i `end_time` w obiektach zawieszeń.", "operationId" : "services_read_scheduled_suspensions", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end", "id", "only_notifications", "service_id", "start" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end", "id", "only_notifications", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start", "-description", "-end", "-id", "-only_notifications", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service.id", "-service.interval", "-service.is_active", "-service.is_archived", "-service.name", "-service.owner_id", "-service_id", "-start" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "end_from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Data i czas.", "in" : "query", "name" : "end_to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "only_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "only_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "start_from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Data i czas.", "in" : "query", "name" : "start_to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_scheduled_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zaplanowanych zawieszeń dla usługi.", "tags" : [ "service_suspensions", "services", "deprecated" ] } }, "/services/{_id}/send_test_sms_notification" : { "post" : { "description" : "Wysyła testowe powiadomienie SMS na numery telefonu przypisane do usługi.\n\nUsługa musi mieć włączony kanał powiadomień SMS, aby powiadomienia testowe zostały wysłane.", "operationId" : "services_send_test_sms", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/test_sms_notification_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `sms_test_not_allowed` (4031215): Brak uprawnień do wysyłania testowych powiadomień SMS." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Wysyła testowe powiadomienie SMS na numery telefonu przypisane do usługi.", "tags" : [ "services" ] } }, "/services/{_id}/suspensions" : { "get" : { "description" : "Zwraca listę zaplanowanych zawieszeń dla usługi.", "operationId" : "services_read_suspensions", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "id", "only_notifications", "service_id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "id", "only_notifications", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start_time", "-description", "-end_time", "-id", "-only_notifications", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service.id", "-service.interval", "-service.is_active", "-service.is_archived", "-service.name", "-service.owner_id", "-service_id", "-start_time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "end_from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "end_to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "only_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "only_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "start_from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "start_to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zaplanowanych zawieszeń dla usługi.", "tags" : [ "suspensions", "services" ] } }, "/services/{_id}/type" : { "get" : { "description" : "Zwraca typ wybranej usługi.\n\n\n\nPole `description` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "services_read_type", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "category", "category.description", "category.id", "category.name", "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address_prefix", "category_id", "customizable_step_names", "description", "id", "manual_schedule", "name", "step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service_type" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `service_not_found` (4046121): Nie znaleziono usługi.\n* `service_type_not_found` (4048434): Nie znaleziono typu usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca typ wybranej usługi.", "tags" : [ "service_types", "services" ] } }, "/services/{_id}/weekly_suspensions" : { "get" : { "description" : "Zwraca listę tygodniowych zawieszeń dla usługi.", "operationId" : "services_read_weekly_suspensions", "parameters" : [ { "description" : "Identyfikator uslugi.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "id", "only_notifications", "service_id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "id", "only_notifications", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start_minute", "-description", "-end_minute", "-id", "-only_notifications", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service.id", "-service.interval", "-service.is_active", "-service.is_archived", "-service.name", "-service.owner_id", "-service_id", "-start_minute" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "only_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "only_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_weekly_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę tygodniowych zawieszeń dla usługi.", "tags" : [ "suspensions", "service_suspensions", "services" ] } }, "/sessions" : { "get" : { "description" : "Zwraca listę sesji API.", "operationId" : "sessions_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "account", "account.disable_legacy_notifications", "account.id", "account.is_activated", "account.is_blocked", "account.is_read_only", "account.language_id", "account.name", "account.package_id", "account.parent_account_id", "account.time_zone_id", "account.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "absolute_expiration_time", "account_id", "created_at", "distribution_id", "expiration_duration", "expiration_time", "id", "is_2fa_required", "is_api_token", "is_hidden", "is_read_only", "last_used", "manager_id", "name", "scope", "user_agent" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "absolute_expiration_time", "account_id", "created_at", "distribution_id", "expiration_duration", "expiration_time", "id", "is_2fa_required", "is_api_token", "is_hidden", "is_read_only", "last_used", "manager_id", "name", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "scope", "user_agent", "-absolute_expiration_time", "-account_id", "-created_at", "-distribution_id", "-expiration_duration", "-expiration_time", "-id", "-is_2fa_required", "-is_api_token", "-is_hidden", "-is_read_only", "-last_used", "-manager_id", "-name", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-scope", "-user_agent" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "absolute_expiration_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "account_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "account_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "created_at", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "created_at!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "created_at~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "distribution_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "distribution_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "expiration_duration", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "expiration_duration!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "expiration_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "expiration_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "expiration_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_2fa_required", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_2fa_required!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_api_token", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_api_token!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_hidden", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_hidden!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "is_read_only", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "is_read_only!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "last_used!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "manager_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "manager_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "scope", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "scope!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "scope~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "user_agent", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "user_agent!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "user_agent~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sessions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę sesji API.", "tags" : [ "sessions" ] }, "post" : { "description" : "Tworzy nową sesję API.", "operationId" : "sessions_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "properties" : { "absolute_expiration_time" : { "description" : "Termin ważności sesji, bez przedłużania przy aktywności", "format" : "dateTime", "type" : "string" }, "client_id" : { "description" : "Identyfikator klienta API", "maxLength" : 64, "minLength" : 1, "type" : "string" }, "expiration_duration" : { "default" : "3600", "description" : "Czas bez aktywności, po jakim sesja wygaśnie, w sekundach", "maximum" : 1000000000, "minimum" : 1, "nullable" : true, "type" : "integer" }, "is_api_token" : { "default" : false, "type" : "boolean" }, "is_hidden" : { "description" : "Określa, czy sesja jest ukryta", "type" : "boolean" }, "is_read_only" : { "default" : false, "description" : "Określa, czy sesja jest tylko do odczytu", "type" : "boolean" }, "name" : { "default" : "", "maxLength" : 255, "type" : "string" }, "password" : { "description" : "Hasło", "maxLength" : 1024, "minLength" : 6, "type" : "string" }, "scope" : { "description" : "Zasięg autoryzacji", "enum" : [ "customer", "administrator" ], "type" : "string" }, "user_agent" : { "description" : "User-Agent klienta API. Domyślnie taki, jak w nagłówku User-Agent zapytania HTTP do API", "type" : "string" }, "user_ip_address" : { "description" : "Adres IP użytkownika API", "maxLength" : 15, "minLength" : 1, "type" : "string" }, "username" : { "description" : "Nazwa użytkownika", "maxLength" : 128, "minLength" : 1, "pattern" : "^[a-zA-Z0-9\\@_\\-\\.]*$", "type" : "string" } }, "required" : [ "username", "password" ], "type" : "object" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "properties" : { "id" : { "description" : "Identyfikator utworzonego obiektu sesji", "maxLength" : 40, "minLength" : 40, "pattern" : "^[0-9a-f]*$", "type" : "string" }, "is_2fa_required" : { "description" : "Określa, czy sesja wymaga dodatkowej weryfikacji 2FA", "type" : "boolean" }, "token" : { "description" : "Token sesji. Należy go zapamiętać po stronie klienta, ponieważ później nie jest możliwe jego pobranie", "maxLength" : 32, "minLength" : 32, "pattern" : "^[a-f0-9]*$", "type" : "string" } }, "required" : [ "id", "token" ], "type" : "object" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu sesji.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `2fa_verification_required` (4037844): Wymagana weryfikacja kodu 2FA.\n* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `too_many_sessions` (4039175): Osiągnięty limit liczby sesji i tokenów API dla konta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Tworzy nową sesję API.", "tags" : [ "sessions" ] } }, "/sessions/search" : { "post" : { "description" : "Zaawansowane pobieranie sesji API.", "operationId" : "sessions_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/session_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_sessions" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie sesji API.", "tags" : [ "sessions" ] } }, "/sessions/{_id}" : { "delete" : { "description" : "Usuwa sesję API.\n\nMożna użyć specjalnego identyfikatora `my_session`, aby zakończyć aktualnie używaną sesję.", "operationId" : "sessions_delete", "parameters" : [ { "description" : "Identyfikator sesji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`session_not_found` (4049784): Nie znaleziono sesji API." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa sesję API.", "tags" : [ "sessions" ] }, "get" : { "description" : "Zwraca pojedynczą sesję API.\n\nMożna użyć specjalnego identyfikatora `my_session`, aby pobrać aktualnie używaną sesję.", "operationId" : "sessions_read", "parameters" : [ { "description" : "Identyfikator sesji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "account", "account.disable_legacy_notifications", "account.id", "account.is_activated", "account.is_blocked", "account.is_read_only", "account.language_id", "account.name", "account.package_id", "account.parent_account_id", "account.time_zone_id", "account.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "absolute_expiration_time", "account_id", "created_at", "distribution_id", "expiration_duration", "expiration_time", "id", "is_2fa_required", "is_api_token", "is_hidden", "is_read_only", "last_used", "manager_id", "name", "scope", "user_agent" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/session" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`session_not_found` (4049784): Nie znaleziono sesji API." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "administrator" ] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczą sesję API.", "tags" : [ "sessions" ] } }, "/sessions/{_id}/2fa/verify" : { "post" : { "description" : "Weryfikuje sesję za pomocą jednorazowego kodu 2FA.\n\nMożna użyć identyfikatora `my_session`, aby wybrać aktualnie używaną sesję.", "operationId" : "sessions_verify_2fa", "parameters" : [ { "description" : "Identyfikator sesji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "properties" : { "code" : { "description" : "Sześciocyfrowy kod wygenerowany na podstawie klucza 2FA", "maxLength" : 6, "minLength" : 6, "pattern" : "^[0-9]*$", "type" : "string" } }, "required" : [ "code" ], "type" : "object" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `2fa_code_invalid` (4033708): Niepoprawny kod 2FA.\n* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Weryfikuje sesję za pomocą jednorazowego kodu 2FA.", "tags" : [ "sessions" ] } }, "/sessions/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranej sesji API.\n\nMożna użyć specjalnego identyfikatora `my_session`, aby wybrać aktualnie używaną sesję.", "operationId" : "sessions_read_permissions", "parameters" : [ { "description" : "Identyfikator sesji.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `session_not_found` (4049784): Nie znaleziono sesji API." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranej sesji API.", "tags" : [ "permissions", "sessions" ] } }, "/suspensions" : { "get" : { "description" : "Zwraca listę zaplanowanych zawieszeń.", "operationId" : "suspensions_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "id", "only_notifications", "service_id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "id", "only_notifications", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start_time", "-description", "-end_time", "-id", "-only_notifications", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service.id", "-service.interval", "-service.is_active", "-service.is_archived", "-service.name", "-service.owner_id", "-service_id", "-start_time" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "end_from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "end_to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "only_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "only_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "start_from", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_time", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_time!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_time~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Data i czas.", "in" : "query", "name" : "start_to", "required" : false, "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę zaplanowanych zawieszeń.", "tags" : [ "suspensions" ] }, "post" : { "description" : "Tworzy nowe zawieszenie.\n\nJeśli nie zostanie określony atrybut `start_time`, zawieszenie rozpocznie się w momencie jego utworzenia (zostanie użyty aktualny czas).", "operationId" : "suspensions_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/suspension_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/suspension_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe zawieszenie.", "tags" : [ "suspensions" ] } }, "/suspensions/bulk_create" : { "post" : { "description" : "Dodaje zaplanowane zawieszenie do wielu usług jednocześnie.\n\nZamiast pola `service_id` należy podać pole `service_ids` - tablicę identyfikatorów usług, do których posiadamy uprawnienie `create_suspensions`.", "operationId" : "suspensions_bulk_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/suspension_bulk_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Dodaje zaplanowane zawieszenie do wielu usług jednocześnie.", "tags" : [ "suspensions" ] } }, "/suspensions/bulk_delete" : { "post" : { "description" : "Usuwa wiele zawieszeń jednocześnie.\n\nW treści zapytania należy podać tablicę identyfikatorów zawieszeń, do których posiadamy uprawnienie `delete`.", "operationId" : "suspensions_bulk_delete", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "minimum" : 1, "type" : "integer" }, "type" : "array", "uniqueItems" : true } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`suspension_not_found` (4048719): Nie znaleziono zaplanowanego zawieszenia monitoringu lub powiadomień." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa wiele zawieszeń jednocześnie.", "tags" : [ "suspensions" ] } }, "/suspensions/search" : { "post" : { "description" : "Zaawansowane pobieranie zaplanowanych zawieszeń.", "operationId" : "suspensions_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/suspension_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_suspensions" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie zaplanowanych zawieszeń.", "tags" : [ "suspensions" ] } }, "/suspensions/{_id}" : { "delete" : { "description" : "Usuwa zaplanowane zawieszenie.", "operationId" : "suspensions_delete", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`suspension_not_found` (4048719): Nie znaleziono zaplanowanego zawieszenia monitoringu lub powiadomień." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa zaplanowane zawieszenie.", "tags" : [ "suspensions" ] }, "get" : { "description" : "Zwraca pojedyncze zaplanowane zawieszenie.", "operationId" : "suspensions_read", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_time", "id", "only_notifications", "service_id", "start_time" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/suspension" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`suspension_not_found` (4048719): Nie znaleziono zaplanowanego zawieszenia monitoringu lub powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze zaplanowane zawieszenie.", "tags" : [ "suspensions" ] }, "put" : { "description" : "Modyfikuje zaplanowane zawieszenie.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `service_id`.", "operationId" : "suspensions_update", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/suspension" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`suspension_not_found` (4048719): Nie znaleziono zaplanowanego zawieszenia monitoringu lub powiadomień." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_time_range` (4222950): Koniec przedziału czasowego musi być późniejszy niż jego początek.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje zaplanowane zawieszenie.", "tags" : [ "suspensions" ] } }, "/suspensions/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego zawieszenia.", "operationId" : "suspensions_read_permissions", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `suspension_not_found` (4048719): Nie znaleziono zaplanowanego zawieszenia monitoringu lub powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego zawieszenia.", "tags" : [ "permissions", "suspensions" ] } }, "/suspensions/{_id}/service" : { "get" : { "description" : "Zwraca usługę, której dotyczy wybrane zawieszenie.", "operationId" : "suspensions_read_service", "parameters" : [ { "description" : "Identyfikator zaplanowanego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "monitoring_sensors", "monitoring_sensors.city", "monitoring_sensors.continent", "monitoring_sensors.country", "monitoring_sensors.dns_diagnostics_available", "monitoring_sensors.id", "monitoring_sensors.ip_address", "monitoring_sensors.ipv6_address", "monitoring_sensors.is_available", "monitoring_sensors.is_enabled", "monitoring_sensors.links", "monitoring_sensors.name", "monitoring_sensors.service_type_category_ids", "monitoring_sensors.traceroute_diagnostics_available", "notification_channels", "notification_channels.description", "notification_channels.id", "notification_channels.name", "notification_conditions", "notification_conditions.description", "notification_conditions.id", "notification_conditions.name", "notification_mode", "notification_mode.description", "notification_mode.id", "notification_mode.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "recovery_notification_mode", "recovery_notification_mode.description", "recovery_notification_mode.id", "recovery_notification_mode.name", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "status", "status.average_response_time", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.id", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.last_failure_analysis_id", "status.last_failure_analysis_time", "status.last_ok_analysis_id", "status.last_ok_analysis_time", "status.monitoring_status", "status.notifications_status", "status.summary", "type", "type.address_prefix", "type.category_id", "type.customizable_step_names", "type.description", "type.id", "type.manual_schedule", "type.name", "type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "extended_settings", "group_id", "id", "interval", "is_active", "is_archived", "name", "notification_channel_ids", "notification_condition_ids", "notification_mode_id", "owner_id", "recovery_notification_mode_id", "sensor_ids", "silent_hours", "step_names", "suspension_hours", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `service_not_found` (4046121): Nie znaleziono usługi.\n* `suspension_not_found` (4048719): Nie znaleziono zaplanowanego zawieszenia monitoringu lub powiadomień." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca usługę, której dotyczy wybrane zawieszenie.", "tags" : [ "services", "suspensions" ] } }, "/system/dns_diagnostics" : { "post" : { "description" : "Tworzy nowe zapytanie diagnostyczne DNS.\n\nZapytanie jest wykonywane \"w tle\". Wyniki są dostępne, kiedy pole `status` przyjmie wartość `completed`.\n\nZapytania diagnostczne można wykonywać jedynie na stacjach monitorujących, których atrybut `dns_diagnostics_available` ma wartość `true`.", "operationId" : "system_create_dns_diagnostics", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/dns_diagnostic_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/dns_diagnostic_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`sensor_not_found` (4049807): Nie znaleziono stacji monitorującej." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe zapytanie diagnostyczne DNS.", "tags" : [ "system" ] } }, "/system/dns_diagnostics/{_id}" : { "delete" : { "description" : "Usuwa zapytanie diagnostyczne DNS.\n\nMożna użyć tej operacji aby anulować oczekujące zapytanie.", "operationId" : "system_delete_dns_diagnostics", "parameters" : [ { "description" : "Identyfikator zapytania.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`dns_diagnostics_not_found` (4048828): Nie znaleziono zapytania diagnostycznego DNS." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa zapytanie diagnostyczne DNS.", "tags" : [ "system" ] }, "get" : { "description" : "Zwraca pojedyncze zapytanie diagnostyczne DNS.", "operationId" : "system_read_dns_diagnostics", "parameters" : [ { "description" : "Identyfikator zapytania.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "sensor", "sensor.city", "sensor.continent", "sensor.country", "sensor.dns_diagnostics_available", "sensor.id", "sensor.ip_address", "sensor.ipv6_address", "sensor.is_available", "sensor.is_enabled", "sensor.links", "sensor.name", "sensor.service_type_category_ids", "sensor.traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "id", "results", "sensor_id", "settings", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/dns_diagnostic" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`dns_diagnostics_not_found` (4048828): Nie znaleziono zapytania diagnostycznego DNS." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze zapytanie diagnostyczne DNS.", "tags" : [ "system" ] } }, "/system/my_ip_address" : { "get" : { "description" : "Zwraca adres IP klienta API.\n\nOperacja ta ma na celu ułatwienie ustawiania whitelisty adresów IP dla konta.", "operationId" : "system_read_client_ip_address", "parameters" : [], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca adres IP klienta API.", "tags" : [ "system" ] } }, "/system/reset_password/confirm" : { "post" : { "description" : "Potwierdza reset hasła do konta.", "operationId" : "system_confirm_password_reset", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/password_reset_confirmation" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Potwierdza reset hasła do konta.", "tags" : [ "system" ] } }, "/system/reset_password/initialize" : { "post" : { "description" : "Generuje żądanie resetu hasła do konta.", "operationId" : "system_request_password_reset", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/password_reset_request" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "description" : "Poprawne wykonanie operacji", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Generuje żądanie resetu hasła do konta.", "tags" : [ "system" ] } }, "/system/stats" : { "get" : { "description" : "Zwraca aktualne statystyki systemu Monit24.pl.\n\nStatystyki są zliczane od 5 października 2015 roku.", "operationId" : "system_read_stats", "parameters" : [], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/system_stats" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [], "summary" : "Zwraca aktualne statystyki systemu Monit24.pl.", "tags" : [ "system" ] } }, "/system/traceroute_diagnostics" : { "post" : { "description" : "Tworzy nowe zapytanie diagnostyczne traceroute.\n\nZapytanie jest wykonywane \"w tle\". Wyniki są dostępne, kiedy pole `status` przyjmie wartość `completed`.\n\nZapytania diagnostczne można wykonywać jedynie na stacjach monitorujących, których atrybut `traceroute_diagnostics_available` ma wartość `true`.", "operationId" : "system_create_traceroute_diagnostics", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/traceroute_diagnostic_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/traceroute_diagnostic_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`sensor_not_found` (4049807): Nie znaleziono stacji monitorującej." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe zapytanie diagnostyczne traceroute.", "tags" : [ "system" ] } }, "/system/traceroute_diagnostics/{_id}" : { "delete" : { "description" : "Usuwa zapytanie diagnostyczne traceroute.\n\nMożna użyć tej operacji aby anulować oczekujące zapytanie.", "operationId" : "system_delete_traceroute_diagnostics", "parameters" : [ { "description" : "Identyfikator zapytania.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`traceroute_diagnostics_not_found` (4041430): Nie znaleziono zapytania diagnostycznego traceroute." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa zapytanie diagnostyczne traceroute.", "tags" : [ "system" ] }, "get" : { "description" : "Zwraca pojedyncze zapytanie diagnostyczne traceroute.", "operationId" : "system_read_traceroute_diagnostics", "parameters" : [ { "description" : "Identyfikator zapytania.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "sensor", "sensor.city", "sensor.continent", "sensor.country", "sensor.dns_diagnostics_available", "sensor.id", "sensor.ip_address", "sensor.ipv6_address", "sensor.is_available", "sensor.is_enabled", "sensor.links", "sensor.name", "sensor.service_type_category_ids", "sensor.traceroute_diagnostics_available" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "id", "results", "sensor_id", "settings", "status" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/traceroute_diagnostic" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`traceroute_diagnostics_not_found` (4041430): Nie znaleziono zapytania diagnostycznego traceroute." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze zapytanie diagnostyczne traceroute.", "tags" : [ "system" ] } }, "/templates" : { "get" : { "description" : "Zwraca listę szablonów.\n\n\n\nPole `language.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "templates_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "artifact_type_ids", "end_subject", "end_template", "id", "language_id", "name", "owner_id", "start_subject", "start_template" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "end_subject", "end_template", "id", "language.name", "language_id", "name", "owner.name", "owner.username", "owner_id", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "start_subject", "start_template", "-end_subject", "-end_template", "-id", "-language.name", "-language_id", "-name", "-owner.name", "-owner.username", "-owner_id", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-start_subject", "-start_template" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "end_subject", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_subject!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_subject~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "end_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "end_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "end_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language_id~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_subject", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_subject!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_subject~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "start_template", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "start_template!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "start_template~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "language.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "language.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "language.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "owner.username", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "owner.username!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "owner.username~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_templates" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę szablonów.", "tags" : [ "templates" ] }, "post" : { "description" : "Tworzy nowy szablon.\n\nJeśli nie zostanie określony atrybut `owner_id`, zostanie użyty identyfikator konta wywołującego użytkownika.", "operationId" : "templates_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/template_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/template_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`account_not_found` (4042281): Nie znaleziono konta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowy szablon.", "tags" : [ "templates" ] } }, "/templates/search" : { "post" : { "description" : "Zaawansowane pobieranie szablonów.\n\n\n\nPole `language.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "templates_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/template_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_templates" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie szablonów.", "tags" : [ "templates" ] } }, "/templates/{_id}" : { "delete" : { "description" : "Usuwa szablon.", "operationId" : "templates_delete", "parameters" : [ { "description" : "Identyfikator szablonu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`template_not_found` (4040118): Nie znaleziono szablonu." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa szablon.", "tags" : [ "templates" ] }, "get" : { "description" : "Zwraca pojedynczy szablon.\n\n\n\nPole `language.name` wyniku może przyjmować różne wartości w zależności od nagłówka `Accept-Language`.", "operationId" : "templates_read", "parameters" : [ { "description" : "Identyfikator szablonu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "artifact_type_ids", "end_subject", "end_template", "id", "language_id", "name", "owner_id", "start_subject", "start_template" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/template" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`template_not_found` (4040118): Nie znaleziono szablonu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedynczy szablon.", "tags" : [ "templates" ] }, "put" : { "description" : "Modyfikuje szablon.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `owner_id`.", "operationId" : "templates_update", "parameters" : [ { "description" : "Identyfikator szablonu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/template" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`template_not_found` (4040118): Nie znaleziono szablonu." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje szablon.", "tags" : [ "templates" ] } }, "/templates/{_id}/owner" : { "get" : { "description" : "Zwraca konto, do którego należy wybrany szablon.", "operationId" : "templates_read_owner", "parameters" : [ { "description" : "Identyfikator szablonu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "language", "language.description", "language.id", "language.name", "package", "package.available_notification_channel_ids", "package.available_service_types", "package.can_force_custom_analyses", "package.id", "package.is_available_for_new_accounts", "package.maximum_sensors", "package.maximum_services", "package.maximum_sms_numbers", "package.minimum_interval", "package.monthly_reports_limit", "package.name", "parent_account", "parent_account.disable_legacy_notifications", "parent_account.id", "parent_account.is_activated", "parent_account.is_blocked", "parent_account.is_read_only", "parent_account.language_id", "parent_account.name", "parent_account.package_id", "parent_account.parent_account_id", "parent_account.time_zone_id", "parent_account.username", "permissions", "permissions.close", "permissions.create_contact_groups", "permissions.create_contacts", "permissions.create_customer_portal_sessions", "permissions.create_events", "permissions.create_groups", "permissions.create_report_templates", "permissions.create_subaccounts", "permissions.create_templates", "permissions.delete", "permissions.own", "permissions.read", "permissions.read_logs", "permissions.read_stats", "permissions.setup_2fa", "permissions.share_groups", "permissions.update", "time_zone", "time_zone.description", "time_zone.id", "time_zone.name", "user_data", "user_data.address", "user_data.contact_person", "user_data.created_at", "user_data.email_address", "user_data.has_2fa_enabled", "user_data.id", "user_data.ip_whitelist", "user_data.ip_whitelist_enabled", "user_data.phone_number", "user_data.settings", "user_data.tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "disable_legacy_notifications", "id", "is_activated", "is_blocked", "is_read_only", "language_id", "name", "package_id", "parent_account_id", "time_zone_id", "username" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/account" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_not_found` (4042281): Nie znaleziono konta.\n* `template_not_found` (4040118): Nie znaleziono szablonu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca konto, do którego należy wybrany szablon.", "tags" : [ "accounts", "templates" ] } }, "/templates/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego szablonu.", "operationId" : "templates_read_permissions", "parameters" : [ { "description" : "Identyfikator szablonu.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `template_not_found` (4040118): Nie znaleziono szablonu." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego szablonu.", "tags" : [ "permissions", "templates" ] } }, "/user_data/{_id}" : { "get" : { "description" : "Zwraca dane wybranego użytkownika.\n\nIdentyfikator użytkownika jest jednocześnie identyfikatorem konta, którego właścicielem jest użytkownik.\n\nMożliwe jest użycie specjalnej wartości \"my_user_data\" zamiast identyfikatora, aby wybrać własne dane.", "operationId" : "user_data_read", "parameters" : [ { "description" : "Identyfikator użytkownika (konta).", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "contact_person", "created_at", "email_address", "has_2fa_enabled", "id", "ip_whitelist", "ip_whitelist_enabled", "phone_number", "settings", "tax_identification_number" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/user_data" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`user_data_not_found` (4041072): Nie znaleziono danych klienta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca dane wybranego użytkownika.", "tags" : [ "user_data" ] }, "put" : { "description" : "Uaktualnia dane wybranego użytkownika.\n\nIdentyfikator użytkownika jest jednocześnie identyfikatorem konta, którego właścicielem jest użytkownik.\n\nMożliwe jest użycie specjalnej wartości \"my_user_data\" zamiast identyfikatora, aby wybrać własne dane.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `created_at`, `has_2fa_enabled`, `id` oraz `settings`.", "operationId" : "user_data_update", "parameters" : [ { "description" : "Identyfikator użytkownika (konta).", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/user_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`user_data_not_found` (4041072): Nie znaleziono danych klienta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_datetime` (4228856): Niepoprawny czas.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `pattern_match_failed` (4223562): Wartość nie pasuje do określonego wzorca.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `string_too_short` (4229810): Wartość jest zbyt krótka." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Uaktualnia dane wybranego użytkownika.", "tags" : [ "user_data" ] } }, "/user_data/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do danych wybranego użytkownika.\n\nIdentyfikator użytkownika jest jednocześnie identyfikatorem konta, którego właścicielem jest użytkownik.\n\nMożliwe jest użycie specjalnej wartości \"my_user_data\" zamiast identyfikatora, aby wybrać własne dane.", "operationId" : "user_data_read_permissions", "parameters" : [ { "description" : "Identyfikator użytkownika (konta).", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `user_data_not_found` (4041072): Nie znaleziono danych klienta." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do danych wybranego użytkownika.", "tags" : [ "permissions", "user_data" ] } }, "/user_data/{_id}/settings/{_key}" : { "delete" : { "description" : "Usuwa wybrane ustawienie użytkownika.\n\nIdentyfikator użytkownika jest jednocześnie identyfikatorem konta, którego właścicielem jest użytkownik.\n\nMożliwe jest użycie specjalnej wartości \"my_user_data\" zamiast identyfikatora, aby wybrać własne dane.", "operationId" : "user_data_delete_setting", "parameters" : [ { "description" : "Identyfikator użytkownika.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator ustawienia.", "in" : "path", "name" : "_key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `user_data_not_found` (4041072): Nie znaleziono danych klienta.\n* `user_setting_not_found` (4047924): Nie znaleziono ustawienia konta." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa wybrane ustawienie użytkownika.", "tags" : [ "user_data" ] }, "get" : { "description" : "Zwraca wartość wybranego ustawienia użytkownika.\n\nIdentyfikator użytkownika jest jednocześnie identyfikatorem konta, którego właścicielem jest użytkownik.\n\nMożliwe jest użycie specjalnej wartości \"my_user_data\" zamiast identyfikatora, aby wybrać własne dane.", "operationId" : "user_data_read_setting", "parameters" : [ { "description" : "Identyfikator użytkownika.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator ustawienia.", "in" : "path", "name" : "_key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/any" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `user_data_not_found` (4041072): Nie znaleziono danych klienta.\n* `user_setting_not_found` (4047924): Nie znaleziono ustawienia konta." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca wartość wybranego ustawienia użytkownika.", "tags" : [ "user_data" ] }, "put" : { "description" : "Aktualizuje lub tworzy wartość wybranego ustawienia użytkownika.\n\nIdentyfikator użytkownika jest jednocześnie identyfikatorem konta, którego właścicielem jest użytkownik.\n\nMożliwe jest użycie specjalnej wartości \"my_user_data\" zamiast identyfikatora, aby wybrać własne dane.\n\nMaksymalny rozmiar ustawienia po zserializowaniu do formatu JSON bez dodatkowych białych znaków: 1MB.\n\nMaksymalna liczba ustawień dla jednego użytkownika: 64.", "operationId" : "user_data_update_setting", "parameters" : [ { "description" : "Identyfikator użytkownika.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Identyfikator ustawienia.", "in" : "path", "name" : "_key", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/any" } } }, "description" : "Dowolna wartość." }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `replace_not_allowed` (4035613): Brak uprawnień do modyfikacji lub utworzenia obiektu.\n* `user_settings_limit_reached` (4037312): Osiągnięto limit liczby ustawień konta." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`user_data_not_found` (4041072): Nie znaleziono danych klienta." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `user_setting_too_large` (4223383): Zakodowana wartość ustawienia konta jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Aktualizuje lub tworzy wartość wybranego ustawienia użytkownika.", "tags" : [ "user_data" ] } }, "/weekly_suspensions" : { "get" : { "description" : "Zwraca listę tygodniowych zawieszeń.", "operationId" : "weekly_suspensions_read_all", "parameters" : [ { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "id", "only_notifications", "service_id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Maksymalna zwrócona liczba wyników.", "in" : "query", "name" : "limit", "required" : false, "schema" : { "default" : 10, "maximum" : 1000, "minimum" : 0, "type" : "integer" } }, { "description" : "Liczba początkowych wyników, które należy pominąć.", "in" : "query", "name" : "offset", "required" : false, "schema" : { "default" : 0, "minimum" : 0, "type" : "integer" } }, { "description" : "Wyszukiwana fraza (\"inteligentne wyszukiwanie\").", "in" : "query", "name" : "query", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Pola, po których należy posortować wyniki. Minus przed nazwą pola oznacza porządek malejący.", "explode" : false, "in" : "query", "name" : "sort", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "id", "only_notifications", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.owner_id", "service_id", "start_minute", "-description", "-end_minute", "-id", "-only_notifications", "-permissions.delete", "-permissions.own", "-permissions.read", "-permissions.update", "-service.id", "-service.interval", "-service.is_active", "-service.is_archived", "-service.name", "-service.owner_id", "-service_id", "-start_minute" ], "type" : "string" }, "maxItems" : 256, "type" : "array" }, "style" : "form" }, { "description" : "Filtr.", "in" : "query", "name" : "description", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "description!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "description~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "only_notifications", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "only_notifications!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.delete", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.delete!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.own", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.own!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.read", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.read!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "permissions.update", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "permissions.update!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.interval", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.interval!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_active", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_active!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.is_archived", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.is_archived!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.name", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.name!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Dopasowanie.", "in" : "query", "name" : "service.name~", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr.", "in" : "query", "name" : "service.owner_id", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "description" : "Filtr wykluczający.", "in" : "query", "name" : "service.owner_id!", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_weekly_suspensions" } } }, "description" : "Poprawne pobranie zasobu", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca listę tygodniowych zawieszeń.", "tags" : [ "suspensions", "service_suspensions" ] }, "post" : { "description" : "Tworzy nowe tygodniowe zawieszenie.", "operationId" : "weekly_suspensions_create", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/weekly_suspension_create_data" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/weekly_suspension_create_result" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "Location" : { "description" : "Adres URL utworzonego obiektu.", "schema" : { "type" : "string" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `create_not_allowed` (4035566): Brak uprawnień do utworzenia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`service_not_found` (4046121): Nie znaleziono usługi." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Tworzy nowe tygodniowe zawieszenie.", "tags" : [ "suspensions", "service_suspensions" ] } }, "/weekly_suspensions/search" : { "post" : { "description" : "Zaawansowane pobieranie tygodniowych zawieszeń.", "operationId" : "weekly_suspensions_search", "parameters" : [], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/weekly_suspension_search" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/array_of_weekly_suspensions" } } }, "description" : "Poprawne wykonanie operacji", "headers" : { "X-Total-Count" : { "description" : "Całkowita liczba znalezionych obiektów (bez uwzględnienia parametrów limit i offset)", "schema" : { "minimum" : 0, "type" : "integer" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `array_too_long` (4227497): Tablica jest zbyt długa.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zaawansowane pobieranie tygodniowych zawieszeń.", "tags" : [ "suspensions", "service_suspensions" ] } }, "/weekly_suspensions/{_id}" : { "delete" : { "description" : "Usuwa tygodniowe zawieszenie.", "operationId" : "weekly_suspensions_delete", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "Poprawne usunięcie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `delete_not_allowed` (4037374): Brak uprawnień do usunięcia obiektu.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`weekly_suspension_not_found` (4040832): Nie znaleziono zawieszenia tygodniowego." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Usuwa tygodniowe zawieszenie.", "tags" : [ "suspensions", "service_suspensions" ] }, "get" : { "description" : "Zwraca pojedyncze tygodniowe zawieszenie.", "operationId" : "weekly_suspensions_read", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "permissions", "permissions.delete", "permissions.own", "permissions.read", "permissions.update", "service", "service.address", "service.description", "service.extended_settings", "service.group_id", "service.id", "service.interval", "service.is_active", "service.is_archived", "service.name", "service.notification_channel_ids", "service.notification_condition_ids", "service.notification_mode_id", "service.owner_id", "service.recovery_notification_mode_id", "service.sensor_ids", "service.silent_hours", "service.step_names", "service.suspension_hours", "service.type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "description", "end_minute", "id", "only_notifications", "service_id", "start_minute" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/weekly_suspension" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`weekly_suspension_not_found` (4040832): Nie znaleziono zawieszenia tygodniowego." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca pojedyncze tygodniowe zawieszenie.", "tags" : [ "suspensions", "service_suspensions" ] }, "put" : { "description" : "Modyfikuje tygodniowe zawieszenie.\n\nZa pomocą tej operacji nie można zmienić wartości atrybutów `id` oraz `service_id`.", "operationId" : "weekly_suspensions_update", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/weekly_suspension" } } }, "description" : "Treść zapytania HTTP" }, "responses" : { "204" : { "description" : "Poprawna aktualizacja zasobu", "headers" : {} }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`incorrect_json` (4009800): Treść zapytania HTTP nie jest poprawnym dokumentem JSON." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)\n* `update_not_allowed` (4037895): Brak uprawnień do modyfikacji obiektu." }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`weekly_suspension_not_found` (4040832): Nie znaleziono zawieszenia tygodniowego." }, "415" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`unsupported_media_type` (4150866): Typ zawartości (nagłówek Content-Type) jest inny niż application/json." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `field_is_immutable` (4227047): Zmiana wartości pola nie jest dozwolona.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `number_too_high` (4222069): Wartość jest zbyt wysoka.\n* `number_too_low` (4226249): Wartość jest zbyt niska.\n* `required_property_missing` (4228630): Nie określono wymaganego atrybutu obiektu.\n* `string_too_long` (4228247): Wartość jest zbyt długa." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Modyfikuje tygodniowe zawieszenie.", "tags" : [ "suspensions", "service_suspensions" ] } }, "/weekly_suspensions/{_id}/permissions" : { "get" : { "description" : "Zwraca uprawnienia do wybranego zawieszenia.", "operationId" : "weekly_suspensions_read_permissions", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "delete", "own", "read", "update" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/permission" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `not_found` (4048233): Nie znaleziono zasobu.\n* `weekly_suspension_not_found` (4040832): Nie znaleziono zawieszenia tygodniowego." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca uprawnienia do wybranego zawieszenia.", "tags" : [ "suspensions", "service_suspensions" ] } }, "/weekly_suspensions/{_id}/service" : { "get" : { "description" : "Zwraca usługę, której dotyczy wybrane tygodniowe zawieszenie.", "operationId" : "weekly_suspensions_read_service", "parameters" : [ { "description" : "Identyfikator tygodniowego zawieszenia.", "in" : "path", "name" : "_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Powiązane obiekty i/lub ich pola, które należy dołączyć do wyników.", "explode" : false, "in" : "query", "name" : "embed", "required" : false, "schema" : { "items" : { "enum" : [ "extended_setting_formats", "extended_setting_formats.default", "extended_setting_formats.description", "extended_setting_formats.enum", "extended_setting_formats.is_hidden", "extended_setting_formats.is_nullable", "extended_setting_formats.json_schema", "extended_setting_formats.maximum", "extended_setting_formats.maximum_length", "extended_setting_formats.minimum", "extended_setting_formats.minimum_length", "extended_setting_formats.pattern", "extended_setting_formats.pattern_error_message", "extended_setting_formats.service_type_id", "extended_setting_formats.setting_id", "extended_setting_formats.suggested_form_element", "extended_setting_formats.type", "group", "group.archived_services_in_periodic_reports", "group.assigned_sensor_ids", "group.id", "group.is_default", "group.name", "group.owner_id", "group.periodic_daily_reports", "group.periodic_monthly_reports", "group.periodic_weekly_reports", "group.sensor_ids", "monitoring_sensors", "monitoring_sensors.city", "monitoring_sensors.continent", "monitoring_sensors.country", "monitoring_sensors.dns_diagnostics_available", "monitoring_sensors.id", "monitoring_sensors.ip_address", "monitoring_sensors.ipv6_address", "monitoring_sensors.is_available", "monitoring_sensors.is_enabled", "monitoring_sensors.links", "monitoring_sensors.name", "monitoring_sensors.service_type_category_ids", "monitoring_sensors.traceroute_diagnostics_available", "notification_channels", "notification_channels.description", "notification_channels.id", "notification_channels.name", "notification_conditions", "notification_conditions.description", "notification_conditions.id", "notification_conditions.name", "notification_mode", "notification_mode.description", "notification_mode.id", "notification_mode.name", "owner", "owner.disable_legacy_notifications", "owner.id", "owner.is_activated", "owner.is_blocked", "owner.is_read_only", "owner.language_id", "owner.name", "owner.package_id", "owner.parent_account_id", "owner.time_zone_id", "owner.username", "permissions", "permissions.archive", "permissions.create_corrections", "permissions.create_scheduled_suspensions", "permissions.create_suspensions", "permissions.create_weekly_suspensions", "permissions.delete", "permissions.force_analyses", "permissions.force_custom_analyses", "permissions.own", "permissions.read", "permissions.restore", "permissions.send_test_sms_notifications", "permissions.update", "permissions.update_step_names", "recovery_notification_mode", "recovery_notification_mode.description", "recovery_notification_mode.id", "recovery_notification_mode.name", "sensors", "sensors.city", "sensors.continent", "sensors.country", "sensors.dns_diagnostics_available", "sensors.id", "sensors.ip_address", "sensors.ipv6_address", "sensors.is_available", "sensors.is_enabled", "sensors.links", "sensors.name", "sensors.service_type_category_ids", "sensors.traceroute_diagnostics_available", "status", "status.average_response_time", "status.check_status", "status.check_status_is_up_to_date", "status.highest_active_event_priority", "status.id", "status.last_analysis_id", "status.last_analysis_time", "status.last_check_status_change_time", "status.last_failure_analysis_id", "status.last_failure_analysis_time", "status.last_ok_analysis_id", "status.last_ok_analysis_time", "status.monitoring_status", "status.notifications_status", "status.summary", "type", "type.address_prefix", "type.category_id", "type.customizable_step_names", "type.description", "type.id", "type.manual_schedule", "type.name", "type.step_names" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" }, { "description" : "Tablica pól, które należy zwrócić.", "explode" : false, "in" : "query", "name" : "fields", "required" : false, "schema" : { "items" : { "enum" : [ "address", "description", "extended_settings", "group_id", "id", "interval", "is_active", "is_archived", "name", "notification_channel_ids", "notification_condition_ids", "notification_mode_id", "owner_id", "recovery_notification_mode_id", "sensor_ids", "silent_hours", "step_names", "suspension_hours", "type_id" ], "type" : "string" }, "type" : "array", "uniqueItems" : true }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/service" } } }, "description" : "Poprawne pobranie zasobu", "headers" : {} }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `authentication_required` (4018991): Wymagane zalogowanie.\n* `incorrect_authentication_data` (4017121): Niepoprawna nazwa użytkownika lub hasło lub konto ma skonfigurowane 2FA.\n* `incorrect_session_token` (4017913): Niepoprawny token sesji.\n* `session_expired` (4012787): Sesja wygasła.", "headers" : { "WWW-Authenticate" : { "description" : "Sposób autoryzacji", "schema" : { "type" : "string" } } } }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `account_blocked` (4033969): Konto zablokowane.\n* `account_not_activated` (4037388): Konto nie zostało jeszcze aktywowane.\n* `invalid_authorization_scope` (4035520): Brak wymaganych uprawnień (np. próba wywołania operacji administracyjnej jako użytkownik)" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `service_not_found` (4046121): Nie znaleziono usługi.\n* `weekly_suspension_not_found` (4040832): Nie znaleziono zawieszenia tygodniowego." }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "* `array_item_not_unique` (4227042): Element tablicy nie jest unikalny.\n* `incorrect_type` (4220555): Niepoprawny typ wartości.\n* `incorrect_value` (4222064): Niepoprawna wartość.\n* `unexpected_property` (4221987): Obiekt zawiera niedozwolony atrybut." }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/api_error_response" } } }, "description" : "`system_error` (5002317): Wewnętrzny błąd API. Jeśli będzie się powtarzał, skontaktuj się z Biurem Obsługi Klienta." } }, "security" : [ { "basic_auth" : [] }, { "oauth2" : [ "customer" ] } ], "summary" : "Zwraca usługę, której dotyczy wybrane tygodniowe zawieszenie.", "tags" : [ "services", "suspensions", "service_suspensions" ] } } }, "servers" : [ { "url" : "https://api.monit24.pl/v3" } ], "tags" : [ { "description" : "Konta użytkowników", "name" : "accounts" }, { "description" : "API administracyjne", "name" : "admin" }, { "description" : "Logowanie, wylogowanie, informacje o sesji (stara wersja)", "name" : "auth_token" }, { "description" : "Dane do wykresów szybkości działania i dostępności", "name" : "charts" }, { "description" : "Adresy kontaktowe", "name" : "contact_addresses" }, { "description" : "Grupy kontaktów", "name" : "contact_groups" }, { "description" : "Zawieszenia kontaktów", "name" : "contact_suspensions" }, { "description" : "Kontakty", "name" : "contacts" }, { "description" : "Korekty Service Level", "name" : "corrections" }, { "description" : "Operacje do usunięcia w nadchodzącej wersji API", "name" : "deprecated" }, { "description" : "Wartości słownikowe", "name" : "dictionaries" }, { "description" : "Typy błędów monitoringu", "name" : "error_types" }, { "description" : "Zawieszenia eskalacji", "name" : "escalation_suspensions" }, { "description" : "Eskalacje powiadomień", "name" : "escalations" }, { "description" : "Zdarzenia obserwowane przez eskalacje", "name" : "events" }, { "description" : "Statystyki grup", "name" : "group_stats" }, { "description" : "Grupy usług", "name" : "groups" }, { "description" : "Historia monitoringu usług", "name" : "history" }, { "description" : "Logi zdarzeń dla konta", "name" : "logs" }, { "description" : "Powiadomienia push dla aplikacji mobilnej", "name" : "mobile" }, { "description" : "Adresy powiadomień", "name" : "notification_addresses" }, { "description" : "Pakiety", "name" : "packages" }, { "description" : "Raporty okresowe", "name" : "periodic_report_addresses" }, { "description" : "Uprawnienia wywołującego użytkownika", "name" : "permissions" }, { "description" : "Szablony raportów", "name" : "report_templates" }, { "description" : "Raporty", "name" : "reports" }, { "description" : "Stacje monitorujące", "name" : "sensors" }, { "description" : "Statusy działania usług", "name" : "service_statuses" }, { "description" : "Zaplanowane zawieszenia usług (stara wersja, przeniesione do `suspensions`)", "name" : "service_suspensions" }, { "description" : "Dostępne typy usług", "name" : "service_types" }, { "description" : "Usługi", "name" : "services" }, { "description" : "Sesje API", "name" : "sessions" }, { "description" : "Zaplanowane zawieszenia monitoringu i powiadomień", "name" : "suspensions" }, { "description" : "Narzędzia diagnostyczne i statystyki systemowe", "name" : "system" }, { "description" : "Własne szablony powiadomień o zdarzeniach", "name" : "templates" }, { "description" : "Prywatne dane użytkowników", "name" : "user_data" } ] }