Powershell: Ninja-Property-Docs-Get

Thema

In diesem Artikel wird erläutert, wie Sie mit „Ninja-Property-Docs-Get“ den Wert eines bestimmten benutzerdefinierten Feldes in einem Dokument abrufen können.

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

Umgebung

NinjaOne
Microsoft Powershell

Beschreibung

Das Cmdlet „Ninja-Property-Docs-Get“ ruft den Wert eines angegebenen benutzerdefinierten Feldes 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 den aktuellen Wert des benutzerdefinierten Feldes im angegebenen Dokument zurück.

Syntax

Ninja-Property-Docs-Get [[-TemplateId] <OBJECT>] [[-DocumentName] <OBJECT>] [[-AttributeName]<OBJECT>] [<COMMONPARAMETERS>]

Beispiel

Einen Wert von einem Dokument abrufen

PS C:> Ninja-Property-Docs-Get -TemplateId "12345" -DocumentName "My
Beispiel-Dokument" -AttributeName "exampleAttribute"
Zeile 1
Zeile 3

Der Wert des benutzerdefinierten Felds „exampleAttribute“ im Dokument „Mein Beispieldokument“ wird abgerufen und in der Ausgabe angezeigt. In diesem Beispiel enthält das benutzerdefinierte Feld mehrere Textzeilen.

Parameter

-AttributeName

Geben Sie den Namen des benutzerdefinierten Feldes an, das Sie aus dem Dokument abrufen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: Falsch
Position: 2
Standardwert: Kein(e)
Pipeline-Eingabe akzeptieren: Falsch
Platzhalterzeichen akzeptieren: Falsch

-DocumentName

Geben Sie den Namen des Dokuments an, das das benutzerdefinierte Feld enthält, das Sie abrufen möchten.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: Falsch
Position: 1
Standardwert: Keiner
Pipeline-Eingabe akzeptieren: Falsch
Platzhalterzeichen akzeptieren: Falsch

-TemplateId

Geben Sie die ID der Dokumentvorlage an, die das Dokument und das Benutzerdefinierte Feld enthält, die „
“ abrufen soll.

Typ: Objekt
Parametersätze: (Alle)
Aliase:
Erforderlich: False
Position: 0
Standardwert: Kein(e)
Pipeline-Eingabe akzeptieren: False
Platzhalterzeichen akzeptieren: False

Eingaben

System.String

Dieses Cmdlet akzeptiert keine Eingaben aus der Pipeline. Die Parameter -AttributeName, -DocumentName und -TemplateId akzeptieren Zeichenfolgenwerte, die jeweils den Namen des abzurufenden benutzerdefinierten Felds, den Dokumentnamen und die ID der Dokumentvorlage darstellen.

Ausgaben

System.String[]

Das Cmdlet gibt den Wert des angegebenen benutzerdefinierten Feldes im angegebenen Dokument als Zeichenfolge vom Typ „
“ oder als Array von Zeichenfolgen zurück, falls mehr als eine Zeile vorhanden ist.

Mit diesem Cmdlet können nur Dokumentfelder abgerufen werden, für die Lesezugriffsrechte für die Automatisierung bestehen. Informationen zu Berechtigungen für benutzerdefinierte Felder finden Sie unter „NinjaOne Custom Fields: Erste Schritte“.

Zusätzliche Ressourcen

Weitere Informationen zur Asset-Verwaltung und zu benutzerdefinierten Skripten finden Sie in den folgenden Ressourcen: