Powershell: Ninja-Property-Docs-Optionen

Thema

In diesem Artikel wird erläutert, wie Sie mit den Ninja-Property-Docs-Optionengültige Werte für ein Dropdown- oder Mehrfachauswahl-Benutzerdefiniertes Feld in einem Dokument abrufen können.

Wenn Sie das NinjaOne-PowerShell-Modul außerhalb eines Automatisierungsskripts verwenden, müssen Sie möglicherweise die Ausführungsrichtlinie von PowerShell anpassen. Weitere Informationen zu Ausführungsrichtlinien finden Sie in der Dokumentation von Microsoft: Über Ausführungsrichtlinien ( externer Link).

Umgebung

NinjaOne
Microsoft PowerShell

Beschreibung

Dieses Cmdlet ruft gültige Werte für ein benutzerdefiniertes Dropdown- oder Mehrfachauswahlfeld in einem Dokument ab. Sie können den Feldnamen mit dem Parameter -AttributeName, das Dokument mit dem Parameter -DocumentName und die Dokumentvorlage mit dem Parameter -TemplateId angeben. Das Cmdlet gibt eine Liste gültiger Optionen im Format <guid>=<name> zurück, wobei <guid> die eindeutige Kennung der Option und <name> der Anzeigename der Option ist. Nur für Dokumentfelder mit Lesezugriffsrechten für die Automatisierung können die Optionen mithilfe dieses Cmdlets abgerufen werden.

Syntax

Ninja-Property-Docs-Options [[-TemplateId] <Object>] [[-DocumentName] <Object>] [[AttributeName] <Object>] [<CommonParameters>]

Beispiele

Beispiel 1: Ein benutzerdefiniertes Dropdown-Feld

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "Mein
Beispieldokument" -AttributeName "exampleDropdown"
09d9ef8e-3cdf-4fb2-baf6-9b78b46643a9=Beispieloption 3
1ff0944e-2bc8-4681-909b-688e77db1cae=Beispieloption 2
61010919-654f-4448-ba15-48a160d42f44=简体中文
bd182518-e0ca-4a50-9afb-f9542c1e7d08=Mötley Crüe
c2444bd4-2e75-4acf-944d-b73afd66b27f=Beispiel Option 1

Wenn ein benutzerdefiniertes Dropdown-Feld angegeben wird, gibt das Cmdlet die gültigen Optionen für das Dropdown-Feld „
“ im Format <guid>=<name> zurück, wobei <guid> die eindeutige Kennung für die Option „
“ und <name> der Anzeigename der Option ist.

Beispiel 2: Ein benutzerdefiniertes Feld mit Mehrfachauswahl

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "Mein
Beispieldokument" -AttributeName "exampleMultiSelect"
1e6bcc4a-0272-414e-a77c-4109ef79f86e=Option 1
3e08d167-e830-41e7-ae8f-1128e22b00a9=Option 3
4f4f73ba-0d69-4518-a78b-9ca554471b8e=Option 2
680e655d-0b66-4dba-a96e-dcee77ddd1e4=Vereinfachtes Chinesisch

Wenn ein benutzerdefiniertes Feld mit Mehrfachauswahl angegeben wird, gibt das Cmdlet die gültigen Optionen für das Feld „
“ (Mehrfachauswahl) im Format <guid>=<name> zurück, wobei <guid> die eindeutige Kennung für die Option „
“ und <name> der Anzeigename der Option ist.

Beispiel 3: Ein benutzerdefiniertes Feld ohne Optionen

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "My
Example Document" -AttributeName "exampleTextField"

Wenn ein benutzerdefiniertes Feld ohne Optionen, wie z. B. ein Textfeld, angegeben wird, gibt das Cmdlet keine Ausgabe zurück.

Parameter

-AttributeName

Geben Sie den Namen des benutzerdefinierten Felds an, für das Sie gültige Optionen abrufen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: False
Position: 2
Standardwert: Keine
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

-DocumentName

Geben Sie den Namen des Dokuments an, das das benutzerdefinierte Feld enthält, für das Sie gültige Optionen abrufen möchten
.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: False
Position: 1
Standardwert: Keine
Pipeline-Eingabe zulassen: False
Platzhalterzeichen zulassen: False

-TemplateId

Geben Sie den Namen der Dokumentvorlage an, die das benutzerdefinierte Feld enthält, für das Sie gültige Optionen unter
abrufen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: Falsch
Position: 0
Standardwert: Keine
Pipeline-Eingabe zulassen: Falsch
Platzhalterzeichen zulassen: Falsch

Eingaben

System.String

Das Cmdlet akzeptiert keine Eingaben aus der Pipeline. Die Parameter -TemplateId, -DocumentName und -AttributeName akzeptieren Zeichenfolgenwerte, die jeweils die ID der Dokumentvorlage, den Namen des Dokuments und den Namen des benutzerdefinierten Feldes darstellen, für die Sie gültige Optionen abrufen möchten.

Ausgaben

System.String[]

Das Cmdlet gibt die gültigen Optionen für das angegebene benutzerdefinierte Feld im angegebenen Dokument im Format <guid>=<name> als Zeichenfolge oder als Array von Zeichenfolgen zurück, falls mehr als eine Option verfügbar ist.

Dieses Cmdlet gilt nur für benutzerdefinierte Dropdown- und Mehrfachauswahlfelder. Wenn ein anderer
Typ eines benutzerdefinierten Feldes angegeben wird, wird keine Ausgabe zurückgegeben.
Nur für Dokumentfelder mit Lesezugriffsrechten für die Automatisierung können die Optionen mit diesem Cmdlet abgerufen werden. Informationen zu Berechtigungen für benutzerdefinierte Felder finden Sie unter „NinjaOne Custom Fields: Getting Started“.

Weitere Ressourcen

Weitere Informationen zum Asset-Management und zu benutzerdefinierten Skripten finden Sie in den folgenden Ressourcen: