Invoke-PnPSPRestMethod
SYNOPSIS
Invokes a REST request towards a SharePoint site.
SYNTAX
Invoke-PnPSPRestMethod -Url <String>
[-Method <HttpRequestMethod>]
[-Content <Object>]
[-ContentType <String>]
[-Raw]
[-Connection <PnPConnection>]
[-ResponseHeadersVariable <String>]
[-Batch <PnPBatch>]
DESCRIPTION
Invokes a REST request towards a SharePoint site.
EXAMPLES
EXAMPLE 1
Invoke-PnPSPRestMethod -Url /_api/web
This example executes a GET request towards the current site collection and returns the properties of the current web.
EXAMPLE 2
$output = Invoke-PnPSPRestMethod -Url '/_api/web/lists?$select=Id,Title'
$output.value
This example executes a GET request towards the current site collection and returns the id and title of all the lists and outputs them to the console. Notice the use of single quotes. If you want to use double quotes (") then you will have to escape the $ character with a backtick: `$
EXAMPLE 3
$item = @{Title="Test"}
Invoke-PnPSPRestMethod -Method Post -Url "/_api/web/lists/GetByTitle('Test')/items" -Content $item
This example creates a new item in the list 'Test' and sets the title field to 'Test'.
EXAMPLE 4
$item = "{'Title':'Test'}"
Invoke-PnPSPRestMethod -Method Post -Url "/_api/web/lists/GetByTitle('Test')/items" -Content $item
This example creates a new item in the list 'Test' and sets the title field to 'Test'.
EXAMPLE 5
$item = "{ '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'Test'}"
Invoke-PnPSPRestMethod -Method Post -Url "/_api/web/lists/GetByTitle('Test')/items" -Content $item -ContentType "application/json;odata=verbose"
This example creates a new item in the list 'Test' and sets the title field to 'Test'.
EXAMPLE 6
$output = Invoke-PnPSPRestMethod -Url '/_api/web/lists?$select=Id,Title' -ResponseHeadersVariable headers
$output.value
$headers
This example executes a GET request towards the current site collection and returns the id and title of all the lists and outputs them to the console. Notice the use of single quotes. If you want to use double quotes (") then you will have to escape the $ character with a backtick: `$
It will also store the response headers values in the PowerShell variable name that you specify. Enter a variable name without the dollar sign ($) symbol.
EXAMPLE 7
$batch = New-PnPBatch -RetainRequests
Invoke-PnPSPRestMethod -Method Get -Url "https://tenant.sharepoint.com/sites/mysite/_api/web/lists" -Batch $batch
$item = "{'Title':'Test'}"
Invoke-PnPSPRestMethod -Method Post -Url "https://tenant.sharepoint.com/sites/mysite/_api/web/lists/GetByTitle('Test')/items" -Content $item -Batch $batch
$response = Invoke-PnPBatch $batch -Details
$response
This example executes a GET request to get all lists and a POST request to add an item to a list in a single batch request. It is necessary to create and invoke batch requests in the manner specified here if you want to process something later on with the response object.
PARAMETERS
-Content
A string or object to send.
Type: Object
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False
-ContentType
The content type of the object to send. Defaults to 'application/json'.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False
-Method
The Http method to execute. Defaults to GET.
Type: HttpRequestMethod
Parameter Sets: (All)
Required: False
Position: 0
Accept pipeline input: False
-Url
The url to execute
Type: String
Parameter Sets: (All)
Required: True
Position: 0
Accept pipeline input: False
-Raw
If specified the returned data will not be converted to an object but returned as a JSON string.
Type: SwitchParameter
Parameter Sets: (All)
Required: True
Position: 0
Accept pipeline input: False
-Accept
The Accept HTTP request header. Defaults to 'application/json;odata=nometadata'.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False
-Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False
-ResponseHeadersVariable
Creates a variable containing a Response Headers Dictionary. Enter a variable name without the dollar sign ($) symbol. The keys of the dictionary contain the field names and values of the Response Header returned by the web server.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False
-Batch
The batch to add this request to.
Type: PnPBatch
Parameter Sets: Batched
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False