Skip to content

Commit

Permalink
Adds command 'spo list defaultvalue list'. Closes pnp#6404
Browse files Browse the repository at this point in the history
  • Loading branch information
milanholemans committed Dec 23, 2024
1 parent 1819fcc commit ae0afe5
Show file tree
Hide file tree
Showing 6 changed files with 613 additions and 0 deletions.
1 change: 1 addition & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ const dictionary = [
'unit',
'url',
'user',
'value',
'web',
'webhook'
];
Expand Down
110 changes: 110 additions & 0 deletions docs/docs/cmd/spo/list/list-defaultvalue-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# spo list defaultvalue list

Retrieves default column values for a specific document library

## Usage

```sh
m365 spo list defaultvalue list [options]
```

## Options

```md definition-list
`-u, --webUrl <webUrl>`
: URL of the site where the list is located.

`-i, --listId [listId]`
: ID of the list. Specify either `listTitle`, `listId`, or `listUrl`.

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

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

`--folderUrl [folderUrl]`
: Only get default column values from a specific folder.
```

<Global />

## Examples

List all default column values of a list specified by title

```sh
m365 spo list defaultvalue list --webUrl https://contoso.sharepoint.com/sites/marketing --listTitle "Project Documents"
```

List all default column values of a list specified by ID

```sh
m365 spo list defaultvalue list --webUrl https://contoso.sharepoint.com/sites/marketing --listId 12345678-90ab-cdef-1234-567890abcdef
```

List all default column values of a list specified by server relative URL

```sh
m365 spo list defaultvalue list --webUrl https://contoso.sharepoint.com/sites/marketing --listUrl "/sites/marketing/Project Documents"
```

List all default column values of a specific folder in a list specified by site relative URLs

```sh
m365 spo list defaultvalue list --webUrl https://contoso.sharepoint.com/sites/marketing --listUrl "/Project Documents" --folderUrl "/Project Documents/Archive"
```

## Response

<Tabs>
<TabItem value="JSON">

```json
[
{
"fieldName": "Countries",
"fieldValue": "19;#Belgium|442affc2-7fab-4f33-9590-330403a579c2",
"folderUrl": "/sites/Marketing/Project Documents"
}
]
```

</TabItem>
<TabItem value="Text">

```text
fieldName fieldValue folderUrl
--------- ------------------------------------------------ ----------------------------------
Countries 19;#Belgium|442affc2-7fab-4f33-9590-330403a579c2 /sites/Marketing/Project Documents
```

</TabItem>
<TabItem value="CSV">

```csv
fieldName,fieldValue,folderUrl
Countries,19;#Belgium|442affc2-7fab-4f33-9590-330403a579c2,/sites/Marketing/Project Documents
```

</TabItem>
<TabItem value="Markdown">

```md
# spo list defaultvalue list --webUrl "https://contoso.sharepoint.com/sites/marketing" --listUrl "/Project Documents"

Date: 20/10/2024

Property | Value
---------|-------
fieldName | Countries
fieldValue | 19;#Belgium\|442affc2-7fab-4f33-9590-330403a579c2
folderUrl | /sites/Marketing/Project Documents
```

</TabItem>
</Tabs>
5 changes: 5 additions & 0 deletions docs/src/config/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2866,6 +2866,11 @@ const sidebars: SidebarsConfig = {
label: 'list contenttype default set',
id: 'cmd/spo/list/list-contenttype-default-set'
},
{
type: 'doc',
label: 'list defaultvalue list',
id: 'cmd/spo/list/list-defaultvalue-list'
},
{
type: 'doc',
label: 'list retentionlabel ensure',
Expand Down
1 change: 1 addition & 0 deletions src/m365/spo/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ export default {
LIST_CONTENTTYPE_LIST: `${prefix} list contenttype list`,
LIST_CONTENTTYPE_REMOVE: `${prefix} list contenttype remove`,
LIST_CONTENTTYPE_DEFAULT_SET: `${prefix} list contenttype default set`,
LIST_DEFAULTVALUE_LIST: `${prefix} list defaultvalue list`,
LIST_GET: `${prefix} list get`,
LIST_LIST: `${prefix} list list`,
LIST_REMOVE: `${prefix} list remove`,
Expand Down
Loading

0 comments on commit ae0afe5

Please sign in to comment.