【SharePoint】リストのフィールド情報をCSV出力する

f:id:tecchan365:20190707225500p:plain

リストのフィールド情報(内部値や、列の種類等)をCSV出力する方法をご紹介します。

事前準備

PnP PowerShellをインストールしておいてください。

mynote365.hatenadiary.com

ps1ファイルを作成・実行

以下のps1ファイルを作成・実行します。

# SharePoint接続情報
$targetUrl = "https://<<tenant>>.sharepoint.com/sites/LearningPortal"
Connect-PnPOnline –Url $targetUrl –Credentials (Get-Credential)

# フィールド情報を取得したいリスト名
$listName = "ListName"

# CSVファイル出力先
$outputFile = "C:\Work\" + $listName + ".csv"

Get-PnPField -List $listName  | Export-Csv $outputFile -NoTypeInformation -Encoding Default

実行が完了すると、プログラム上で指定した場所にCSVファイルが作成されています。
f:id:tecchan365:20190707225555p:plain

出力したCSVファイルの確認

CSVファイルを開くと、リストのフィールド情報がずらーっと掲載されています。
f:id:tecchan365:20190707230334p:plain

「InternalField(内部値)」や「Title(列の表示名)」などが確認できます。
※出力される列の一覧は、記事の最後に掲載しています。

f:id:tecchan365:20190707231836p:plain

以上、リストのフィールド情報をCSV出力する方法でした。

従来であれば、フィールドの内部値の確認するときは、リストの設定画面に行って、列の設定に行って、URLの一番後ろを見て…という修行のような操作が必要でした。
こちらの方法にすると、プログラム1つで簡単に確認できるので、とっても楽ちんですね (^^)

補足:出力される列一覧

出力される列は以下の通りです。

列名
1 AutoIndexed
2 CanBeDeleted
3 ClientSideComponentId
4 ClientSideComponentProperties
5 CustomFormatter
6 DefaultFormula
7 DefaultValue
8 Description
9 DescriptionResource
10 Direction
11 EnforceUniqueValues
12 EntityPropertyName
13 Filterable
14 FromBaseType
15 Group
16 Hidden
17 Id
18 Indexed
19 InternalName
20 JSLink
21 NoCrawl
22 PinnedToFiltersPane
23 ReadOnlyField
24 Required
25 SchemaXml
26 SchemaXmlWithResourceTokens
27 Scope
28 Sealed
29 ShowInFiltersPane
30 Sortable
31 StaticName
32 Title
33 TitleResource
34 FieldTypeKind
35 TypeAsString
36 TypeDisplayName
37 TypeShortDescription
38 ValidationFormula
39 ValidationMessage
40 Context
41 Tag
42 Path
43 ObjectVersion
44 ServerObjectIsNull
45 TypedObject