SP へListItem オブジェクト (sp.js)

リスト内のアイテムまたは行を表します。

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

この記事の内容
メンバー
注釈
他のリソースのエンドポイント

var object = new SP.ListItem()

メンバー

ListItemオブジェクトでは、次のメンバーがあります。

• コンス

• メソッド

• プロパティ

Constructor

ListItemオブジェクトでは、次のコンスがあります。

コンストラクター	説明
ListItem	Initializes a new instance of the SP.ListItem object.

メソッド

ListItemオブジェクトでは、次の方法があります。

メソッド	説明
deleteObject	Deletes the list item.
getUserEffectivePermissions	Gets the effective permissions that a specified user has on the list item.
getWOPIFrameUrl	Gets the full URL to the SharePoint frame page that initiates the SP.Utilities.SPWOPIFrameAction object with the WOPI application associated with the list item.
initNonPropertiesFromJson
loadExpandoFields	Initializes the extended properties associated with the list item.
parseAndSetFieldValue	Sets the value of the field for the list item based on an implementation specific transformation of the value.
削除済みデータします。	Moves the list item to the Recycle Bin and returns the identifier of the new Recycle Bin item.
refreshLoad	Reloads the extended properties associated with the list item.
更新プログラム	Commits changed properties of the list item.
validateUpdateListItem	Validates and sets the values of the specified collection of fields for the list item.

プロパティ

ListItemオブジェクトでは、次のプロパティがあります。

プロパティ	説明
attachmentFiles	Specifies the collection of attachments that are associated with the list item.
contentType	Gets a value that specifies the content type of the list item.
displayName	Gets a value that specifies the display name of the list item.
effectiveBasePermissions	Gets a value that specifies the effective permissions on the list item that are assigned to the current user.
effectiveBasePermissionsForUI	Gets the effective base permissions for the current user, as they should be displayed in UI.
fieldValues	Gets a collection of key/value pairs containing the names and values for the fields of the list item.
fieldValuesAsHtml	Gets the values for the list item as HTML.
fieldValuesAsText	Gets the list item's field values as a collection of string values.
fieldValuesForEdit	Gets the formatted values to be displayed in an edit form.
ファイル	Gets the file that is represented by the item from a document library.
fileSystemObjectType	Gets a value that specifies whether the list item is a file or a list folder.
フォルダー	Gets a folder object that is associated with a folder item.
id	Gets a value that specifies the list item identifier.
アイテム	Gets or sets the specified field value.
parentList	Gets the parent list that contains the list item.

注釈

CSOM expando フィールドには、親リスト内で定義されたフィールドに対応が含まれています。CSOM expando フィールド名が一覧で、定義されたフィールドの名前と CSOM expando フィールド値は、リスト アイテムのフィールドの値。次の表は、フィールドの種類と値の間のマッピングを定義します。

フィールドの種類	CSOM Expando フィールドの値の種類	意味
Integer	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM Int32 でなければなりません。	整数値を使用できます。
Text	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	テキストの長さが制限された文字列を使用できます。
注意	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	大量のテキストを使用できます。
DateTime	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM DateTime でなければなりません。	完全な日付、時刻の値と値が日付のみを使用できます。
Counter	CSOM Int32 でなければなりません。	一意の値のフィールド リストに保存されているその他の値を基準には、単純に増加整数フィールドを使用できます。反対はリスト アイテムの ID] フィールドにのみ使用し、は別の場所で使用できません。
選択肢	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	提案された値のセットから選択をできます。選択肢のフィールドには、フリー フォームの値がサポートされているかどうかを指定するフィールド レベルの設定がサポートしています。
Lookup	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM オブジェクトがあります。	別のリスト アイテムへの参照することができます。フィールドには、対象のリストのリストの識別子の仕様がサポートしています。省略可能なサイト ID を指定することも、ルックアップのターゲットを含むリストのサイトを指定します。
ブール型 (Boolean)	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM ブール場合があります。	trueまたはfalseの値を使用できます。
数値	その値が定義されている必要があります CSOM nullです。それ以外の場合、二重 CSOM 場合があります。	正または負の数値を使用できます。数値型フィールドには、フィールド レベル設定小数点の桁数を指定するために表示するがサポートしています。
通貨型	その値が定義されている必要があります CSOM nullです。それ以外の場合、二重 CSOM 場合があります。	通貨に関連するデータのことができます。[通貨] フィールドには、使用する通貨のロケール識別子を受け取るCurrencyLocaleIdプロパティがあります。
URL	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM オブジェクトがあります。	URL と、URL の説明 (オプション) ことができます。
Computed	該当なし	その他の列の値に基づいてレンダリング出力します。
Threading	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	ディスカッション掲示板にアイテムのスレッド上のデータが含まれています。
Guid	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM GUID があります。	フィールドの値が GUID であることを示します。
MultiChoice	その値が定義とCSOM null; 必要があります。それ以外の場合、CSOM 配列があります。	指定された選択肢のセットから 1 つまたは複数の値を使用します。 MultiChoiceフィールドには、フリー フォームの値もサポートできます。
GridChoice	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 配列があります。	リスト内の複数の数値のスケールの指定をサポートしています。
集計	該当なし	その他の列の値に基づいて計算されます。
ファイル	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	ファイルの内容を取得するために使用できるファイルへの参照を指定します。
添付物	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM ブール場合があります。	1 つまたは複数のファイルは、アイテムに関連付けられているかどうかについて説明します。true場合リストのアイテムを添付ファイル、およびfalse場合は、リスト アイテムがない添付ファイルです。
ユーザー	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM オブジェクトがあります。	ユーザー情報] ボックスの一覧で特定のユーザーへのルックアップが含まれています。
定期的なパターンの種類	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM ブール場合があります。	フィールドに、アイテムの定期的なパターンが含まれているかどうかを指定します。
CrossProjectLink	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM ブール場合があります。	会議ワークスペース サイトへのリンクをことができます。
ModStat	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM int32 でなければなりません。	ドキュメントの承認プロセスの現在の状態を指定します。
エラー	該当なし	エラーを指定します。値は 24 です。
ContentTypeId	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM オブジェクトがあります。	アイテムのコンテンツ タイプの ID が含まれています。ContentTypeIdはContentTypeIdで定義されている構造に準拠しています。
PageSeparator	該当なし	ページ区切りアンケート リスト内のプレース ホルダーを表します。PageSeparatorは、[アンケート] ボックスの一覧で使用する対象のみです。
ThreadIndex	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	ディスカッション掲示板のスレッドのコンパイル済みのインデックスが含まれています。
WorkflowStatus	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM Int32 でなければなりません。	特定の項目を実行中のワークフローの状態が表示されます。
AllDayEvent	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM ブール場合があります。	イベント リストと組み合わせてでのみ使用されます。trueアイテムが終日のイベントの場合 (つまり中は、実行されません特定の日の時間のセット)。
WorkflowEventType	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM Int32 でなければなりません。	ワークフローの履歴イベントの種類の説明です。詳細については、 WorkflowEventTypeEnumeration
機能	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 配列があります。	設備またはリソースを指定したグループの資産が表示されます。
FreeBusy	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	スケジュールの空き時間情報が含まれています。
Overbook	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	スケジュールの重複した予約情報が含まれています。
Confidential	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM ブール場合があります。	この回覧をだれに送信されたものだけが表示できるかどうかを示します。
WhatsNew	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM ブール場合があります。	個人用の現在のアイテムがグループ サイトに新しいかどうかを示します。
DueDate	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM DateTime でなければなりません。	日付と時刻のタスクが完了する予定が表示されます。
AllowEditing	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM ブール場合があります。	著者ではない、ユーザーがこのリソースの内容を編集できるかどうかを示します。
SendTo	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 配列である必要があります。	この回覧を送信するユーザーが含まれています。
確認	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	この回覧の確認情報が含まれています。
CallTo	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 配列があります。	このノートの情報を追跡する受信者が含まれています。
CallTime	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM DateTime でなければなりません。	日付と時刻をこの通話が行われた場合に含まれています。
Whereabout	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	ユーザーの場所が表示されます。
接続元	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM DateTime でなければなりません。	日付と時刻の状態の開始行き先時に含まれています。
まで	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM DateTime でなければなりません。	日付と行き先状態が終了する時刻が含まれています。
ContactInfo	その値が定義されている必要があります CSOM nullです。それ以外の場合、CSOM 文字列があります。	ユーザーの連絡先の一覧が表示されます。

例

次の例は、現在の Web サイトで知らせリストにアイテムを追加するアプリケーション ページのinputボタンを作成します。

<asp:Content ID="Main" ContentPlaceHolderID="PlaceHolderMain" runat="server">
<script type="text/ecmascript" language="ecmascript">

    function runCode() {

        var clientContext = new SP.ClientContext();
        var targetList = clientContext.get_web().get_lists().getByTitle('Announcements');
        var itemCreateInfo = new SP.ListItemCreationInformation();

        this.newListItem = targetList.addItem(itemCreateInfo);

        newListItem.set_item('Title', 'MyNewAnnouncement');
        newListItem.set_item('Body', 'Hello World!');
        newListItem.update();
        clientContext.load(newListItem);

        clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
    }

    function onQuerySucceeded() {

        alert('Announcement created!\n\nId: ' + newListItem.get_id() + '\nTitle: ' + newListItem.get_item('Title'));
    }

    function onQueryFailed(sender, args) {

        alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
    }

</script>

    <input id="Button1" type="button" value="Run Code" onclick="runCode()" />

</asp:Content>

他のリソースのエンドポイント

詳細については、リスト アイテムのリソースを参照してください。

エンドポイント URI 構造

http://<sitecollection>/<site>/_api/web/lists(listid)/items(itemid)

HTTP 要求

このリソースには、次の HTTP コマンドがサポートしています。

• 削除します。

書式を削除します。

DELETE http://<sitecollection>/<site>/_api/web/lists(listid)/items(itemid)

書式を結合します。

MERGE http://<sitecollection>/<site>/_api/web/lists(listid)/items(itemid)

投稿の書式

POST http://<sitecollection>/<site>/_api/web/lists(listid)/items(itemid)