Get-ITGlueExpiration
SYNOPSIS
List or show all expirations
SYNTAX
Index (Default)
Get-ITGlueExpiration [-OrganizationID <Int64>] [-FilterID <Int64>] [-FilterResourceID <Int64>]
[-FilterResourceName <String>] [-FilterResourceTypeName <String>] [-FilterDescription <String>]
[-FilterExpirationDate <String>] [-FilterOrganizationID <Int64>] [-FilterRange <String>]
[-FilterRangeExpirationDate <String>] [-Sort <String>] [-PageNumber <Int64>] [-PageSize <Int32>] [-AllResults]
[<CommonParameters>]
Show
Get-ITGlueExpiration [-OrganizationID <Int64>] -ID <Int64> [<CommonParameters>]
DESCRIPTION
The Get-ITGlueExpiration cmdlet returns a list of expirations for all organizations or for a specified organization
This function can call the following endpoints: Index = /expirations /organizations/:organization_id/relationships/expirations
Show = /expirations/:id
/organizations/:organization_id/relationships/expirations/:id
EXAMPLES
EXAMPLE 1
Get-ITGlueExpiration
Returns the first 50 results from your ITGlue account
EXAMPLE 2
Get-ITGlueExpiration -ID 8765309
Returns the expiration with the defined id
EXAMPLE 3
Get-ITGlueExpiration -PageNumber 2 -PageSize 10
Returns the first 10 results from the second page for expirations in your ITGlue account
PARAMETERS
-OrganizationID
A valid organization Id in your account
Type: Int64
Parameter Sets: (All)
Aliases: org_id, organization_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterID
Filter by expiration id
Type: Int64
Parameter Sets: Index
Aliases: filter_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterResourceID
Filter by a resource id
Type: Int64
Parameter Sets: Index
Aliases: filter_resource_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterResourceName
Filter by a resource name
Type: String
Parameter Sets: Index
Aliases: filter_resource_name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterResourceTypeName
Filter by a resource type name
Type: String
Parameter Sets: Index
Aliases: filter_resource_type_name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterDescription
Filter expiration description
Type: String
Parameter Sets: Index
Aliases: filter_description
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterExpirationDate
Filter expiration date
Type: String
Parameter Sets: Index
Aliases: filter_expiration_date
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterOrganizationID
Filter by organization name
Type: Int64
Parameter Sets: Index
Aliases: filter_organization_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterRange
Filter by expiration range
To filter on a specific range, supply two comma-separated values Example: “2, 10” is filtering for all that are greater than or equal to 2 and less than or equal to 10
Or, an asterisk ( * ) can filter on values either greater than or equal to Example: “2, ”, or less than or equal to (“, 10”)
Type: String
Parameter Sets: Index
Aliases: filter_range
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterRangeExpirationDate
Filter by expiration date range
Type: String
Parameter Sets: Index
Aliases: filter_range_expiration_date
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Sort
Sort results by a defined value
Allowed values: ‘id’, ‘organization_id’, ‘expiration_date’, ‘created_at’, ‘updated_at’, ‘-id’, ‘-organization_id’, ‘-expiration_date’, ‘-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
A valid expiration ID
Type: Int64
Parameter Sets: Show
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByValue)
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
RELATED LINKS
https://celerium.github.io/ITGlue-PowerShellWrapper/site/Expirations/Get-ITGlueExpiration.html