SP 名前空間の複合型

  • [アーティクル]

SharePoint REST インターフェイスによって使用される SP 名前空間から複合型を検索します。

適用対象: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

この記事の内容
AppLicense 複合型
AppLicenseCollection 複合型
AppPrincipalConfiguration 複合型
AppPrincipalCredentialReference 複合型
BasePermissions 複合型
CamlQuery 複合型
ChangeLogItemQuery 複合型
ChangeQuery 複合型
ChangeToken 複合型
ContentTypeCreationInformation 複合型
ContentTypeId 複合型
ContextWebInformation 複合型
DocumentLibraryInformation 複合型
EventReceiverDefinitionCreationInformation 複合型
ExternalAppPrincipalCreationParameters 複合型
FieldCalculatedErrorValue 複合型
FieldCreationInformation 複合型
FieldGeolocationValue 複合型
FieldLookupValue 複合型
FieldRatingScaleQuestionAnswer 複合型
FieldUrlValue 複合型
FieldUserValue 複合型
FileCreationInformation 複合型
GroupCreationInformation 複合型
KeyValue 複合型
Language 複合型
ListDataSource 複合型
ListDataValidationExceptionValue 複合型
ListDataValidationFailure 複合型
ListItemCollectionPosition 複合型
ListItemCreationInformation 複合型
ListItemFormUpdateValue 複合型
MenuNode 複合型
MenuState 複合型
NavigationNodeCreationInformation 複合型
RelatedItem 複合型
RenderListDataParameters 複合型
RoleDefinitionCreationInformation 複合型
SimpleDataRow 複合型
SimpleDataTable 複合型
TimeZoneInformation 複合型
UpgradeInfo 複合型
UsageInfo 複合型
UserCreationInformation 複合型
UserIdInfo 複合型
ViewCreationInformation 複合型
WebCreationInformation 複合型
WebInfoCreationInformation 複合型
WebRequestInfo 複合型
WebResponseInfo 複合型
XmlSchemaFieldCreationInformation 複合型
実装メモ

REST インターフェイスで、複合型は POST、MERGE、および PUT 要求の要求本体でメソッド パラメーターとして送られ、オブジェクトおよびプロパティのデータ型として返されます。

AppLicense 複合型

指定された SharePoint アドインの指定されたユーザー用のアプリ ライセンスを表します。

プロパティ名

型

説明

Null 許容型

RawXMLLicenseToken

String

ライセンスのプロパティ情報が含まれているアプリのライセンス トークンを表す XML フラグメントを取得します。

true

AppLicenseCollection 複合型

プロパティ名

型

説明

Null 許容型

Items

Collection(SP.AppLicense)

アプリ ライセンスのコレクション。

true

AppPrincipalConfiguration 複合型

アプリ プリンシパルに関連付けられている構成。

プロパティ名

型

説明

Null 許容型

ApplicationEndpointAuthorities

Collection(String)

プリンシパルによって公開されているエンドポイント権限の一覧。

true

ApplicationPrincipalNames

Collection(String)

プリンシパルの名前の一覧。

true

NameIdentifier

String

プリンシパルの名前識別子。

true

RedirectAddresses

Collection(String)

プリンシパルのリダイレクト アドレスの一覧。

true

AppPrincipalCredentialReference 複合型

アプリ プリンシパルの資格情報への参照を表します。

プロパティ名

型

説明

Null 許容型

Id

Guid

プリンシパルの一意識別子。

false

NameIdentifier

String

プリンシパルの名前識別子。

true

NotAfter

DateTime

このキーの有効期限が切れる日時。

false

NotBefore

DateTime

このキーが有効になる日時。

false

BasePermissions 複合型

ロール定義の基本アクセス許可を表します。

プロパティ名

型

説明

Null 許容型

High

Int64

アクセス許可のビット単位の上位境界 (上位の 32 ビット)。

false

Low

Int64

アクセス許可のビット単位の下位境界 (下位の 32 ビット)。

false

CamlQuery 複合型

リストまたは結合リストの CAML (Collaborative Application Markup Language) クエリを指定します。

プロパティ名

型

説明

Null 許容型

DatesInUtc

Boolean

クエリが協定世界時 (UTC) 形式の日付を返すかどうかを示す値を取得または設定します。

false

FolderServerRelativeUrl

String

結果の取得元になるリスト フォルダーのサーバー相対 URL を指定する値を取得または設定します。

true

ListItemCollectionPosition

SP.ListItemCollectionPosition

リスト ビューでデータの次のページを取得するために必要な情報を指定する値を取得または設定します。

true

ViewXml

String

リスト ビューを定義する XML スキーマを指定する値を取得または設定します。

true

ChangeLogItemQuery 複合型

GetListItemChangesSinceToken メソッドの入力パラメーターを表します。

プロパティ名

型

説明

Null 許容型

ChangeToken

String

要求の変更トークンです。

true

Contains

String

クエリのカスタム フィルター処理を定義する XML 要素です。

true

Query

String

リストから返すレコードと、レコードを返す順序です。

true

QueryOptions

String

クエリを変更するためのオプションです。

true

RowLimit

String

ページごとに返されるクエリ内の項目の最大数です。

true

ViewFields

String

クエリ結果に含めるフィールドの名前です。

true

ViewName

String

ビューの GUID です。

true

ChangeQuery 複合型

変更ログに対して実行されるクエリを定義します。

プロパティ名

型

説明

Null 許容型

Add

Boolean

追加の変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Alert

Boolean

通知の変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

ChangeTokenEnd

SP.ChangeToken

クエリによって返される変更の終了日と終了時刻を指定する値を取得または設定します。

false

ChangeTokenStart

SP.ChangeToken

クエリによって返される変更の開始日と開始時刻を指定する値を取得または設定します。

false

ContentType

Boolean

コンテンツ タイプの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

DeleteObject

Boolean

コンテンツ タイプの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Field

Boolean

コンテンツ タイプの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

File

Boolean

コンテンツ タイプの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Folder

Boolean

フォルダーの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Group

Boolean

グループの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

GroupMembershipAdd

Boolean

グループへのユーザーの追加がクエリに含まれるかどうかを指定する値を取得または設定します。

false

GroupMembershipDelete

Boolean

グループからのユーザーの削除がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Item

Boolean

リスト アイテムに対する全般的な変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

List

Boolean

リストの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Move

Boolean

移動の変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Navigation

Boolean

サイト コレクションのナビゲーション構造に対する変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Rename

Boolean

名前の変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Restore

Boolean

ごみ箱またはバックアップからのアイテムの復元がクエリに含まれるかどうかを指定する値を取得または設定します。

false

RoleAssignmentAdd

Boolean

ロールの割り当ての追加がクエリに含まれるかどうかを指定する値を取得または設定します。

false

RoleAssignmentDelete

Boolean

ロールの割り当ての追加がクエリに含まれるかどうかを指定する値を取得または設定します。

false

RoleDefinitionAdd

Boolean

ロールの割り当ての追加がクエリに含まれるかどうかを指定する値を取得または設定します。

false

RoleDefinitionDelete

Boolean

ロールの割り当ての追加がクエリに含まれるかどうかを指定する値を取得または設定します。

false

RoleDefinitionUpdate

Boolean

ロールの割り当ての追加がクエリに含まれるかどうかを指定する値を取得または設定します。

false

SecurityPolicy

Boolean

セキュリティ ポリシーの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Site

Boolean

サイト コレクションの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

SystemUpdate

Boolean

アイテムの SystemUpdate メソッドを使用して行われた更新がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Update

Boolean

更新の変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

User

Boolean

ユーザーに対する変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

View

Boolean

ビューの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

Web

Boolean

Web サイトの変更がクエリに含まれるかどうかを指定する値を取得または設定します。

false

ChangeToken 複合型

変更ログ内の変更の一意のシーケンシャルな場所を表します。

プロパティ名

型

説明

Null 許容型

StringValue

String

プロトコル サーバーによって生成された変更トークンのシリアル化された表現を含む文字列値を取得または設定します。

true

ContentTypeCreationInformation 複合型

新しいコンテンツ タイプを初期化するパラメーターとして使用されるプロパティを指定します。

プロパティ名

型

説明

Null 許容型

Description

String

作成されるコンテンツ タイプの説明を指定する値を取得または設定します。

true

Group

String

作成されるコンテンツ タイプのコンテンツ タイプ グループを指定する値を取得または設定します。

true

Id

String

true

Property name

String

作成されるコンテンツ タイプの名前を指定する値を取得または設定します。

true

ContentTypeId 複合型

コンテンツ タイプのコンテンツ タイプ識別子 (ID) を表します。

プロパティ名

型

説明

Null 許容型

StringValue

String

コンテンツ タイプ ID を表す 16 進数の文字列です。

true

ContextWebInformation 複合型

サイトのコンテキスト情報。

プロパティ名

型

説明

Null 許容型

FormDigestTimeoutSeconds

Int32

フォーム ダイジェストがタイムアウトになる時間 (秒単位)。

false

FormDigestValue

String

フォーム ダイジェスト値。

true

LibraryVersion

String

ライブラリのバージョン。

true

SiteFullUrl

String

サイト コレクション コンテキストの完全な URL。

true

SupportedSchemaVersions

Collection(String)

サポートされているクライアント側オブジェクト モデル要求のスキーマ バージョン。

true

WebFullUrl

String

サイト コンテキストの完全な URL。

true

DocumentLibraryInformation 複合型

ドキュメント ライブラリに関する情報を表します。

プロパティ名

型

説明

Null 許容型

Modified

DateTime

最終更新日。

false

ModifiedFriendlyDisplay

String

最終更新日時のわかりやすい表示。

true

ServerRelativeUrl

String

ドキュメント ライブラリのサーバー相対 URL。

true

Title

String

ドキュメント ライブラリのタイトル。

true

EventReceiverDefinitionCreationInformation 複合型

イベント レシーバーの作成情報を指定します。

プロパティ名

型

説明

Null 許容型

EventType

Int32

イベントのタイプ。値の一覧についての詳細は, .NET クライアント オブジェクト モデル リファレンスの EventReceiverType を参照してください。

false

ReceiverAssembly

String

イベントの受信に使用されるアセンブリの厳密な名前を指定します。

true

ReceiverClass

String

イベントの受信に使用されるクラスを表す文字列を指定します。

true

ReceiverName

String

イベント レシーバーの名前を指定します。

true

ReceiverUrl

String

イベントの受信に使用される Web サービスの URL を指定します。

true

SequenceNumber

Int32

イベントの相対シーケンスを表す整数を指定します。

false

Synchronization

Int32

イベント レシーバーの実行の同期処理を指定します。

false

ExternalAppPrincipalCreationParameters 複合型

新しい外部アプリ プリンシパルの作成に使用されるすべてのパラメーターをカプセル化するオブジェクトを表します。

プロパティ名

型

説明

Null 許容型

AppIdentifier

String

アプリ プリンシパルの一意識別子。

true

ApplicationEndpointAuthorities

Collection(String)

アプリ エンドポイントを公開するホスト名 [:ポート] の一覧。

true

DisplayName

String

アプリ プリンシパルの表示名。

true

RedirectAddresses

Collection(String)

リダイレクト アドレス。

true

TrustedForDelegation

Boolean

アプリ プリンシパルが委任に対して信頼されているかどうかを示します。

false

FieldCalculatedErrorValue 複合型

ゼロによる除算、オーバーフローなど、フィールドの値が計算エラーになったときのリスト アイテムの集計フィールドの値を表します。

プロパティ名

型

説明

Null 許容型

ErrorMessage

String

集計フィールドのエラー メッセージを取得します。

true

FieldCreationInformation 複合型

フィールドを作成するときに設定できるプロパティを表します。

プロパティ名

型

説明

Null 許容型

Choices

Collection(String)

フィールドの選択に使用できる値。

true

IsCompactName

Boolean

フィールド名に最初の 8 文字だけを使用するかどうかを示します。

false

LookupFieldName

String

ルックアップ フィールドの名前。

true

LookupListId

Guid

ソース ルックアップ フィールドのターゲット リストの ID。

false

LookupWebId

Guid

ルックアップ フィールドの値のソースであるリストが含まれるサイトの ID。

false

Required

Boolean

フィールドで値が必須かどうかを指定する値を取得または設定します。

false

Title

String

フィールドの表示名を指定する値を取得または設定します。

true

FieldTypeKind

Int32

フィールドの種類を指定する値を取得または設定します。

false

FieldGeolocationValue 複合型

地理位置情報フィールドの高度、緯度、経度、および測定値を表します。

プロパティ名

型

説明

Null 許容型

Altitude

Double

地理位置情報フィールドのユーザー定義の標高の値です。

false

Latitude

Double

地理位置情報フィールドの緯度の値です。

false

Longitude

Double

地理位置情報フィールドの経度の値です。

false

Measure

Double

地理位置情報フィールドのユーザー定義の測定値です。

false

FieldLookupValue 複合型

リスト アイテム内のフィールドのルックアップの値を指定します。

プロパティ名

型

説明

Null 許容型

LookupId

Int32

ルックアップ フィールドのこのインスタンスが参照しているリスト アイテムの識別子 (ID) を取得または設定します。

false

LookupValue

String

ルックアップ フィールドのこのインスタンスが参照しているリスト アイテムの概要を取得します。

true

FieldRatingScaleQuestionAnswer 複合型

リスト アイテムの段階評価フィールド内にある特定の補足質問および回答を表します。

プロパティ名

型

説明

Null 許容型

Answer

Int32

補足質問に対する回答を指定する値を取得または設定します。

false

Question

String

段階評価内の補足質問を指定する値を取得または設定します。

true

FieldUrlValue 複合型

FieldURL のハイパーリンクおよび説明の値を指定します。

プロパティ名

型

説明

Null 許容型

Description

String

URI の説明を指定する値を取得または設定します。

true

Url

String

URI を指定します。

true

FieldUserValue 複合型

リスト アイテムのユーザー フィールドの値を表します。SP.FieldLookupValue から継承します。

プロパティ名

型

説明

Null 許容型

LookupId

Int32

ユーザー データのルックアップ フィールドの値が表すユーザー ID。

false

LookupValue

String

ユーザー データのルックアップ フィールドの値が表すユーザー。

true

FileCreationInformation 複合型

FileCollection.Add メソッドを使用してファイルを作成するときに設定できるプロパティを表します。

プロパティ名

型

説明

Null 許容型

Content

Binary

ファイルのバイナリ コンテンツです。

true

Overwrite

Boolean

追加中のファイルと同じ名前で同じ場所にある既存のファイルを上書きするかどうかを示します。

false

Url

String

ファイルの URL です。

true

GroupCreationInformation 複合型

クロスサイト グループの作成を容易にするために使用されるオブジェクトです。

プロパティ名

型

説明

Null 許容型

Description

String

作成されるグループの説明が含まれている文字列を取得または設定します。

true

Title

String

作成されるグループの名前を含む文字列を取得または設定します。

true

KeyValue 複合型

キーと値のペアの辞書を表します。

プロパティ

プロパティ名

型

説明

Null 許容型

Key

String

キー。

true

Value

String

値。

true

ValueType

String

値のタイプ。

true

Language 複合型

Microsoft SharePoint Foundation のコンテキスト内で使用される自然言語を表します。

プロパティ名

型

説明

Null 許容型

DisplayName

String

Microsoft SharePoint Foundation のコンテキスト内で使用される自然言語を表します。

true

LanguageTag

String

この言語の言語タグを取得します。

true

Lcid

Int32

言語のロケール識別子 (LCID) を取得します。

false

ListDataSource 複合型

外部データ ソースへの接続に関連する情報を表します。

プロパティ名

型

説明

Null 許容型

Properties

Collection(SP.KeyValue)

データ ソースへの接続に関連付けられているプロパティを取得します。

true

ListDataValidationExceptionValue 複合型

リスト フィールドまたはリスト アイテムのデータの検証に失敗した場合にスローされる例外です。

プロパティ名

型

説明

Null 許容型

FieldFailures

Collection(SP.ListDataValidationFailure)

フィールドの検証エラー。

true

ItemFailure

SP.ListDataValidationFailure

リスト アイテムの検証エラー。

true

ListDataValidationFailure 複合型

リスト アイテムの挿入または更新時の具体的な検証エラーを記述します。

プロパティ名

型

説明

Null 許容型

DisplayName

String

リストのタイトルまたは検証に失敗したフィールドの表示名を取得します。

true

Message

String

エラーに関する情報を伴うメッセージを取得します。

true

Name

String

検証に失敗したフィールド名またはリスト ID を取得します。

true

Reason

Int32

エラーの理由を取得します。

false

ValidationType

Int32

エラーが発生した検証の種類を記述します。

false

ListItemCollectionPosition 複合型

リスト ビューでデータの次のページを取得するために必要な情報を指定します。

プロパティ名

型

説明

Null 許容型

PagingInfo

String

リスト ビューのデータの次のページを取得するために必要な情報を名前と値のペアとして指定する値を取得または設定します。

true

ListItemCreationInformation 複合型

新しいリスト アイテムのプロパティを指定します。

プロパティ名

型

説明

Null 許容型

FolderUrl

String

新しいリスト アイテムのフォルダーを指定する値を取得または設定します。

true

LeafName

String

新しいリスト アイテムの名前を指定する値を取得または設定します。リスト アイテムの親リストがドキュメント ライブラリの場合は、ファイル名でなければなりません。

true

UnderlyingObjectType

Int32

新しいリスト アイテムがファイルであるかフォルダーであるかを指定する値を取得または設定します。

false

ListItemFormUpdateValue 複合型

リスト アイテムのフィールドとその値のプロパティを表します。

プロパティ名

型

説明

Null 許容型

ErrorMessage

String

フィールドの値を検証した後のエラー メッセージの結果です。

true

FieldNames

String

フィールドの内部名です。

true

FieldValue

String

フィールドの値です。

true

HasException

Boolean

フィールドの値を検証した後、エラーの結果があったかどうかを示します。

false

ナビゲーション階層内のナビゲーション ノードを表します。 ナビゲーション階層は、ナビゲーション ノードのツリー構造です。

プロパティ名

型

説明

Null 許容型

CustomProperties

Collection(SP.KeyValue)

ノードのプロパティ。

true

FriendlyUrlSegment

String

親ナビゲーション ノードの URL を基準にしたナビゲーション ノードの URL。

true

IsHidden

Boolean

ノードをナビゲーション メニューで非表示にするかどうかを示します。編集中は、すべてのノードが一時的に可視になります。

false

Key

String

メニュー ツリー内のナビゲーション ノードの識別子。

true

Nodes

Collection(SP.MenuNode)

子ノード。

true

NodeType

Int32

ナビゲーション ノードの型。

false

SimpleUrl

String

ナビゲーション ノードの相対または絶対 URL。 サイト相対 URL は、「~site」トークンで始めることができ、サイト コレクションの相対 URL は「~sitecollection」トークンで始めることができます。SimpleLink ノード タイプにのみ適用されます。

true

Title

String

ナビゲーション ノードのタイトル。

true

深さが 10 レベルのサイトのルート ノードでダンプが開始される、既定の SiteMapProvider ("SPSiteMapProvider") のメニュー状態を表します。

メニューの状態を照会するために使用可能なパラメーターは、次のとおりです。

menuNodeKey

開始ノードのキー。 キーが指定されていない場合は、ルート ノードが使用されます。

depth

ダンプの深さ。既定値は 10 です。

customProperties

(必要に応じて、サイト マップ データ プロバイダーにより実装されます。) 返されるカスタム プロパティのコンマ区切りのリスト。プロパティ内でコンマ区切り文字をエスケープするには「\」 文字を使用します。

mapProviderName

サイト上でどのプロバイダーを選択するかを指定します。SiteMapProvider が使用されていない場合、「CurrentNavSiteMapProviderNoEncode」が使用されます。

要求例:
http://<site url>/_api/navigation/menustate?menuNodeKey='1006'&depth=5 は、深さ 5 のキー 1006 を持つノードで始まる「SPSiteMapProvider」のメニュー状態を返します。
http://<site url>/_api/navigation/menustate?depth=5&mapProviderName='CurrentNavSiteMapProviderNoEncode' は、深さ 5 のプロバイダーのルート ノードから「CurrentNavSiteMapProviderNoEncode」のメニュー状態を返します。

プロパティ名

型

説明

Null 許容型

FriendlyUrlPrefix

String

メニュー ツリーのルート ノードのサイト コレクション相対 URL を指定します。

true

Nodes

Collection(SP.MenuNode)

メニュー ツリーのルート ノードの子ノード。

true

SimpleUrl

String

ナビゲーション ノードの相対または絶対 URL。 サイト相対 URL は、「~site」 URL トークンで始めることができ、サイト コレクションの相対 URL は「~sitecollection」 URL トークンで始めることができます。SimpleLink ノード タイプにのみ適用されます。

true

SPSitePrefix

String

サイト コレクション相対リンクの「~sitecollection」トークンを置き換える文字列。たとえば、[リンクを試す] コマンドで相対リンク ~sitecollection/Pages/MyPage.aspx を処理する場合、この値は https://contoso.com/sites/site1/ になります。

true

SPWebPrefix

String

サイト相対リンクの「~site」トークンを置き換える文字列。たとえば、[リンクを試す] コマンドで相対リンク ~site/Pages/MyPage.aspx を処理する場合、この値は https://contoso.com/sites/site1/web1 になります。

true

StartingNodeKey

String

メニュー ツリー内のルート ノードの識別子。

true

StartingNodeTitle

String

メニュー ツリー内のルート ノードのタイトル。 (例: "Document Center")

true

Version

String

外部の変更を検出するためにサーバーが使用する実装固有の値。たとえば、データベースの変更タイムスタンプ、または単調に増加していく「2009-06-15T20:45:30Z」などのバージョン番号になります。

true

作成される新しいナビゲーション ノードを記述します。

プロパティ名

型

説明

Null 許容型

AsLastNode

Boolean

ナビゲーション ノードがコレクション内の最後のノードとして作成されるかどうかを指定する値を取得または設定します。

false

IsExternal

Boolean

ナビゲーション ノードの URL がサイト コレクションの外側にあるページに対応する場合があるかどうかを指定する値を取得または設定します。

false

Title

String

ノード ナビゲーション リンクのアンカー テキストを指定する値を取得または設定します。

true

Url

String

ナビゲーション ノードで保存される URL を指定する値を取得または設定します。

true

RelatedItem 複合型

プロパティ名

型

説明

Null 許容型

IconUrl

String

true

ItemId

Int32

false

ListId

String

true

Title

String

true

Url

String

true

WebId

String

true

RenderListDataParameters 複合型

リスト データを JavaScript Object Notation (JSON) 文字列としてレンダリングする場合に使用するパラメーターを表します。

プロパティ名

型

説明

Null 許容型

FolderServerRelativeUrl

String

アイテムを返すフォルダーの URL。

true

Paging

String

ページング情報。

true

ViewXml

String

CAML (Collaborative Application Markup Language) ビュー XML。

true

RoleDefinitionCreationInformation 複合型

ロール定義を初期化するパラメーターとして使用されるプロパティを格納します。

プロパティ名

型

説明

Null 許容型

BasePermissions

SP.BasePermissions

ロール定義に対するアクセス許可を指定する値を取得または設定します。

true

Description

String

ロール定義の説明を指定する値を取得または設定します。

true

Property name

String

ロール定義の名前を指定する値を取得または設定します。

true

Order

Int32

ロールが表示される順序を指定する値を取得または設定します。

false

SimpleDataRow 複合型

データ テーブル内の行を表します。

プロパティ名

型

説明

Null 許容型

Cells

Collection(SP.KeyValue)

行のセル。

true

SimpleDataTable 複合型

データ テーブルを表します。

プロパティ

プロパティ名

型

説明

Null 許容型

Rows

Collection(SP.SimpleDataRow)

テーブル内の行。

true

TimeZoneInformation 複合型

タイム ゾーンに関する情報を表します。

プロパティ名

型

説明

Null 許容型

Bias

Int32

タイム ゾーンと世界協定時刻 (UTC) の差の分数。正の値は、タイム ゾーンが UTC よりも遅いことを示します。

false

DaylightBias

Int32

夏時間中の時差に追加された分数です。

false

StandardBias

Int32

夏時間以外の時差に追加された分数です。

false

UpgradeInfo 複合型

サイト コレクションのアップグレード情報を表します。

プロパティ名

型

説明

Null 許容型

ErrorFile

String

アップグレード エラーを格納しているファイルの場所です。

true

Errors

Int32

サイト コレクションのアップグレード中に発生したエラーの数です。

false

LastUpdated

DateTime

アップグレード進行状況の最新の更新の DateTime です。

false

LogFile

String

アップグレード ログを格納しているファイルの場所です。

true

RequestDate

DateTime

サイト コレクションのアップグレードが要求されたときの DateTime です。

false

RetryCount

Int32

サイト コレクションのアップグレードが試行された回数です。

false

StartTime

DateTime

サイト コレクションのアップグレードが開始されたときの DateTime です。

false

Status

Int32

サイト コレクションのアップグレードの現在の状態です。

false

UpgradeType

Int32

サイト コレクションのアップグレードの種類。この種類はビルド間のアップグレード (値 = 0)、またはバージョン間のアップグレード (値 = 1) とすることができます。

false

Warnings

Int32

サイト コレクションのアップグレード中に発生した警告の数です。

false

UsageInfo 複合型

サイト コレクションの使用状況に関する情報へのアクセスに使用されるフィールドを提供します。

プロパティ名

型

説明

Null 許容型

Bandwidth

Int64

実装に固有の期間にサイト コレクションによって使用される累積帯域幅をバイト単位で示す値を取得します。

false

DiscussionStorage

Int64

サイト コレクション内で Web ディスカッション コメントを保存するために現在使用されているディスク領域の合計容量をバイト単位で示す値を取得します。

false

Hits

Int64

実装に固有の期間におけるサイト コレクションのページに対する要求の累積数を示す値を取得します。

false

Storage

Int64

サイト コレクションで現在使用されているディスク領域の合計容量をバイト単位で示す値を取得します。

false

StoragePercentageUsed

Double

サイト コレクション クォータで指定されている最大ディスク領域に対する、サイト コレクションで現在使用されているディスク領域の合計容量の割合を示す値を取得します。

false

Visits

Int64

実装の特定期間中に、参照する URL を持たない、または現在のサイト コレクション以外の URL を参照する、サイト コレクションのページ要求の累積数を指定する値を取得します。

false

UserCreationInformation 複合型

ユーザーを招待するためのパラメーターです。

プロパティ名

型

説明

Null 許容型

Email

String

作成されるユーザーの電子メール アドレスを指定する値を取得または設定します。

true

LoginName

String

作成されるユーザーのログイン名を指定する値を取得または設定します。

true

Title

String

作成されるユーザーの表示名を指定する値を取得または設定します。

true

UserIdInfo 複合型

ID プロバイダーの一意の識別子情報を表します。

プロパティ名

型

説明

Null 許容型

NameId

String

ID プロバイダーの一意の識別子です。

true

NameIdIssuer

String

ファームで登録されている ID プロバイダーの表示名です。

true

ViewCreationInformation 複合型

新しいリスト ビューの作成に使用されるプロパティを指定します。

プロパティ名

型

説明

Null 許容型

Paged

Boolean

新しいリスト ビューがページ表示かどうかを指定する値を取得または設定します。

false

PersonalView

Boolean

新しいリスト ビューが個人用ビューであるかどうかを指定する値を取得または設定します。値が false の場合、この新しいリスト ビューはパブリック ビューです。

false

Query

String

新しいリスト ビューに関するクエリを指定する値を取得または設定します。

true

RowLimit

Int32

新しいリスト ビューによってリスト ビューのビジュアル ページに表示されるリスト アイテムの最大数を指定する値を取得または設定します。

false

SetAsDefaultView

Boolean

新しいリスト ビューが既定のリスト ビューかどうかを指定する値を取得または設定します。

false

Title

String

新しいリスト ビューの表示名を指定する値を取得または設定します。

true

ViewFields

Collection(String)

新しいリスト ビュー内にあるリスト フィールドのフィールド内部名のコレクションを指定する値を取得または設定します。

true

ViewTypeKind

Int32

新しいリスト ビューの種類を指定する値を取得または設定します。

false

WebCreationInformation 複合型

新しいサイトのプロパティを指定します。

プロパティ名

型

説明

Null 許容型

Description

String

新しいサイトの説明を取得または設定します。

true

Language

Int32

新しいサイトの言語を指定するロケール ID を取得または設定します。

false

Title

String

新しいサイトのタイトルを指定する値を取得または設定します。

true

Url

String

新しいサイトのリーフ名を取得または設定します。

URL には以下のものを含めないでください。
文字 ~、"、#、%、&、*、:、<、>、?、\、{、|、または }
文字列 \x7f
連続した . または / 文字
.、/、または _ で始まる文字
. または / で終わる文字

true

UseSamePermissionsAsParentSite

Boolean

新しいサイトがその親サイトからアクセス許可を継承するかどうかを指定する値を取得または設定します。

false

WebTemplate

String

新しいサイトの作成に使用されるサイト テンプレートの名前を指定する値を取得または設定します。GetAvailableWebTemplates メソッドを使用して、サイトで使用可能な Web テンプレートの名前を取得します。

true

WebInfoCreationInformation 複合型

サイトの作成に関するメタデータを表します。

プロパティ名

型

説明

Null 許容型

Description

String

サイトの説明。

true

Language

Int32

サイトで使用する言語の有効な言語コード識別子 (LCID)。

false

Title

String

サイトのタイトル。

true

Url

String

サイトの URL。

URL には以下のものを含めないでください。
文字 ~、"、#、%、&、*、:、<、>、?、\、{、|、または }
文字列 \x7f
連続した . または / 文字
.、/、または _ で始まる文字
. または / で終わる文字

true

UseUniquePermissions

Boolean

サイトがその親からアクセス許可を継承するかどうかを示します。

false

WebTemplate

String

サイトの作成に使用するサイト テンプレートの名前。

true

WebRequestInfo 複合型

送信 Web 要求を行うために必要な呼び出し元からのデータを表します。

プロパティ名

型

説明

Null 許容型

Body

String

HTTP 要求メッセージの本文を取得または設定します。

true

Headers

Collection(SP.KeyValue)

HTTP 要求で送信するヘッダーの名前/値ペアを格納している辞書を取得または設定します。

true

Method

String

Web 要求の HTTP メソッドを取得または設定します。

true

Url

String

Web 要求の URL を取得または設定します。

true

WebResponseInfo 複合型

サードパーティ サービスの応答のコピーが含まれます。

プロパティ名

型

説明

Null 許容型

Body

String

HTTP 応答の本文を取得または設定します。

true

Headers

Collection(SP.KeyValue)

HTTP 応答のヘッダーを取得または設定します。

true

StatusCode

Int32

HTTP 応答のステータス コードを取得または設定します。

false

XmlSchemaFieldCreationInformation 複合型

フィールドを作成するときに設定できるプロパティを表します。

プロパティ名

型

説明

Null 許容型

Options

Int32

フィールドを追加するときに使用するオプション。値のリストについての詳細は, .NET クライアント オブジェクト モデル リファレンスの AddFieldOptions を参照してください。

false

SchemaXml

String

スキーマを含む Collaborative Application Markup Language (CAML) 文字列。

true

実装メモ

Nullable タイプのパラメーターの場合、URI のクエリ文字列にパラメーターを含めないことによって null 値を指定できます。

関連項目

概念

REST API リファレンスおよびサンプル

その他の技術情報

SharePoint 2013 REST サービスの概要

SharePoint 2013 REST エンドポイントを使用して基本的な操作を完了する