Obiekt makra użytkownika

Następujące obiekty są bezpośrednio powiązane z API usermacro.

Makro globalne

Obiekt makra globalnego ma następujące właściwości.

Właściwość Typ Opis
globalmacroid ID ID makra globalnego.

Zachowanie właściwości:
- tylko do odczytu
- wymagane dla operacji aktualizacji
description string Opis makra.
macro string Ciąg makra.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
type integer Typ makra.

Możliwe wartości:
0 - (domyślnie) Makro tekstowe;
1 - Makro sekretne;
2 - Sekret Vault.
value string Wartość makra.

Zachowanie właściwości:
- tylko do zapisu, jeśli type jest ustawione na „Makro sekretne”
- wymagane dla operacji tworzenia

Makro hosta

Obiekt makra hosta definiuje makro dostępne na hoście, prototypie hosta lub szablonie. Ma następujące właściwości.

Właściwość Typ Opis
hostmacroid ID ID makra.

Zachowanie właściwości:
- tylko do odczytu
- wymagane dla operacji aktualizacji
automatic integer Określa, czy makro jest kontrolowane przez regułę wykrywania.

Możliwe wartości:
0 - (domyślnie) Makro jest zarządzane przez użytkownika;
1 - Makro jest zarządzane przez regułę wykrywania.

Użytkownik nie może tworzyć automatycznego makra.
Aby zaktualizować automatyczne makro, musi ono zostać przekształcone na ręczne.
config object/array Konfiguracja makra odpowiedzialna za sposób wyświetlania makra w Kreatorze hosta.
description string Opis makra.
hostid ID ID hosta, prototypu hosta lub szablonu, do którego należy makro.

Zachowanie właściwości:
- stała
- wymagane dla operacji tworzenia
macro string Ciąg makra.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
type integer Typ makra.

Możliwe wartości:
0 - (domyślnie) Makro tekstowe;
1 - Makro tajne;
2 - Sekret z magazynu.
value string Wartość makra.

Zachowanie właściwości:
- tylko do zapisu, jeśli type jest ustawione na „Makro tajne”
- wymagane dla operacji tworzenia

Konfiguracja makr

Obiekt konfiguracji makr definiuje sposób wyświetlania makra w Kreatorze hosta.

Właściwość Typ Opis
type integer Typ pola wejściowego makra.

Możliwe wartości:
0 - Makro nie jest używane w Kreatorze hosta;
1 - Pole tekstowe;
2 - Lista;
3 - Pole wyboru.

Zachowanie właściwości:
- wymagane
label string Etykieta pola wejściowego makra.

Zachowanie właściwości:
- wymagane, jeśli type jest ustawione na „Pole tekstowe”, „Lista” lub „Pole wyboru”
description text Tekst pomocy wyświetlany obok pola wejściowego makra. Obsługuje formatowanie Markdown.
priority integer Pozycja pola wejściowego makra na liście makr.

Jeśli priority nie jest ustawione, makro jest dodawane na końcu listy niepogrupowanych makr.
required integer Oznacza makro jako obowiązkowe.

Możliwe wartości:
0 - Nieobowiązkowe;
1 - Obowiązkowe.

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na „Pole tekstowe” lub „Lista”
regex string Wyrażenie regularne służące do walidacji danych wejściowych użytkownika w polu tekstowym.

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na „Pole tekstowe”
section_name string Etykieta zwijanej sekcji, w której makro jest grupowane.

Jeśli section_name nie jest ustawione, makro nie jest grupowane. Niepogrupowane makra są wyświetlane jako pierwsze; pogrupowane makra są wyświetlane poniżej, uporządkowane według ich priority w obrębie każdej zwijanej sekcji.
options text Ciąg JSON definiujący elementy listy lub wartości pola wyboru.

Dla list: tablica obiektów z właściwościami value i text.
Przykład: [{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]

Dla pól wyboru: obiekt z właściwościami checked i unchecked.
Przykład: {"checked": true, "unchecked": false}

Zachowanie właściwości:
- wymagane, jeśli type jest ustawione na „Lista” lub „Pole wyboru”