Skip to content

listitem-batch-add.mdx

Latest commit

 

History

History
93 lines (62 loc) · 3.24 KB

listitem-batch-add.mdx

File metadata and controls

93 lines (62 loc) · 3.24 KB

import Global from '../../_global.mdx';

spo listitem batch add

Creates list items in a batch

Usage

m365 spo listitem batch add [options]

Options

`-u, --webUrl <webUrl>`
: URL of the site.

`-p, --filePath [filePath]`
: The absolute or relative path to a flat file containing the list items. Specify `filePath` or `csvContent`, but not both.

`-c, --csvContent [csvContent]`
: A string content in CSV-format containing the list items. Specify `filePath` or `csvContent`, but not both.

`-l, --listId [listId]`
: ID of the list. Specify either `listTitle`, `listId` or `listUrl`, but not multiple.

`-t, --listTitle [listTitle]`
: Title of the list. Specify either `listTitle`, `listId` or `listUrl`, but not multiple.

`--listUrl [listUrl]`
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`, but not multiple.

Remarks

A sample CSV can be found below. The first line of the CSV-file should contain the internal column names that you wish to set.

ContentType,Title,SingleChoiceField,MultiChoiceField,SingleMetadataField,MultiMetadataField,SinglePeopleField,MultiPeopleField,CustomHyperlink,NumberField,DateTimeField
Item,Title A,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa;,[{'Key':'i:0#.f|membership|[email protected]'}],"[{'Key':'i:0#.f|membership|[email protected]'},{'Key':'i:0#.f|membership|[email protected]'}]","https://bing.com, URL",5,2023-01-01 10:00:00

:::warning[When using DateTime fields]

When creating list items with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: yyyy-MM-dd HH:mm:ss. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.

:::

Examples

Add a batch of items to a list retrieved by title in a specific site

m365 spo listitem batch add --filePath "C:\Path\To\Csv\CsvFile.csv" --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List"

Add a batch of items to a list retrieved by title in a specific site using csv content

$obj = @(
  [PSCustomObject]@{
    Title = "Item A"
    Age = 10
  },
  [PSCustomObject]@{
    Title = "Item B"
    Age = 20
  }
) 

$csvContent = $obj | ConvertTo-Csv -NoTypeInformation -Delimiter "," | Out-String | ForEach-Object { $_.Replace('"','\"') }

m365 spo listitem batch add --csvContent $csvContent --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List"

Add a batch of items to a list retrieved by Id in a specific site

m365 spo listitem batch add --filePath "C:\Path\To\Csv\CsvFile.csv" --webUrl https://contoso.sharepoint.com/sites/project-x --listId fe54c47b-22e4-4cab-8a10-3fc54003fb4c

Add a batch of items to a list defined by server-relative URL in a specific site

m365 spo listitem batch add --filePath "C:\Path\To\Csv\CsvFile.csv" --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/sites/project-x/lists/Demo List"

Response

The command won't return a response on success.