Get-ITGlueExport

SYNOPSIS

List or show all exports

SYNTAX

Index (Default)

Get-ITGlueExport [-FilterID <String>] [-Sort <String>] [-PageNumber <Int64>] [-PageSize <Int32>] [-AllResults]
 [<CommonParameters>]

Show

Get-ITGlueExport -ID <Int64> [-Include <String>] [<CommonParameters>]

DESCRIPTION

The Get-ITGlueExport cmdlet returns a list of exports or the details of a single export in your account

This function can call the following endpoints: Index = /exports

Show =  /exports/:id

EXAMPLES

EXAMPLE 1

Get-ITGlueExport

Returns the first 50 exports from your ITGlue account

EXAMPLE 2

Get-ITGlueExport -ID 8765309

Returns the export with the defined id

EXAMPLE 3

Get-ITGlueExport -PageNumber 2 -PageSize 10

Returns the first 10 results from the second page for exports in your ITGlue account

PARAMETERS

-FilterID

Filter by a export id

Type: String
Parameter Sets: Index
Aliases: filter_id

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sort

Sort results by a defined value

Allowed values: ‘created_at’, ‘updated_at’, ‘-created_at’, ‘-updated_at’

Type: String
Parameter Sets: Index
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageNumber

Return results starting from the defined number

Type: Int64
Parameter Sets: Index
Aliases: page_number

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PageSize

Number of results to return per page

The maximum number of page results that can be requested is 1000

Type: Int32
Parameter Sets: Index
Aliases: page_size

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-ID

Get a export by id

Type: Int64
Parameter Sets: Show
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Include

Include additional information

Allowed values: ‘.’

Type: String
Parameter Sets: Show
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllResults

Returns all items from an endpoint

This can be used in unison with -PageSize to limit the number of sequential requests to the API

Type: SwitchParameter
Parameter Sets: Index
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

NOTES

N/A

https://celerium.github.io/ITGlue-PowerShellWrapper/site/Exports/Get-ITGlueExport.html

https://api.itglue.com/developer/#exports-index