Skip to main content

Get-AtriaRequest

SYNOPSIS​

Retrieves details about a specific request using the request ID.

SYNTAX​

Get-AtriaRequest -RequestId <Int> [<CommonParameters>]

DESCRIPTION​

Queries the Atria API to retrieve metadata, status, and associated details for a specific request ID. Typically used for troubleshooting, monitoring, or auditing request activity.

PARAMETERS​

  • RequestId <Int> (Required) The numeric identifier of the Atria request to retrieve. This is typically returned during operations like item creation or assignment.

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

OUTPUTS​

Returns the request object from the Atria API, typically including request status, timestamps, and error details if applicable.

EXAMPLES​

Example - Retrieve request status​

Get-AtriaRequest -RequestId 9876

Returns details about request 9876, including current status, timestamps, and any associated metadata.

NOTES​

Ensure you are connected using Connect-AtriaApi before calling this function.