internal/autorest/out/nodes/Get-DracoonARNodeRoomEvent.ps1
|
function Get-DracoonARNodeRoomEvent { <# .SYNOPSIS Request events of a room .DESCRIPTION <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>🚀 Since v4.3.0</h3> ### Description: Retrieve syslog (audit log) events related to a room. ### Precondition: Requires <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>🔓 read</span> permissions on that room. ### Postcondition: List of events is returned. ### Further Information: Output may be limited to a certain number of entries. Please use filter criteria and paging. Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort fields are supported. <details style="padding-left: 10px"> <summary style="cursor: pointer; outline: none"><strong>Example</strong></summary> `time:desc` Sort by `time` descending (default sort option). </details> ### Sorting 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` | Description | | :--- | :--- | | `time` | Event timestamp | </details> .PARAMETER User_id User ID .PARAMETER Connection Object of Class ARAHConnection, stores the authentication Token and the API Base-URL .PARAMETER Sort Sort string .PARAMETER Status Operation status: * `0` - Success * `2` - Error .PARAMETER XSdsAuthToken Authentication token .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`). .PARAMETER Type Operation ID cf. `GET /eventlog/operations` .PARAMETER Date_end Filter events until given date e.g. `2015-12-31T23:59:00` .PARAMETER Date_start Filter events from given date e.g. `2015-12-31T23:59:00` .EXAMPLE PS C:\> Get-DracoonARNodeRoomEvent -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.3.0</h3> ### Description: Retrieve syslog (audit log) events related to a room. ### Precondition: Requires <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>🔓 read</span> permissions on that room. ### Postcondition: List of events is returned. ### Further Information: Output may be limited to a certain number of entries. Please use filter criteria and paging. Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort fields are supported. <details style="padding-left: 10px"> <summary style="cursor: pointer; outline: none"><strong>Example</strong></summary> `time:desc` Sort by `time` descending (default sort option). </details> ### Sorting 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` | Description | | :--- | :--- | | `time` | Event timestamp | </details> .LINK <unknown> #> [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $User_id, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Connection, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $Sort, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Status, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $XSdsAuthToken, [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, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Type, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $Date_end, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $Date_start ) process { $__mapping = @{ 'User_id' = 'user_id' 'Connection' = 'Connection' 'Sort' = 'sort' 'Status' = 'status' 'XSdsAuthToken' = 'X-Sds-Auth-Token' 'Offset' = 'offset' 'XSdsDateFormat' = 'X-Sds-Date-Format' 'Limit' = 'limit' 'Type' = 'type' 'Date_end' = 'date_end' 'Date_start' = 'date_start' } $__body = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping $__query = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('User_id','Sort','Status','Offset','Limit','Type','Date_end','Date_start') -Mapping $__mapping $__header = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('XSdsAuthToken','XSdsDateFormat') -Mapping $__mapping $__path = 'nodes/rooms/{room_id}/events' -Replace '{room_id}',$Room_id Invoke-DracoonAPI -Path $__path -Method get -Body $__body -Query $__query -Header $__header -Connection $Connection } } |