PowerShell : Ninja-Property-Docs-Options

Rubrique

Cet article explique comment utiliser les options Ninja-Property-Docspour récupérer les valeurs valides d'un champ personnalisé de type liste déroulante ou sélection multiple dans un document.

Si vous utilisez le module PowerShell NinjaOne en dehors d’un script d’automatisation, vous devrez peut-être ajuster la politique d’exécution de PowerShell. Pour plus d’informations sur les politiques d’exécution, consultez la documentation de Microsoft : À propos des politiques d’exécution ( lien externe).

Environnement

NinjaOne
Microsoft PowerShell

Description

Cette cmdlet récupère les valeurs valides d'un champ personnalisé de type liste déroulante ou sélection multiple dans un document. Vous pouvez spécifier le nom du champ à l'aide du paramètre -AttributeName, le document à l'aide du paramètre -DocumentName et le modèle de document à l'aide du paramètre -TemplateId. La cmdlet renvoie une liste d’options valides au format <GUID>=<NAME>, où <GUID> est l’identifiant unique de l’option et <NAME> est le nom affiché de l’option. Seuls les champs du document disposant d’autorisations de lecture pour l’automatisation permettent de récupérer leurs options à l’aide de cette cmdlet.

Syntaxe

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

Exemples

Exemple 1 : un champ personnalisé de type liste déroulante

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "Mon
document d'exemple" -AttributeName "exampleDropdown"
09d9ef8e-3cdf-4fb2-baf6-9b78b46643a9=Option d'exemple 3
1ff0944e-2bc8-4681-909b-688e77db1cae=Exemple d'Option 2
61010919-654f-4448-ba15-48a160d42f44=Chinois simplifié
bd182518-e0ca-4a50-9afb-f9542c1e7d08=Mötley Crüe
c2444bd4-2e75-4acf-944d-b73afd66b27f=Exemple d'Option 1

Lorsqu'un champ personnalisé de type liste déroulante est spécifié, la cmdlet renvoie les options valides pour le champ de liste déroulante
au format <GUID>=<NAME>, où <GUID> est l'identifiant unique de l'option
et <NAME> est le Nom affiché de l'option.

Exemple 2 : un champ personnalisé à sélection multiple

PS C:> Ninja-Property-Docs-Options -TemplateId "5" -DocumentName "Mon
exemple de document" -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=Chinois simplifié

Lorsqu’un champ personnalisé à sélection multiple est spécifié, la cmdlet renvoie les options valides pour le champ à sélection multiple
au format <GUID>=<NAME>, où <GUID> est l’identifiant unique de l’option
et <NAME> est le Nom affiché de l’option.

Exemple 3 : un champ personnalisé sans options

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

Lorsqu’un champ personnalisé ne comportant pas d’options, tel qu’un champ de texte, est spécifié, la cmdlet ne renvoie aucun résultat.

Paramètres

-AttributeName

Spécifie le nom du champ personnalisé pour lequel vous souhaitez récupérer les options valides.

Type : Objet
Jeux de paramètres : (Tous)
Alias :
Obligatoire : Faux
Position : 2
Valeur par défaut : Aucune
Accepte les entrées de pipeline : Faux
Accepte les caractères génériques : Faux

-DocumentName

Spécifiez le nom du document contenant le champ personnalisé pour lequel vous souhaitez récupérer les options valides de l'
.

Type : Objet
Ensembles de paramètres : (Tous)
Alias :
Obligatoire : Faux
Position : 1
Valeur par défaut : Aucune
Accepte les entrées du pipeline : Faux
Accepte les caractères génériques : Faux

-TemplateId

Spécifiez le nom du modèle de document contenant le champ personnalisé pour lequel vous souhaitez récupérer les options valides d'
.

Type : Objet
Ensembles de paramètres : (Tous)
Alias :
Obligatoire : Faux
Position : 0
Valeur par défaut : Aucune
Accepte les entrées du pipeline : Faux
Accepte les caractères génériques : Faux

Entrées

System.String

La cmdlet n'accepte pas d'entrée provenant du pipeline. Les paramètres -TemplateId, -DocumentName et -AttributeName acceptent des valeurs de type chaîne représentant respectivement l'ID du modèle de document, le nom du document et le nom du champ personnalisé pour lesquels vous souhaitez récupérer les options valides.

Sorties

System.String[]

La cmdlet renvoie les options valides pour le champ personnalisé spécifié dans le document indiqué, au format <GUID>=<NAME>, sous forme de chaîne ou de tableau de chaînes si plusieurs options sont disponibles.

Cette cmdlet s’applique uniquement aux champs personnalisés de type liste déroulante et sélection multiple. Si un autre type de champ personnalisé
est spécifié, aucune sortie ne sera renvoyée.
Seuls les champs du document disposant d’autorisations de lecture pour l’automatisation permettent de récupérer leurs options à l’aide de cette cmdlet. Pour plus d’informations sur les autorisations relatives aux champs personnalisés, consultez la section « NinjaOne Custom Fields: Premiers pas ».

Ressources complémentaires

Pour plus d’informations sur la gestion des actifs et les scripts personnalisés, consultez les ressources suivantes :