Invoke-ITGlueRequest
SYNOPSIS
Makes an API request to ITGlue
SYNTAX
Invoke-ITGlueRequest [[-Method] <String>] [-ResourceURI] <String> [[-QueryParams] <Hashtable>]
[[-Data] <Object>] [-AllResults] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The Invoke-ITGlueRequest cmdlet invokes an API request to the ITGlue API
This is an internal function that is used by all public functions
EXAMPLES
EXAMPLE 1
Invoke-ITGlueRequest -method GET -ResourceURI '/passwords' -QueryParams $QueryParams
Invoke a rest method against the defined resource using the provided parameters
Example HashTable: $query_params = @{ ‘filter[id]’] = 123456789 ‘filter[organization_id]’] = 12345 }
PARAMETERS
-Method
Defines the type of API method to use
Allowed values: ‘GET’, ‘POST’, ‘PATCH’, ‘DELETE’
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: GET
Accept pipeline input: False
Accept wildcard characters: False
-ResourceURI
Defines the resource uri (url) to use when creating the API call
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-QueryParams
Hashtable of values to combine a functions parameters with the ResourceUri parameter
This allows for the full uri query to occur
The full resource path is made with the following data $ITGlue_Base_URI + $ResourceURI + ConvertTo-ITGlueQueryString
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Data
Object containing supported ITGlue method schemas
Commonly used when bulk adjusting ITGlue data
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AllResults
Returns all items from an endpoint
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
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/Internal/Invoke-ITGlueRequest.html