Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .devproxy/api-specs/sharepoint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,25 @@ paths:
responses:
200:
description: OK
/_api/web/GetFileByServerRelativePath(DecodedUrl={filePath})/$value:
get:
parameters:
- name: filePath
in: path
required: true
description: URL-encoded server-relative path to the file
schema:
type: string
example: "'%2FShared%20Documents%2FForms%2Fclient_LocationBasedDefaults.html'"
security:
- delegated:
- AllSites.Read
- AllSites.Write
- AllSites.Manage
- AllSites.FullControl
responses:
200:
description: OK
/_api/web/GetFolderByServerRelativePath(DecodedUrl={folderPath}):
get:
parameters:
Expand Down Expand Up @@ -218,6 +237,30 @@ paths:
responses:
200:
description: OK
/_api/web/lists({listId}):
get:
parameters:
- name: listId
in: path
required: true
description: list GUID
schema:
type: string
example: "'56bbfec4-4425-4660-95cb-da1887baa7b9'"
security:
- delegated:
- AllSites.Read
- AllSites.Write
- AllSites.Manage
- AllSites.FullControl
- application:
- Sites.Read.All
- Sites.Manage.All
- Sites.ReadWrite.All
- Sites.FullControl.All
responses:
200:
description: OK
/_api/web/webs:
get:
security:
Expand Down
118 changes: 118 additions & 0 deletions docs/docs/cmd/spo/list/list-defaultvalue-get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# spo list defaultvalue get

Gets a specific default column value from a specific document library

## Usage

```sh
m365 spo list defaultvalue get [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`.

`--fieldName <fieldName>`
: Internal name of the field.

`--folderUrl [folderUrl]`
: Get a specific field of a specific folder by specifying a server- or site-relative URL.
```

<Global />

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|------------|---------------|
| SharePoint | AllSites.Read |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|------------|----------------|
| SharePoint | Sites.Read.All |

</TabItem>
</Tabs>

## Examples

Get default column value from the root folder of the list

```sh
m365 spo list defaultvalue get --webUrl https://contoso.sharepoint.com/sites/Marketing --listTitle Logos --fieldName Company
```

Get default column value from a specific folder of the list

```sh
m365 spo list defaultvalue get --webUrl https://contoso.sharepoint.com/sites/Marketing --listTitle Logos --fieldName Company --folderUrl "/sites/Marketing/Logos/Contoso"
```

## Response

<Tabs>
<TabItem value="JSON">

```json
{
"fieldName": "Company",
"fieldValue": "Contoso",
"folderUrl": "sites/Marketing/Logos"
}
```

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

```text
fieldName : Company
fieldValue: Contoso
folderUrl : sites/Marketing/Logos
```

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

```csv
fieldName,fieldValue,folderUrl
Company,Contoso,sites/Marketing/Logos
```

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

```md
# spo list defaultvalue get --webUrl "https://contoso.sharepoint.com/sites/Marketing" --listTitle "Logos" --fieldName "Company"

Date: 2/20/2023

Property | Value
---------|-------
fieldName | Company
fieldValue | Contoso
folderUrl | sites/Marketing/Logos
```

</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 @@ -3069,6 +3069,11 @@ const sidebars: SidebarsConfig = {
label: 'list defaultvalue clear',
id: 'cmd/spo/list/list-defaultvalue-clear'
},
{
type: 'doc',
label: 'list defaultvalue get',
id: 'cmd/spo/list/list-defaultvalue-get'
},
{
type: 'doc',
label: 'list defaultvalue list',
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 @@ -142,6 +142,7 @@ export default {
LIST_CONTENTTYPE_REMOVE: `${prefix} list contenttype remove`,
LIST_CONTENTTYPE_DEFAULT_SET: `${prefix} list contenttype default set`,
LIST_DEFAULTVALUE_CLEAR: `${prefix} list defaultvalue clear`,
LIST_DEFAULTVALUE_GET: `${prefix} list defaultvalue get`,
LIST_DEFAULTVALUE_LIST: `${prefix} list defaultvalue list`,
LIST_DEFAULTVALUE_REMOVE: `${prefix} list defaultvalue remove`,
LIST_DEFAULTVALUE_SET: `${prefix} list defaultvalue set`,
Expand Down
Loading