REST を使用してリストとリスト アイテムを操作するWorking with lists and list items with REST

ヒント

SharePoint Online (およびオンプレミス SharePoint 2016 以降) REST サービスでは、OData $batch クエリ オプションを使って、サービスに対する複数の要求を 1 つの呼び出しに統合できます。The SharePoint Online (and on-premises SharePoint 2016 and later) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. 詳細とコード サンプルへのリンクについては、「REST API によりバッチ要求を発行する」を参照してください。For details and links to code samples, see Make batch requests with the REST APIs.

前提条件Prerequisites

このトピックでは、読者が「SharePoint REST サービスの概要」および「SharePoint REST エンドポイントを使用して基本的な操作を完了する」の各トピックに既に習熟していることを想定しています。This topic assumes that you are already familiar with the topics Get to know the SharePoint REST service and Complete basic operations using SharePoint REST endpoints. この記事にはコード スニペットが含まれていません。It does not provide code snippets.

REST を使用してリストおよびリスト プロパティを取得するRetrieving lists and list properties with REST

次の例は、GUID がわかっている場合に特定のリストを取得する方法を示しています。The following example shows how to retrieve a specific list if you know its GUID.

url: http://site url/_api/web/lists(guid'list GUID'),
method: GET
Headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"

注意

JSON での応答を望む場合は accept ヘッダーで application/json;odata=verbose を使用します。If you want the response in JSON, use application/json;odata=verbose in the accept header .

Atom 形式での応答を望む場合は accept ヘッダーで application/atom+xml を使用します。If you want the response in Atom format, use application/atom+xml in the accept header.


次の例は、タイトルがわかっている場合に特定のリストを取得する方法を示しています。The following example shows how to retrieve a specific list if you know its title.

url: http://site url/_api/web/lists/GetByTitle('Test')
method: GET
Headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"


次の XML は、XML コンテンツ タイプを要求したときに返されるリスト プロパティの例を示しています。The following XML shows an example of the list properties that are returned when you request the XML content type.

  <content type="application/xml">
  <m:properties>
  <d:AllowContentTypes m:type="Edm.Boolean">true</d:AllowContentTypes> 
  <d:BaseTemplate m:type="Edm.Int32">100</d:BaseTemplate> 
  <d:BaseType m:type="Edm.Int32">0</d:BaseType> 
  <d:ContentTypesEnabled m:type="Edm.Boolean">false</d:ContentTypesEnabled> 
  <d:Created m:type="Edm.DateTime">2012-06-26T23:15:58Z</d:Created> 
  <d:DefaultContentApprovalWorkflowId m:type="Edm.Guid">00000000-0000-0000-0000-000000000000</d:DefaultContentApprovalWorkflowId> 
  <d:Description>A list created by Project Based Retention used to store Project Policy Items.</d:Description> 
  <d:Direction>none</d:Direction> 
  <d:DocumentTemplateUrl m:null="true" /> 
  <d:DraftVersionVisibility m:type="Edm.Int32">0</d:DraftVersionVisibility> 
  <d:EnableAttachments m:type="Edm.Boolean">true</d:EnableAttachments> 
  <d:EnableFolderCreation m:type="Edm.Boolean">false</d:EnableFolderCreation> 
  <d:EnableMinorVersions m:type="Edm.Boolean">false</d:EnableMinorVersions> 
  <d:EnableModeration m:type="Edm.Boolean">false</d:EnableModeration> 
  <d:EnableVersioning m:type="Edm.Boolean">false</d:EnableVersioning> 
  <d:EntityTypeName>ProjectPolicyItemList</d:EntityTypeName> 
  <d:ForceCheckout m:type="Edm.Boolean">false</d:ForceCheckout> 
  <d:HasExternalDataSource m:type="Edm.Boolean">false</d:HasExternalDataSource> 
  <d:Hidden m:type="Edm.Boolean">true</d:Hidden> 
  <d:Id m:type="Edm.Guid">74de3ff3-029c-42f9-bd2a-1e9463def69d</d:Id> 
  <d:ImageUrl>/_layouts/15/images/itgen.gif</d:ImageUrl> 
  <d:IrmEnabled m:type="Edm.Boolean">false</d:IrmEnabled> 
  <d:IrmExpire m:type="Edm.Boolean">false</d:IrmExpire> 
  <d:IrmReject m:type="Edm.Boolean">false</d:IrmReject> 
  <d:IsApplicationList m:type="Edm.Boolean">false</d:IsApplicationList> 
  <d:IsCatalog m:type="Edm.Boolean">false</d:IsCatalog> 
  <d:IsPrivate m:type="Edm.Boolean">false</d:IsPrivate> 
  <d:ItemCount m:type="Edm.Int32">0</d:ItemCount> 
  <d:LastItemDeletedDate m:type="Edm.DateTime">2012-06-26T23:15:58Z</d:LastItemDeletedDate> 
  <d:LastItemModifiedDate m:type="Edm.DateTime">2012-06-26T23:15:59Z</d:LastItemModifiedDate> 
  <d:ListItemEntityTypeFullName>SP.Data.ProjectPolicyItemListItem</d:ListItemEntityTypeFullName> 
  <d:MultipleDataList m:type="Edm.Boolean">false</d:MultipleDataList> 
  <d:NoCrawl m:type="Edm.Boolean">true</d:NoCrawl> 
  <d:ParentWebUrl>/</d:ParentWebUrl> 
  <d:ServerTemplateCanCreateFolders m:type="Edm.Boolean">true</d:ServerTemplateCanCreateFolders> 
  <d:TemplateFeatureId m:type="Edm.Guid">00bfea71-de22-43b2-a848-c05709900100</d:TemplateFeatureId> 
  <d:Title>Project Policy Item List</d:Title> 
  </m:properties>
  </content>

注意

ListItemEntityTypeFullName プロパティ (前の例の SP.Data.ProjectPolicyItemListItem) は、リスト アイテムを作成して更新する場合に特に重要です。この値は、リスト アイテムを作成して更新するたびに HTTP 要求の本文に渡すメタデータの type プロパティとして渡す必要があります。The ListItemEntityTypeFullName property (SP.Data.ProjectPolicyItemListItem in the previous example) is especially important if you want to create and update list items. This value must be passed as the type property in the metadata that you pass in the body of the HTTP request whenever you create and update list items.


REST を使用してリストを操作するWorking with lists by using REST

次の例は、リストを作成する方法を示しています。The following example shows how to create a list.

url: http://site url/_api/web/lists
method: POST
body: { '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
 'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test' }
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body

次の例は、MERGE メソッドを使用してリストを更新する方法を示しています。The following example shows how to update a list by using the MERGE method.

url: http://site url/_api/web/lists(guid'list GUID')
method: POST
body: { '__metadata': { 'type': 'SP.List' }, 'Title': 'New title' }
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    IF-MATCH": etag or "*"
    X-HTTP-Method: MERGE,
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body

次の例は、リストのカスタム フィールドを作成する方法を示しています。The following example shows how to create a custom field for a list.

Url: url: http://site url/_api/web/lists(guid'list GUID')/Fields
Method:POST
Body: { '__metadata': { 'type': 'SP.Field' }, 'Title': 'field title', 'FieldTypeKind': FieldType value,'Required': 'true/false', 'EnforceUniqueValues': 'true/false','StaticName': 'field name'}
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    content-type: "application/json;odata=verbose"
    content-length:length of post body

次の例は、リストを削除する方法を示しています。The following example shows how to delete a list.

url: http://site url/_api/web/lists(guid'list GUID')
method: POST
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    IF-MATCH: etag or "*"
    X-HTTP-Method: DELETE


ルックアップ列の変更Lookup column changes

REST API を使用してリスト内のルックアップ列を参照するときは、内部名ではなくルックアップ列の表示名を使用します。When referring to a lookup column inside a list using REST API, use the display name of the lookup column instead of the internal name.

http://site url/_api/web/lists/getbytitle('ListName')/Items?&$filter=LookupColumnId eq 1


REST を使用してリスト アイテムを操作するWorking with list items by using REST

すべてのリスト アイテムを取得するRetrieve all list items

次の例は、リストのアイテムをすべて取得する方法を示しています。The following example shows how to retrieve all of a list's items.

注意

  • OData の $skip クエリ オプションは、リスト アイテムに対してクエリを実行するときは機能しません。The OData $skip query option does not work when querying list items. 多くの場合、代わりに $skiptoken オプションを使用することができます。In many situations, you can use the $skiptoken option instead.
  • 既定では、最初の 100 個のアイテムが返されます。By default, this will return the first 100 items. アイテム数、ページングなどの制御方法について詳しくは、OData クエリのオプションに関するドキュメントをご覧くださいMore information on controlling the # of items, paging, etc. see the documentation on OData Query options
url: http://site url/_api/web/lists/GetByTitle('Test')/items
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"

特定のリスト アイテムを取得するRetrieve specific list item

次の例は、特定のリスト アイテムを取得する方法を示しています。The following example shows how to retrieve a specific list item.

url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"


次の XML は、XML コンテンツ タイプを要求したときに返されるリスト アイテム プロパティの例を示しています。The following XML shows an example of the list item properties that are returned when you request the XML content type.

<content type="application/xml">
<m:properties> 
<d:FileSystemObjectType m:type="Edm.Int32">0</d:FileSystemObjectType>
<d:Id m:type="Edm.Int32">1</d:Id>
<d:ID m:type="Edm.Int32">1</d:ID>
<d:ContentTypeId>0x010049564F321A0F0543BA8C6303316C8C0F</d:ContentTypeId>
<d:Title>an item</d:Title>
<d:Modified m:type="Edm.DateTime">2012-07-24T22:47:26Z</d:Modified>
<d:Created m:type="Edm.DateTime">2012-07-24T22:47:26Z</d:Created>
<d:AuthorId m:type="Edm.Int32">11</d:AuthorId>
<d:EditorId m:type="Edm.Int32">11</d:EditorId>
<d:OData__UIVersionString>1.0</d:OData__UIVersionString>
<d:Attachments m:type="Edm.Boolean">false</d:Attachments>
<d:GUID m:type="Edm.Guid">eb6850c5-9a30-4636-b282-234eda8b1057</d:GUID>
</m:properties>
</content>

ストリームとしてアイテムを取得するRetrieve items as a stream

リストとそのデータに関する情報を取得します。Retrieves information about the list and its data. Lookup や管理されたメタデータなどの複雑なフィールドが使用されている場合は、この API を使用してリスト アイテムを取得できます。Using this API you can retrieve list items in case they use complex fields such as lookups or managed metadata.

POST /_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27

URI パラメーターURI parameters

次のプロパティは、返されるデータを操作するためのクエリ文字列パラメーターとして追加できます。Following properties can be added as query string parameters to manipulate the returned data.

プロパティProperty 説明Description Type Example
CascDelWarnMessage 連鎖削除の警告がある場合に、メッセージを表示するかどうかを指定します。Specifies if a message should be displayed if there is a cascade deletion warning numbernumber 1
DrillDown グループ化されたビューの一部のグループを展開するように指定します。Specifies that some groups in a grouped view is expanded. GroupString と共に使用します。Used with GroupString. stringstring
GroupString ドリルダウン機能で使用されるグループ ID です。Group identifier used for drill down feature. stringstring
HasOverrideSelectCommand SharePoint ListView コントロールが正常に動作するように特定のフィールドが存在していることを確認するために使用します。Used to ensure that certain fields are present for proper functioning of the SharePoint ListView control. stringstring
Field 含まれている必要がある特別なフィールドを指定します。Specifies a special field that should be included. stringstring
FieldInternalName リストに外部データ ソースがある時にフィールドを識別するために使用します。Used to identify a field when a list has an external data source. カスタム フィールドでフィルター処理する場合にも使用されます。Also used when filtering on a custom field. stringstring
Filter 要求されたビューにフィルターを適用するかどうかを指定します。Specifies whether the requested view should have a filter applied. stringstring
FilterData 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData1 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData2 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData3 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData4 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData5 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData6 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData7 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData8 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData9 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterData10 特定のフィルターで指定されたデータです。Data specified by a particular filter. stringstring
FilterField ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring
FilterField1 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField2 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField3 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField4 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField5 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField6 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField7 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField8 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField9 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField10 ビューに適用されている特定のフィルターのフィルター フィールド名です。A filter field name for a specific filter that is applied to the view. stringstring ID
FilterFields 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields1 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields2 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields3 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields4 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields5 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields6 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields7 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields8 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields9 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields10 乗数フィルターでフィルター処理する複数のフィールドを指定します。Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterValue 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring
FilterValue1 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue2 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue3 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue4 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue5 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue6 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue7 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue8 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue9 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue10 特定のフィルターに関連付けられているフィルターの値です。The filter value associated with a particular filter. 例えば、FilterField3 は FilterValue3 と関連付けられます。For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValues 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues1 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues2 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues3 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues4 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues5 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues6 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues7 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues8 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues9 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues10 乗数フィルターの FilterFields と使用します。Used with FilterFields for multiplier filter. 例えば、FilterFields3 は FilterValues3 と関連付けられます。For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterLookupId Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId1 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId2 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId3 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId4 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId5 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId6 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId7 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId8 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId9 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId10 Lookup フィールドでフィルター処理するときに使用します。Used when filtering on a lookup field. フィルター処理する値を含む外部リストのアイテム ID です。This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterOnly stringstring
FilterOp フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp1 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp2 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp3 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp4 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp5 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp6 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp7 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp8 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp9 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp10 フィルタ-演算子です。Filter operator. Eq (Geq、Leq など) 以外の、演算子を使用したフィルター処理をするときに使用します。Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
ID 情報を検索するアイテムのアイテム ID です。The item id of the item whose information is being sought. numbernumber
InplaceSearchQuery 全リスト検索用の語句です。Search term for a full list search. stringstring
InplaceFullListSearch 全リスト検索があるかどうかを指定するブール値です。A boolean that specifies whether there is a full list search. stringstring
IsCSR このビューが、クライアント側でレンダリングされたビューかどうかを指定します。Whether this view is a client side rendered view. stringstring
CustomAction stringstring
IsGroupRender SPView の IsGroupRender プロパティを設定するために使用します。Used to set the IsGroupRender property of the SPView. stringstring
IsRibbon stringstring
IsXslView このビューが XSLT リスト ビューかどうかを指定します。Whether this view is an xslt list view. stringstring
List stringstring
ListId stringstring
ListViewPageUrl stringstring
OverrideScope レンダリングされたビューのスコープを上書きするために使用します: SPView.ScopeUsed to override a scope on the rendered view: SPView.Scope stringstring
OverrideSelectCommand ビューで明示的に含まれているかどうかに関係なく、クエリに特定のフィールドが存在していることを確認するために使用します。Used to make sure that certain fields are present in the query regardless of whether they are explicitly included in the view. stringstring
PageFirstRow 要求する最初の行のページング情報です。Paging information about the first row that is requested. リスト ビューのページングのために使用します。Used for paging list views. stringstring
PageLastRow 要求する最後の行のページング情報です。Paging information about the last row that is requested. リスト ビューのページングのために使用します。Used for paging list views. stringstring
RootFolder ビューが表示しているフォルダーです。The folder that the view is displaying. stringstring
SortField ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField1 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField2 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField3 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField4 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField5 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField6 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField7 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField8 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField9 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortField10 ビューで並べ替えるべきフィールドです。A field that the view should be sorted on. stringstring ID
SortFields 最初に並べ替えるフィールドの名前を指定します。Specifies the name of the first field to sort by stringstring
SortFieldValues 最初に並べ替えるフィールドの名前を指定します。Specifies the name of the first field to sort by stringstring
SortDir ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir1 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir2 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir3 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir4 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir5 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir6 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir7 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir8 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir9 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir10 ビューに適用するアドホック並べ替えの方向です。The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
View リストを表示するときに使用するベース ビューを指定します。Specifies the base view that will be used to render the list. GUIDGUID 3d13559e-3071-5000-76b8-8f1ca6b835f0
ViewPath リストを表示するときに使用するビューのパスを指定します。Specifies the path of the view that will be used to render the list. ViewId を指定した場合は ViewId が使用され、このパラメーターは無視されます。If ViewId is given then the ViewId will be used and this parameters will be ignored. stringstring
ViewCount 複数のリスト ビューがページにある場合、それらのいずれかを識別します。When multiple list views are on a page, this identifies one of them. stringstring
ViewId リストを表示するときに使用するベース ビューを指定します。Specifies the base view that will be used to render the list. アドホック パラメーターが、このビューの上に適用されます。ad-hoc parameters will be applied on top of this view. ViewXml および BaseViewId を指定した場合は ViewXml が使用され、アドホック パラメーターは無視されます。If both ViewXml and BaseViewId are given then the ViewXml will be used and the ad-hoc parameters will be ignored. stringstring
WebPartId このビューを表示しているリスト ビュー Web パーツの ID です。The id of the list view web part that is showing this view. stringstring

要求ヘッダーRequest headers

ヘッダーHeader Value
AcceptAccept application/json;odata=nometadataapplication/json;odata=nometadata
Content-TypeContent-Type application/json;odata=nometadataapplication/json;odata=nometadata

要求本文Request body

{
    "parameters": {
        "AddRequiredFields": "true",
        "DatesInUtc": "true",
        "RenderOptions": 17
    }
}
プロパティProperty 説明Description Type Example
AddRequiredFields 必要なフィールドが返されるべきかどうかを指定します。Specifies if required fields should be returned or not boolbool true
AllowMultipleValueFilterForTaxonomyFields 分類フィールドの複数値のフィルター処理が許可されているかどうかを指定します。Specifies if multi value filtering is allowed for taxonomy fields or not boolbool true
DatesInUtc DateTime フィールドを UTC と現地時刻のどちらで返すかを指定します。Specifies if we return DateTime field in UTC or local time. boolbool true
ExpandGroups グループを展開するかどうかを指定します。Specifies if the grouping should be expanded or not. boolbool true
FirstGroupOnly ビュー スキーマに関係なく、最初のグループだけを返すかどうかを指定します。Specifies if only the first group should be returned or not (regardless of view schema). boolbool true
FolderServerRelativeUrl アイテムを返すフォルダーへの URL を指定します。Specifies the url to the folder from which to return items. stringstring /sites/team-a/lists/Orders/Europe
ImageFieldsToTryRewriteToCdnUrls CDN の URL に値を書き直す必要があるフィールド名のコンマ区切りリストです。Comma-separated list of field names whose values should be rewritten to CDN URLs stringstring ArticleImage,SecondaryImage
OverrideViewXml ビュー CAML と共に使用する上書き XML を指定します。Specifies the override XML to be combined with the View CAML. ビュー CAML の Query/Where パーツのみに適用されます。Applies only to the Query/Where part of the View CAML. stringstring <Query><Where><Gt><FieldRef Name=\"OrderCount\" /><Value Type=\"Number\">3</Value></Gt></Where></Query>
Paging ページング情報を指定します。Specifies the paging information. stringstring
RenderOptions 返される出力の種類を指定します。Specifies the type of output to return. SPRenderListDataOptionsSPRenderListDataOptions 使用可能な値については、次のセクションを参照してください。See the next section for possible values. 値を加算することで複数の値を指定することができます。You can specify multiple values by adding their values together
ReplaceGroup GroupBy 調整のために、グループ化を置き換えるべきかどうかを指定します。Specifies if the grouping should be replaced or not to deal with GroupBy throttling. boolbool true
ViewXml CAML ビュー XML を指定します。Specifies the CAML view XML. stringstring
SPRenderListDataOptionsSPRenderListDataOptions
ラベルLabel 説明Description Value
None 既定の出力を返します。Return default output 0
ContextInfo リストのコンテキスト情報を返します。Return list context information 1
ListData リスト データを返します (None と同じ)。Return list data (same as None) 2
ListSchema リストのスキーマを返します。Return list schema 4
MenuView リスト メニューの HTML を返します。Return HTML for the list menu 8
ListContentType リストのコンテンツ タイプの情報を返します。Returns information about list content types. ContextInfo フラグと共に使用する必要があります。Must be combined with the ContextInfo flag 16
FileSystemItemId 返されたリストには、可能であれば各アイテムの FileSystemItemId フィールドが含まれます。The returned list will have a FileSystemItemId field on each item if possible. ListData フラグと共に使用する必要があります。Must be combined with the ListData flag 32
ClientFormSchema アイテムを追加および編集するためのクライアント フォーム スキーマを返します。Returns the client form schema to add and edit items. 64
QuickLaunch QuickLaunch ナビゲーション ノードを返します。Returns QuickLaunch navigation nodes. 128
Spotlight Spotlight レンダリング情報を返します。Returns Spotlight rendering information. 256
Visualization Visualization レンダリング情報を返します。Returns Visualization rendering information. 512
ViewMetadata 現在のビューのビュー XML などの情報を返します。Returns view XML and other information about the current view. 1024
DisableAutoHyperlink このクエリ内のテキスト フィールドに AutoHyperlink が実行されないようにします。Prevents AutoHyperlink from being run on text fields in this query. 2048
EnableMediaTAUrls .thumbnailUrl、.videoManifestUrl、.pdfConversionUrls などの Media TA サービスを指す URL を有効にします。Enables URLs pointing to Media TA service, such as .thumbnailUrl, .videoManifestUrl, .pdfConversionUrls. 4096
ParentInfo 親フォルダーの情報を返します。Returns parent folder information. 8192
PageContextInfo 表示されている現在のリストのページ コンテキスト情報を返します。Returns page context info for the current list being rendered. 16384
ClientSideComponentManifest リストに関連付けられているクライアント側のコンポーネント マニフェスト情報を返します。Return client-side component manifest information associated with the list. 将来使用するために予約されています。Reserved for future use 32768

Examples

特定の ID を持つアイテムを取得するRetrieve item with specific ID

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27&FilterField1=ID&FilterValue1=1
accept: application/json;odata=nometadata

ID で降順にアイテムを並べ替えるSort items descending by ID

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27&SortField=ID&SortDir=Desc
accept: application/json;odata=nometadata

指定したフォルダーからアイテムを取得するRetrieve items from the specified folder

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FOrders%27
accept: application/json;odata=nometadata
content-type: application/json;odata=nometadata

{
    "parameters": {
        "FolderServerRelativeUrl": "/sites/team-a/lists/Orders/Europe"
    }
}

リスト スキーマを取得するRetrieve list schema

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27
accept: application/json;odata=nometadata
content-type: application/json;odata=nometadata

{
    "parameters": {
        "RenderOptions": 4
    }
}

リストのコンテンツ タイプの情報を取得するRetrieve information about list content types

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27
accept: application/json;odata=nometadata
content-type: application/json;odata=nometadata

{
    "parameters": {
        "RenderOptions": 17
    }
}

リスト アイテムの作成Create list item

次の例は、リスト アイテムを作成する方法を示しています。The following example shows how to create a list item.

注意

この操作を実行するには、リストの ListItemEntityTypeFullName プロパティを知っていて、それを HTTP 要求本文の type の値として渡す必要があります。To do this operation, you must know the ListItemEntityTypeFullName property of the list and pass that as the value of type in the HTTP request body. 以下は、ListItemEntityTypeFullName を取得するための残りの呼び出しのサンプルFollowing is a sample rest call to get the ListItemEntityTypeFullName

url: http://site url/_api/web/lists/GetByTitle('Test')?$select=ListItemEntityTypeFullName,
method: GET
Headers:
   Authorization: "Bearer " + accessToken
   accept: "application/json;odata=verbose" or "application/atom+xml"
url: http://site url/_api/web/lists/GetByTitle('Test')/items
method: POST
body: { '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'Test'}
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body

フォルダー内にリスト アイテムを作成するCreate list item in a folder

次の例は、フォルダー内にリスト アイテムを作成する方法を示しています。The following example shows how to create a list item in a folder.

POST /_api/web/lists/GetByTitle('Test')/AddValidateUpdateItemUsingPath

URI パラメーターURI parameters

なしNone

要求ヘッダーRequest headers

ヘッダーHeader Value
AcceptAccept application/json;odata=nometadataapplication/json;odata=nometadata
Content-TypeContent-Type application/json;odata=nometadataapplication/json;odata=nometadata
x-requestdigestx-requestdigest 現在のサイトの適切なダイジェストThe appropriate digest for current site

要求本文Request body

{
    "listItemCreateInfo": {
        "FolderPath":  { "DecodedUrl": "https://contoso.sharepoint.com/lists/Test/Folder/SubFolder" },
        "UnderlyingObjectType": 0
    },
    "formValues": [
        {
            "FieldName": "Title",
            "FieldValue": "Item"
        }
    ],
    "bNewDocumentUpdate": false
}
プロパティProperty 説明Description
listItemCreateInfolistItemCreateInfo アイテムを作成するリストおよびフォルダーに関する情報ですInformation about the list and folder where the item should be created
listItemCreateInfo.FolderPath.DecodedUrllistItemCreateInfo.FolderPath.DecodedUrl アイテムを作成するフォルダーの絶対 URL ですAbsolute URL of the folder where the item should be created
listItemCreateInfo.UnderlyingObjectTypelistItemCreateInfo.UnderlyingObjectType 作成するアイテムの種類です。Type of item to create. 詳細については、https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.filesystemobjecttype(v=office.14).aspx を参照してください。For more information see https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.filesystemobjecttype(v=office.14).aspx
formValuesformValues 新しく作成されたアイテムに設定するフィールド名と値の配列ですArray of field names and values to set on the newly created item
bNewDocumentUpdatebNewDocumentUpdate リスト アイテムを作成するには false に設定しますSet to false to create a list item

応答Responses

名前Name 種類Type 説明Description
200 OK200 OK ブール型Boolean 成功Success
{
  "value": [
    {
      "ErrorMessage": null,
      "FieldName": "Title",
      "FieldValue": "Item",
      "HasException": false,
      "ItemId": 0
    },
    {
      "ErrorMessage": null,
      "FieldName": "Id",
      "FieldValue": "1",
      "HasException": false,
      "ItemId": 0
    }
  ]
}

value プロパティには、リスト アイテムを作成するときに設定されたプロパティの一覧が含まれています。The value property contains the list of properties that have been set when creating the list item.

リスト アイテムを更新するUpdate list item

次の例は、リスト アイテムを更新する方法を示しています。The following example shows how to update a list item.

注意

この操作を実行するには、リストの ListItemEntityTypeFullName プロパティを知っていて、それを HTTP 要求本文の type の値として渡す必要があります。To do this operation, you must know the ListItemEntityTypeFullName property of the list and pass that as the value of type in the HTTP request body.

url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
method: POST
body: { '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'TestUpdated'}
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    "IF-MATCH": etag or "*"
    "X-HTTP-Method":"MERGE",
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body

リスト アイテムを削除するDelete list item

次の例は、リスト アイテムを削除する方法を示しています。The following example shows how to delete a list item.

url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
method: POST
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    "IF-MATCH": etag or "*"
    "X-HTTP-Method":"DELETE"


ETag 値を使用してドキュメントとリスト アイテムのバージョンを確認するUsing ETag values to determine document and list item versioning

SharePoint REST サービス (OData 標準に準拠) は、SharePoint リストとリスト アイテムの Header ETags を使用します。The SharePoint REST service, which follows the OData standard, uses Header ETags of SharePoint lists and list items. PUTMERGEDELETE 要求を実行するときにアイテムのバージョンを確認するには、If-Match HTTP 要求ヘッダーで ETag を指定します。To check on an item's version when you perform a PUT, MERGE, or DELETE request, specify an ETag in the If-Match HTTP request header.

要求に指定した ETag がサーバー上のドキュメントまたはリスト項目の ETag と一致しない場合、OData 仕様に従い、REST サービスによって 412 例外が返されます。If the ETag you specify in your request does not match the ETag of the document or list item on the server, the REST service returns a 412 exception, per the OData specification.

  • バージョンの違いにかかわらず、アイテムを強制的に上書きするには、ETag の値に "*" を設定します。To force an overwrite of the item regardless of version, set the ETag value to "*".

  • ETag を指定しない場合、SharePoint は、バージョンの違いにかかわらずアイテムを上書きします。If you do not specify an ETag, SharePoint overwrites the item regardless of version.

SharePoint 内で、ETag は SharePoint リストとリスト項目にのみ適用されます。Within SharePoint, ETags apply only to SharePoint lists and list items.

関連項目See also