WorkSpace API Endpoints

Overview

The Atria WorkSpace Service includes a full REST API that can be used for direct integration and automation.

However, this documentation focuses specifically on using the Powershell cmdlets provided in the Atria.Tools module.
These cmdlets make it much easier to interact with the WorkSpace Service without manually building REST API calls.

If you require direct REST API documentation, please refer to the Swagger UI available within your own Atria instance:

https://{hostname}/api/

note

For most automation and scripting tasks, the provided Powershell cmdlets are recommended as they handle authentication, request formatting, and responses automatically.

Working with the Atria API

When working with the Atria API, you must first connect to the API — much like working with Microsoft Entra ID.
Connecting validates your authorization token and sets up the Powershell session with the required metadata to work with the other Cmdlets and Functions.

• Connect-AtriaApi
  Validates the authentication token and sets up the Powershell environment for communication with Atria's external WorkSpace Api.

• Disconnect-AtriaApi
  Disconnects the Powershell environment and clears the Api authentication properties.

• Get-AtriaApiContext
  Retrieves the current Api connection properties.

Working with Item Types

Item Types can only be retrieved via the API. If you require a new Item Type, add the entry directly to the WorkSpace.ItemTypes table in Atria's OLM database. In most cases you should not need an additional ItemType, contact Atria Consulting for further guidance.

• Get-AtriaWorkspaceItemType
  Retrieves the WorkSpace Item Types.

Working with Shared Items

• Get-AtriaWorkSpaceItem
  Retrieves one or more workspace shared items.

• Get-AtriaWorkSpaceItemCustomerRelationship
  Retrieves a list of customers related to a specific item.

• New-AtriaWorkSpaceItem
  Creates a new Shared (Public) WorkSpace Item.

• Remove-AtriaWorkSpaceItemCustomerRelationship
  Removes the relationship between a workspace item and a customer.

Working with Private Items

• Add-AtriaWorkSpaceCustomerItem
  Assigns a workspace item from a list to a customer in the Atria workspace service

• Get-AtriaWorkSpaceCustomerItem
  Retrieves workspace items assigned to a specific customer.

• Import-AtriaWorkspaceItem
  Imports an existing group into the Atria WorkSpace Service.

• New-AtriaWorkSpaceCustomerItem
  Creates a new customer workspace item.

• Remove-AtriaWorkSpaceCustomerItem
  Removes a workspace item assigned to a specific customer.

Working with Lists

• Add-AtriaWorkSpaceListItem
  Adds a shared workspace item to a specific workspace list

• Add-AtriaWorkSpaceListScope
  Assigns a scope for a workspace list to a customer

• Get-AtriaWorkSpaceItemListRelationship
  Retrieves a list of WorkSpace Lists an item is allocated to.

• Get-AtriaWorkSpaceList
  Retrieves one or more WorkSpace Lists.

• Get-AtriaWorkSpaceListItem
  Retrieves items from a specified workspace list.

• Get-AtriaWorkSpaceListScope
  Retrieves scopes associated with a specific workspace list

• Remove-AtriaWorkSpaceListItem
  Removes a shared workspace item from a specific workspace list

Working with Icons

• Get-AtriaWorkSpaceIcon
  Retrieves an icon associated with a workspace item.

Working with Roles

• Get-AtriaWorkSpaceCustomerRoleItem
  Retrieves workspace items associated with a specific customer role.