Skip to main content

Get-AtriaWorkSpaceItem

SYNOPSIS​

Retrieves shared workspace items.

SYNTAX​

Get-AtriaWorkSpaceItem [<CommonParameters>]

Get-AtriaWorkSpaceItem [-itemId <Int>] [<CommonParameters>]

Get-AtriaWorkSpaceItem [-filter <String>] [<CommonParameters>]

DESCRIPTION​

Retrieves workspace items from the Atria API. You can use this function to:

  • Retrieve all workspace items.
  • Retrieve a specific workspace item by specifying an itemId.
  • Retrieve workspace items matching a specified filter.

PARAMETERS​

  • itemId <Int> (Optional)
    Retrieves a specific workspace item by its unique identifier.

  • filter <String> (Optional)
    Retrieves workspace items matching the specified filter criteria.

  • <CommonParameters>
    Supports common parameters:
    Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable.

    More info: about_CommonParameters.

OUTPUTS​

Returns workspace items retrieved from the Atria API as objects.

EXAMPLES​

Example 1​

PS> Get-AtriaWorkSpaceItem

Retrieves all workspace items from Atria.

Example 2​

PS> Get-AtriaWorkSpaceItem -itemId 123

Retrieves the workspace item with the ID 123.

Example 3​

PS> Get-AtriaWorkSpaceItem -filter "displayName eq 'Standard Group'"

Retrieves workspace items where the displayName matches "Standard Group".

NOTES​

Ensure you've authenticated using Connect-AtriaApi before invoking this function.