Get-VaultItem

Retrieves an Item from Vault.

Syntax

Get-VaultItem [-Number <String>] [-ItemId <Long>] [-Properties <Hashtable>] [<CommonParameters>]

Parameters

Type	Name	Description	Optional
String	Number	Number of the item	yes
Long	ItemId	Id or MasterId of the item	yes
Hashtable	Properties	Search for the item with matching properties	yes

Return type

Item ← on success
empty ← on failure

Remarks

If the search criteria’s passed to the -Properties argument matches more than one item, then only the first item is returned.

In order to search an item by properties the -Properties argument allows to search the values of user defined properties and system properties which can be passed using their:

• display names (e.g. @{'Effectivity' = ...} can be used with English Vault or @{'Gültigkeit' = ...} can be used with german Vault environments).

Examples

Get Item via Number

$item = Get-VaultItem -Number '100001'

Get Item via Id

$item = Get-VaultItem -ItemId 142

Get Item that matches certain search criteria’s

$item = Get-VaultItem -Properties @{"Description (Item,CO)" = "PAD LOCK ASSEMBLY"; "Lifecycle Definition" = "Item Release Process"}