| external help file | Module Name | online version | schema |
|---|---|---|---|
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml |
AMSoftware.Crm |
2.0.0 |
Invoke the WebAPI
Invoke-CrmWebApiRequest [-Url] <Uri> [-Method <String>] [-Body <Object>] [-ContentType <String>]
[-FormattedValues] [<CommonParameters>]
Invoke the WebAPI
PS C:\> Invoke-CrmWebApiRequest -Url 'accounts' -Method GET -FormattedValuesRetrieve all accounts directly through the WebAPI. Include the formatted values.
The body for the request. Ignored if the request is a GET. If Body is a string it is passed on to the request directly. IF the Body is an object it is serialized to a JSON string which is passed on to the request.
Type: System.Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseContentType of the request. if not included application/json is used.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: application/json
Accept pipeline input: False
Accept wildcard characters: FalseInclude the formatted values in the response. Adds the header 'Prefer: odata.include-annotations="OData.Community.Display.V1.FormattedValue"'
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseHTTPMethod of the request. If not included GET is used.
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: Get, Post, Put, Delete, Patch
Required: False
Position: Named
Default value: GET
Accept pipeline input: False
Accept wildcard characters: FalseURI relative to the WebAPI base URI to execute.
Type: System.Uri
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.