Skip to main content

Add-AtriaWorkSpaceCustomerItem

SYNOPSIS​

Assigns a workspace item from a list to a customer.

SYNTAX​

Add-AtriaWorkSpaceCustomerItem -CustomerId <Int> -ItemId <Int> -ListId <Int> [-isDefaultSelect] [<CommonParameters>]

Add-AtriaWorkSpaceCustomerItem -CustomerId <Int> -ItemId <Int> -ListName <String> [-isDefaultSelect] [<CommonParameters>]

DESCRIPTION​

Creates an association between a specified workspace item (from a given list, identified either by List ID or List Name) and a customer by invoking the Atria API.

PARAMETERS​

  • CustomerId <Int> (Required)
    The unique identifier (ID) of the customer.

  • ItemId <Int> (Required)
    The unique identifier (ID) of the workspace item to assign.

  • ListId <Int> (Required, Parameter Set: byListId)
    The unique identifier (ID) of the workspace list containing the item.

  • ListName <String> (Required, Parameter Set: byListName)
    The name of the workspace list containing the item.

  • isDefaultSelect (Optional)
    Indicates whether the workspace item should be marked as the default selection for the customer.

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

    More info: about_CommonParameters.

OUTPUTS​

Returns the response object confirming the successful assignment.

EXAMPLES​

Example 1 (by List ID)​

PS> Add-AtriaWorkSpaceCustomerItem -CustomerId 123 -ItemId 456 -ListId 789

Assigns workspace item 456 from list 789 to customer 123.

Example 2 (by List Name, with Default Selection)​

PS> Add-AtriaWorkSpaceCustomerItem -CustomerId 123 -ItemId 456 -ListName "Standard Items" -isDefaultSelect

Assigns workspace item 456 from the workspace list named "Standard Items" to customer 123 and marks it as default.

NOTES​

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