PI Powershell

GetPIDataArchiveIncident Class

Save PDF

TABLE OF CONTENTS

GetPIDataArchiveIncident Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Note: This API is now obsolete.

Get PI Data Archive Incidents

The Get-PIDataArchiveIncident cmdlet gets PI Data Archive Incidents from a PI Data Archive.

The connection parameter specifies which connection to a PI Data Archive to use.

WARNING: This feature is deprecated and will throw an exception against PI Data Archive 2024 and later versions.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellGetPIDataArchiveIncident

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)

Syntax

[CmdletAttribute("Get", "PIDataArchiveIncident", SupportsShouldProcess = true)]
[ObsoleteAttribute]
public class GetPIDataArchiveIncident : OSICmdletBaseWithConnection

<CmdletAttribute("Get", "PIDataArchiveIncident", SupportsShouldProcess := true)>
<ObsoleteAttribute>
Public Class GetPIDataArchiveIncident
	Inherits OSICmdletBaseWithConnection

Dim instance As GetPIDataArchiveIncident

[CmdletAttribute(L"Get", L"PIDataArchiveIncident", SupportsShouldProcess = true)]
[ObsoleteAttribute]
public ref class GetPIDataArchiveIncident : public OSICmdletBaseWithConnection

[<CmdletAttribute("Get", "PIDataArchiveIncident", SupportsShouldProcess = true)>]
[<ObsoleteAttribute>]
type GetPIDataArchiveIncident =  
    class
        inherit OSICmdletBaseWithConnection
    end

The GetPIDataArchiveIncident type exposes the following members.

Constructors

	Name	Description
	GetPIDataArchiveIncident

Properties

	Name	Description
	Closed	Retrieve closed PI Incidents
	Connection	Connection to a PI Data Archive from which to get the PI Incidents (Overrides OSICmdletBaseWithConnectionConnection.)
	EndTime	End time for which to retrieve PI Incidents
	Open	Retrieve open PI Incidents
	StartTime	Start time for which to retrieve PI Incidents

Examples

Get-PIDataArchiveIncident -Open -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all open PI Incidents from the "PISRV1" PI Data Archive.

Examples

Get-PIDataArchiveIncident -Open -Closed -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all PI Incidents from the "PISRV1" PI Data Archive.

Examples

Get-PIDataArchiveIncident -Open -Closed -StartTime (ConvertFrom-AFRelativeTime -RelativeTime *-1w) -EndTime (ConvertFrom-AFRelativeTime -RelativeTime *) -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all PI Incidents from the "PISRV1" PI Data Archive that occurred in the last week.

PI Powershell