@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.bb31388

package/docs/docs/cmd/spo/listitem/listitem-add.mdx

@@ -0,0 +1,191 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo listitem add
+
+Creates a list item in the specified list
+
+## Usage
+
+```sh
+m365 spo listitem add [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the item should be added
+
+`-l, --listId [listId]`
+: ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
+
+`-t, --listTitle [listTitle]`
+: Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
+
+`-c, --contentType [contentType]`
+: The name or the ID of the content type to associate with the new item
+
+`-f, --folder [folder]`
+: The list-relative URL of the folder where the item should be created
+```
+
+<Global />
+
+## Remarks
+
+:::caution When using DateTime fields
+
+When creating a list item 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 an item with Title _Demo Item_ and content type name _Item_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem add --contentType Item --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Item"
+```
+
+Add an item with Title _Demo Multi Managed Metadata Field_ and a single-select metadata field named _SingleMetadataField_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Single Managed Metadata Field" --SingleMetadataField "TermLabel1|fa2f6bfd-1fad-4d18-9c89-289fe6941377;"
+```
+
+Add an item with Title _Demo Multi Managed Metadata Field_ and a multi-select metadata field named _MultiMetadataField_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Managed Metadata Field" --MultiMetadataField "TermLabel1|cf8c72a1-0207-40ee-aebd-fca67d20bc8a;TermLabel2|e5cc320f-8b65-4882-afd5-f24d88d52b75;"
+```
+
+Add an item with Title _Demo Single Person Field_ and a single-select people field named _SinglePeopleField_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Single Person Field" --SinglePeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'}]"
+```
+
+Add an item with Title _Demo Multi Person Field_ and a multi-select people field named _MultiPeopleField_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|john.doe@conotoso.com'}]"
+```
+
+Add an item with Title _Demo Hyperlink Field_ and a hyperlink field named _CustomHyperlink_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Hyperlink Field" --CustomHyperlink "https://www.bing.com, Bing"
+```
+
+Add an item with a specific title to a list retrieved by server-relative URL in a specific site
+
+```sh
+m365 spo listitem add --contentType Item --listUrl /sites/project-x/Documents --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Item"
+```
+
+Add an item with a specific Title and multi-choice value
+
+```sh
+m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo multi-choice Field" --MultiChoiceField "Choice 1;#Choice 2;#Choice 3"
+```
+
+Add an item with a specific Title and DateTime value
+
+```sh
+m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo DateTime Field" --SomeDateTimeField "2023-01-16 15:30:00"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "FileSystemObjectType": 0,
+    "Id": 234,
+    "ServerRedirectedEmbedUri": null,
+    "ServerRedirectedEmbedUrl": "",
+    "ID": 234,
+    "ContentTypeId": "0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803",
+    "Title": "Test",
+    "Modified": "2022-11-16T20:55:45Z",
+    "Created": "2022-11-16T20:55:45Z",
+    "AuthorId": 10,
+    "EditorId": 10,
+    "OData__UIVersionString": "1.0",
+    "Attachments": false,
+    "GUID": "352e3855-56fa-4b68-b6be-4644d6adf204",
+    "ComplianceAssetId": null,
+    "OData__vti_ItemDeclaredRecord": null,
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Attachments                  : false
+  AuthorId                     : 10
+  ComplianceAssetId            : null
+  ContentTypeId                : 0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803
+  Created                      : 2022-11-16T20:56:31Z
+  EditorId                     : 10
+  FileSystemObjectType         : 0
+  GUID                         : cac57513-e870-4e7a-9f23-f4ea10e14f4e
+  ID                           : 236
+  Id                           : 236
+  Modified                     : 2022-11-16T20:56:31Z
+  OData__UIVersionString       : 1.0
+  OData__vti_ItemDeclaredRecord: null
+  ServerRedirectedEmbedUri     : null
+  ServerRedirectedEmbedUrl     :
+  Title                        : Test
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  FileSystemObjectType,Id,ServerRedirectedEmbedUri,ServerRedirectedEmbedUrl,ID,ContentTypeId,Title,Modified,Created,AuthorId,EditorId,OData__UIVersionString,Attachments,GUID,ComplianceAssetId,OData__vti_ItemDeclaredRecord
+  0,235,,,235,0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803,Test,2022-11-16T20:56:09Z,2022-11-16T20:56:09Z,10,10,1.0,,7aa8f3bd-a0a2-4974-81c8-2ac7ddc8e2d8,,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo listitem add --contentType "Item" --listTitle "My List" --webUrl "https://contoso.sharepoint.com/sites/project-x" --Title "Test"
+
+  Date: 2/20/2023
+
+  ## Test (234)
+
+  Property | Value
+  ---------|-------
+  FileSystemObjectType | 0
+  Id | 234
+  ServerRedirectedEmbedUri | null
+  ServerRedirectedEmbedUrl |
+  ContentTypeId | 0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803
+  Title | Test
+  ComplianceAssetId | null
+  FieldName1 | null
+  ID | 234
+  Modified | 2022-11-16T20:55:45Z
+  Created | 2022-11-16T20:55:45Z
+  AuthorId | 10
+  EditorId | 10
+  OData\_\_UIVersionString | 1.0
+  Attachments | false
+  GUID | 352e3855-56fa-4b68-b6be-4644d6adf204
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/listitem/listitem-attachment-list.mdx

@@ -0,0 +1,111 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo listitem attachment list
+
+Gets the attachments associated to a list item
+
+## Usage
+
+```sh
+m365 spo listitem attachment list [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site from which the item should be retrieved
+
+`--listId [listId]`
+: ID of the list where the item should be retrieved. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listTitle [listTitle]`
+: Title of the list where the item should be retrieved. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
+
+`--itemId <itemId>`
+: ID of the list item to in question
+```
+
+<Global />
+
+## Examples
+
+Gets the attachments from list item with itemId _147_ in list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --itemId 147
+```
+
+Gets the attachments from list item with itemId _147_ in list with id _0cd891ef-afce-4e55-b836-fce03286cccf_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --itemId 147
+```
+
+Gets the attachments from a specific list item in a specific list obtained by server-relative URL in a specific site
+
+```sh
+m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/Documents --itemId 147
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "FileName": "DummyDocument.docx",
+      "FileNameAsPath": {
+        "DecodedUrl": "DummyDocument.docx"
+      },
+      "ServerRelativePath": {
+        "DecodedUrl": "/Lists/Test/Attachments/236/DummyDocument.docx"
+      },
+      "ServerRelativeUrl": "/Lists/Test/Attachments/236/DummyDocument.docx"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  FileName            ServerRelativeUrl  
+  ------------------  ----------------------------------------------
+  DummyDocument.docx  /Lists/Test/Attachments/236/DummyDocument.docx
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  FileName,ServerRelativeUrl
+  DummyDocument.docx,/Lists/Test/Attachments/236/DummyDocument.docx
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo listitem attachment list --webUrl "https://contoso.sharepoint.com" --listTitle "Test" --itemId "236"
+
+  Date: 2/20/2023
+
+  Property | Value
+  ---------|-------
+  FileName | DummyDocument.docx
+  FileNameAsPath | {"DecodedUrl":"DummyDocument.docx"}
+  ServerRelativePath | {"DecodedUrl":"/Lists/Test/Attachments/236/DummyDocument.docx"}
+  ServerRelativeUrl | /Lists/Test/Attachments/236/DummyDocument.docx
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/listitem/listitem-batch-add.mdx

@@ -0,0 +1,71 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem batch add
+
+Creates list items in a batch
+
+## Usage
+
+```sh
+m365 spo listitem batch add [options]
+```
+
+## Options
+
+```md defintion-list
+`-p, --filePath <filePath>`
+: The absolute or relative path to a flat file containing the list items.
+
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+`-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.
+```
+
+<Global />
+
+## 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.
+
+```csv
+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|markh@contoso.com'}],"[{'Key':'i:0#.f|membership|markh@contoso.com'},{'Key':'i:0#.f|membership|john.doe@contoso.com'}]","https://bing.com, URL",5,2023-01-01 10:00:00
+```
+
+:::caution 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
+
+```sh
+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 Id in a specific site
+
+```sh
+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
+
+```sh
+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.

package/docs/docs/cmd/spo/listitem/listitem-batch-set.mdx

@@ -0,0 +1,71 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem batch set
+
+Updates list items in a batch
+
+## Usage
+
+```sh
+m365 spo listitem batch set [options]
+```
+
+## Options
+
+```md defintion-list
+`-p, --filePath <filePath>`
+: The absolute or relative path to a flat file containing the list items.
+
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+`-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.
+
+`--idColumn [idColumn]`
+: Name of the column in the csv containing the IDs of the items to set. Defaults to `ID`.
+
+`-s, --systemUpdate`
+: Update the item without updating the modified date and modified by fields.
+```
+
+<Global />
+
+## 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.
+
+```csv
+ID,ContentType,Title,SingleChoiceField,MultiChoiceField,SingleMetadataField,MultiMetadataField,SinglePeopleField,MultiPeopleField,CustomHyperlink,NumberField,LookupList,LookupListMulti
+5,Item,Title Update,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa,john@contoso.com,john@contoso.com;doe@contoso.com,"https://bing.com, URL",5,2,2;3
+```
+
+## Examples
+
+Updates a batch of items to a list retrieved by title in a specific site
+
+```sh
+m365 spo listitem batch set --filePath "C:\Path\To\Csv\CsvFile.csv" --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List"
+```
+
+Updates a batch of items to a list retrieved by Id in a specific site with a specific `idColumn`
+
+```sh
+m365 spo listitem batch set --filePath "C:\Path\To\Csv\CsvFile.csv" --webUrl https://contoso.sharepoint.com/sites/project-x --listId fe54c47b-22e4-4cab-8a10-3fc54003fb4c --idColumn id
+```
+
+Updates a batch of items to a list defined by server-relative URL in a specific site without updating the modified details
+
+```sh
+m365 spo listitem batch set --filePath "C:\Path\To\Csv\CsvFile.csv" --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/sites/project-x/lists/Demo List" --systemUpdate
+```
+
+## Response
+
+The command won't return a response on success.