internal/autorest/out/nodes/Get-DracoonARNodeRoomWebhook.ps1
|
function Get-DracoonARNodeRoomWebhook { <# .SYNOPSIS Request list of webhooks that are assigned or can be assigned to this room .DESCRIPTION <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>🚀 Since v4.19.0</h3> ### Description: Get a list of webhooks for the room scope with their assignment status. ### Precondition: User needs to be a <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>👤 Room Administrator</span>. ### Postcondition: List of webhooks is returned. ### Further Information: ### Filtering: All filter fields are connected via logical conjunction (**AND**) Filter string syntax: `FIELD_NAME:OPERATOR:VALUE[:VALUE...]` <details style="padding-left: 10px"> <summary style="cursor: pointer; outline: none"><strong>Example</strong></summary> `isAssigned:eq:true` Get a list of assigned webhooks to the room. </details> ### Filtering options: <details style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;"> <summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary> | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | **`isAssigned`** | Assigned/unassigned webhooks filter | `eq` | | `true or false` | </details> .PARAMETER XSdsAuthToken Authentication token .PARAMETER Connection Object of Class ARAHConnection, stores the authentication Token and the API Base-URL .PARAMETER Filter Filter string .PARAMETER Offset Range offset .PARAMETER XSdsDateFormat Date time format (cf. [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) & [leettime.de](http://leettime.de/)) .PARAMETER Room_id Room ID .PARAMETER Limit Range limit. Maximum 500. For more results please use paging (`offset` + `limit`). .EXAMPLE PS C:\> Get-DracoonARNodeRoomWebhook -Connection $connection -Room_id $room_id <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>🚀 Since v4.19.0</h3> ### Description: Get a list of webhooks for the room scope with their assignment status. ### Precondition: User needs to be a <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>👤 Room Administrator</span>. ### Postcondition: List of webhooks is returned. ### Further Information: ### Filtering: All filter fields are connected via logical conjunction (**AND**) Filter string syntax: `FIELD_NAME:OPERATOR:VALUE[:VALUE...]` <details style="padding-left: 10px"> <summary style="cursor: pointer; outline: none"><strong>Example</strong></summary> `isAssigned:eq:true` Get a list of assigned webhooks to the room. </details> ### Filtering options: <details style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;"> <summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary> | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | **`isAssigned`** | Assigned/unassigned webhooks filter | `eq` | | `true or false` | </details> .LINK <unknown> #> [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $XSdsAuthToken, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Connection, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $Filter, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Offset, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $XSdsDateFormat, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $Room_id, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Limit ) process { $__mapping = @{ 'XSdsAuthToken' = 'X-Sds-Auth-Token' 'Connection' = 'Connection' 'Filter' = 'filter' 'Offset' = 'offset' 'XSdsDateFormat' = 'X-Sds-Date-Format' 'Limit' = 'limit' } $__body = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping $__query = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('Filter','Offset','Limit') -Mapping $__mapping $__header = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('XSdsAuthToken','XSdsDateFormat') -Mapping $__mapping $__path = 'nodes/rooms/{room_id}/webhooks' -Replace '{room_id}',$Room_id Invoke-DracoonAPI -Path $__path -Method get -Body $__body -Query $__query -Header $__header -Connection $Connection } } |