Get-UxResource

NAME Get-UxResource



SYNOPSIS

This cmdlet makes a GET request to any valid UX resource. For full list of valid resources refer to

https://support.sonus.net/display/UXAPIDOC





SYNTAX

Get-UxResource [[-uxSession] <PSObject>] [-resource] <String> [[-ReturnElement] <String>] [[-Arguments] <String>]

[[-Details]] [[-Credentials] <PSCredential>] [<CommonParameters>]





DESCRIPTION

This cmdlet makes a GET request to any valid UX resource. For full list of valid resources refer to

https://support.sonus.net/display/UXAPIDOC.

The cmdlet is one of the most powerful as you can query pretty much any UX resource which supports GET requests!





PARAMETERS

-uxSession <PSObject>



Required? false

Position? 1

Default value $DefaultSession

Accept pipeline input? false

Accept wildcard characters? false



-resource <String>

Enter a valid resource name here. For valid resource names refer to https://support.sonus.net/display/UXAPIDOC



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReturnElement <String>



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Arguments <String>



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Details [<SwitchParameter>]



Required? false

Position? 5

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Credentials <PSCredential>



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>This example queries a "timing" resource



get-uxresource -resource timing









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>This example queries a "certificate" resource



get-uxresource -resource certificate



After you know the certificate id URL using the above cmdlet, you can perform second query to find more details:



get-uxresource -resource certificate/1











RELATED LINKS

To find all the resources which can be queried, please refer to https://support.sonus.net/display/UXAPIDOC