Skip to content
Logic.Monitor PowerShell Module

Get-EAIQueryRecord

Syntax

Section titled “Syntax”

__AllParameterSets

Section titled “__AllParameterSets”
Terminal window
Get-EAIQueryRecord [-RecordType] <string> [-RecordId] <string> [-AsResponse] [<CommonParameters>]

Description

Section titled “Description”

Get-EAIQueryRecord fetches one record via GET /ui/query/record/{recordType}/{recordId}. Record IDs may contain slash characters; the cmdlet URL-encodes the path segment automatically.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Get-EAIQueryRecord -RecordType events -RecordId 'LNDP-RTRPRD001_event_name_1537191059903'

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
$record = Invoke-EAIRecordsQuery -RecordType events -Field '_id' -Size 1 | Select-Object -First 1
Get-EAIQueryRecord -RecordType events -RecordId $record._id

EXAMPLE 3

Section titled “EXAMPLE 3”
Terminal window
Get-EAIQueryRecord -RecordType events -RecordId 'eventId/12345abc'

Parameters

Section titled “Parameters”

-AsResponse

Section titled “-AsResponse”

Returns the full API envelope (meta and results) instead of a single record object.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-RecordId

Section titled “-RecordId”

Record identifier (often the _id value from a records search).

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-RecordType

Section titled “-RecordType”

Record table: events, alerts, or insights.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

Section titled “CommonParameters”

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.