Trabajar con listas y elementos de lista mediante RESTWorking with lists and list items with REST

Sugerencia

El servicio REST de SharePoint Online (y SharePoint 2016 local o versiones posteriores) admite la combinación de varias solicitudes en una sola llamada al servicio mediante la opción de consulta $batch de OData. Para obtener más información y vínculos a los ejemplos de código, vea Realizar solicitudes de lote con las API REST.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. For details and links to code samples, see Make batch requests with the REST APIs.

Requisitos previosPrerequisites

En este tema se presupone que ya está familiarizado con los temas Introducción al servicio REST para SharePoint y Completar operaciones básicas con puntos de conexión REST de SharePoint. No se proporcionan fragmentos de código.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.

Recuperar listas y propiedades de listas con RESTRetrieving lists and list properties with REST

En el siguiente ejemplo se muestra cómo recuperar una lista concreta si se conoce su 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"

Nota

Use application/json;odata=verbose en el encabezado accept si quiere la respuesta en JSON.If you want the response in JSON, use application/json;odata=verbose in the accept header .

Use application/atom+xml en el encabezado accept si quiere que la respuesta esté en formato Atom.If you want the response in Atom format, use application/atom+xml in the accept header.


En el siguiente ejemplo se muestra cómo recuperar una lista concreta si se conoce su título.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"


En el siguiente XML se muestra un ejemplo de las propiedades de lista que se devuelven cuando se solicita el tipo de contenido 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>

Nota

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.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.


Trabajar con listas mediante RESTWorking with lists by using REST

En el siguiente ejemplo se muestra cómo crear una lista.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

En el siguiente ejemplo se muestra cómo actualizar una lista con el método 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

En el siguiente ejemplo se muestra cómo crear un campo personalizado para una lista.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

En el siguiente ejemplo se muestra cómo eliminar una lista.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


Cambios de columna de búsquedaLookup column changes

Al hacer referencia a una columna de búsqueda en una lista con las API de REST, use el nombre para mostrar de la columna de búsqueda en lugar del nombre interno.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


Trabajar con elementos de lista mediante RESTWorking with list items by using REST

Recuperar todos los elementos de listaRetrieve all list items

En el siguiente ejemplo se muestra cómo recuperar todos los elementos de una lista.The following example shows how to retrieve all of a list's items.

Nota

  • La opción de consulta $skip de OData no funciona al consultar elementos de lista.The OData $skip query option does not work when querying list items. En muchas situaciones, puede usar la opción $skiptoken en su lugar.In many situations, you can use the $skiptoken option instead.
  • De forma predeterminada, esto devolverá los 100 primeros elementos.By default, this will return the first 100 items. Para obtener más información sobre cómo controlar el número de elementos, la paginación, etc., vea la documentación de Opciones de consulta de ODataMore 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"

Recuperar un elemento de lista concretoRetrieve specific list item

En el siguiente ejemplo se muestra cómo recuperar un elemento de lista concretoThe 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"


En el XML siguiente se muestra un ejemplo de las propiedades de elemento de lista que se devuelven cuando se solicita el tipo de contenido 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>

Recuperar elementos como una secuenciaRetrieve items as a stream

Recupera información sobre la lista y sus datos.Retrieves information about the list and its data. Con esta API puede recuperar elementos de lista si usa campos complejos, como búsquedas o metadatos administrados.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

Parámetros de URIURI parameters

Las propiedades siguientes se pueden agregar como parámetros de la cadena de consulta para manipular los datos devueltos.Following properties can be added as query string parameters to manipulate the returned data.

PropiedadProperty DescripciónDescription TipoType EjemploExample
CascDelWarnMessage Especifica si se debe mostrar un mensaje en caso de que haya una advertencia de eliminación en cascada.Specifies if a message should be displayed if there is a cascade deletion warning numbernumber 1
DrillDown Especifica que algunos grupos de una vista agrupada se expanden.Specifies that some groups in a grouped view is expanded. Se usa con GroupString.Used with GroupString. stringstring
GroupString Identificador de grupo que se usa para la característica de explorar en profundidad.Group identifier used for drill down feature. stringstring
HasOverrideSelectCommand Se usa para garantizar que existen campos específicos para el correcto funcionamiento del control ListView de SharePoint.Used to ensure that certain fields are present for proper functioning of the SharePoint ListView control. stringstring
Field Especifica un campo especial que debe incluirse.Specifies a special field that should be included. stringstring
FieldInternalName Se usa para identificar un campo cuando una lista tiene un origen de datos externo.Used to identify a field when a list has an external data source. También se usa al filtrar en un campo personalizado.Also used when filtering on a custom field. stringstring
Filter Especifica si la vista solicitada debe tener un filtro aplicado.Specifies whether the requested view should have a filter applied. stringstring
FilterData Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData1 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData2 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData3 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData4 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData5 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData6 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData7 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData8 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData9 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterData10 Datos especificados por un filtro concreto.Data specified by a particular filter. stringstring
FilterField Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring
FilterField1 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField2 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField3 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField4 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField5 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField6 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField7 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField8 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField9 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterField10 Nombre de campo de filtro para un filtro específico aplicado a la vista.A filter field name for a specific filter that is applied to the view. stringstring ID
FilterFields Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields1 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields2 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields3 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields4 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields5 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields6 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields7 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields8 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields9 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterFields10 Especifica varios campos que se filtran para un filtro multiplicador.Specifies multiple fields that are being filtered on for a multiplier filter. stringstring
FilterValue Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring
FilterValue1 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue2 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue3 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue4 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue5 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue6 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue7 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue8 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue9 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValue10 Valor de filtro asociado a un filtro concreto.The filter value associated with a particular filter. Por ejemplo, FilterField3 se corresponde con FilterValue3, etc.For example, FilterField3 goes with FilterValue3 and so forth. stringstring 1
FilterValues Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues1 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues2 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues3 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues4 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues5 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues6 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues7 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues8 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues9 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterValues10 Se usa con FilterFields para un filtro multiplicador.Used with FilterFields for multiplier filter. Por ejemplo, FilterFields3 se corresponde con FilterValues3, etc.For example, FilterFields3 would go with FilterValues3 and so forth. stringstring
FilterLookupId Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId1 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId2 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId3 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId4 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId5 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId6 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId7 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId8 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId9 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterLookupId10 Se usa al filtrar en un campo de búsqueda.Used when filtering on a lookup field. Este es el identificador de elemento de la lista externa que tiene un valor que se está filtrando.This is the item id in the foreign list that has a value that is being filtered on. stringstring
FilterOnly stringstring
FilterOp Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp1 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp2 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp3 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp4 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp5 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp6 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp7 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp8 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp9 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
FilterOp10 Operador de filtro.Filter operator. Se usa al filtrar con operadores que no sean Eq (Geq, Leq, etc.).Used when filtering with other operators than Eq (Geq, Leq etc.) stringstring Geq
ID Identificador del elemento cuya información se está buscando.The item id of the item whose information is being sought. numbernumber
InplaceSearchQuery Término de búsqueda para una búsqueda de lista completa.Search term for a full list search. stringstring
InplaceFullListSearch Valor booleano que especifica si existe una búsqueda de lista completa.A boolean that specifies whether there is a full list search. stringstring
IsCSR Indica si es una vista con representación del lado cliente.Whether this view is a client side rendered view. stringstring
CustomAction stringstring
IsGroupRender Se usa para establecer la propiedad IsGroupRender de SPView.Used to set the IsGroupRender property of the SPView. stringstring
IsRibbon stringstring
IsXslView Indica si es una vista de lista xslt.Whether this view is an xslt list view. stringstring
List stringstring
ListId stringstring
ListViewPageUrl stringstring
OverrideScope Se usa para invalidar un ámbito de la vista representada: SPView.Scope.Used to override a scope on the rendered view: SPView.Scope stringstring
OverrideSelectCommand Se usa para asegurarse de que determinados campos están presentes en la consulta independientemente de si están incluidos de manera explícita en la vista.Used to make sure that certain fields are present in the query regardless of whether they are explicitly included in the view. stringstring
PageFirstRow Información de paginación sobre la primera fila que se ha solicitado.Paging information about the first row that is requested. Se usa para paginar vistas de lista.Used for paging list views. stringstring
PageLastRow Información de paginación sobre la última fila que se ha solicitado.Paging information about the last row that is requested. Se usa para paginar vistas de lista.Used for paging list views. stringstring
RootFolder Carpeta mostrada por la vista.The folder that the view is displaying. stringstring
SortField Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField1 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField2 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField3 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField4 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField5 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField6 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField7 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField8 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField9 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortField10 Campo según el cual debe ordenarse la vista.A field that the view should be sorted on. stringstring ID
SortFields Especifica el nombre del primer campo según el cual se debe ordenar.Specifies the name of the first field to sort by stringstring
SortFieldValues Especifica el nombre del primer campo según el cual se debe ordenar.Specifies the name of the first field to sort by stringstring
SortDir Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir1 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir2 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir3 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir4 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir5 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir6 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir7 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir8 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir9 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
SortDir10 Dirección de ordenación de una ordenación ad hoc que se aplica a la vista.The sort direction of an ad hoc sort that is being applied to the view. stringstring Desc
View Especifica la vista base que se usará para representar la lista.Specifies the base view that will be used to render the list. GUIDGUID 3d13559e-3071-5000-76b8-8f1ca6b835f0
ViewPath Especifica la ruta de la vista que se usará para representar la lista.Specifies the path of the view that will be used to render the list. Si se indica ViewId, se usará ViewId y se omitirán estos parámetros.If ViewId is given then the ViewId will be used and this parameters will be ignored. stringstring
ViewCount Cuando hay varias vistas de lista en una página, identifica una de ellas.When multiple list views are on a page, this identifies one of them. stringstring
ViewId Especifica la vista base que se usará para representar la lista.Specifies the base view that will be used to render the list. Los parámetros ad hoc se aplicarán sobre esta vista.ad-hoc parameters will be applied on top of this view. Si se indican ViewXml y BaseViewId, se usará ViewXml y se omitirán estos parámetros ad hoc.If both ViewXml and BaseViewId are given then the ViewXml will be used and the ad-hoc parameters will be ignored. stringstring
WebPartId Identificador del elemento web de vista de lista que se muestra en esta vista.The id of the list view web part that is showing this view. stringstring

Encabezados de solicitudRequest headers

EncabezadoHeader ValorValue
AcceptAccept application/json;odata=nometadataapplication/json;odata=nometadata
Content-TypeContent-Type application/json;odata=nometadataapplication/json;odata=nometadata

Cuerpo de la solicitudRequest body

{
    "parameters": {
        "AddRequiredFields": "true",
        "DatesInUtc": "true",
        "RenderOptions": 17
    }
}
PropiedadProperty DescripciónDescription TipoType EjemploExample
AddRequiredFields Especifica si se deben devolver campos obligatorios.Specifies if required fields should be returned or not boolbool true
AllowMultipleValueFilterForTaxonomyFields Especifica si se permite el filtrado de varios valores para campos de taxonomía.Specifies if multi value filtering is allowed for taxonomy fields or not boolbool true
DatesInUtc Especifica si el campo DateTime se devuelve en UTC o en hora local.Specifies if we return DateTime field in UTC or local time. boolbool true
ExpandGroups Especifica si se debe expandir la agrupación.Specifies if the grouping should be expanded or not. boolbool true
FirstGroupOnly Especifica si solo se debe devolver el primer grupo (independientemente del esquema de la vista).Specifies if only the first group should be returned or not (regardless of view schema). boolbool true
FolderServerRelativeUrl Especifica la dirección URL de la carpeta desde la que se van a devolver elementos.Specifies the url to the folder from which to return items. stringstring /sites/team-a/lists/Orders/Europe
ImageFieldsToTryRewriteToCdnUrls Lista de nombres de campo separados por comas cuyos valores se deben reescribir en direcciones URL de la red CDN.Comma-separated list of field names whose values should be rewritten to CDN URLs stringstring ArticleImage,SecondaryImage
OverrideViewXml Especifica el XML de invalidación que se va a combinar con la vista CAML.Specifies the override XML to be combined with the View CAML. Solo se aplica a la parte Query/Where de la vista CAML.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 Especifica la información de paginación.Specifies the paging information. stringstring
RenderOptions Especifica el tipo de salida que se va a devolver.Specifies the type of output to return. SPRenderListDataOptionsSPRenderListDataOptions Vea en la sección siguiente los valores posibles.See the next section for possible values. Puede especificar varios valores si los suma.You can specify multiple values by adding their values together
ReplaceGroup Especifica si se debe reemplazar la agrupación para controlar la limitación GroupBy.Specifies if the grouping should be replaced or not to deal with GroupBy throttling. boolbool true
ViewXml Especifica el XML de la vista CAML.Specifies the CAML view XML. stringstring
SPRenderListDataOptionsSPRenderListDataOptions
EtiquetaLabel DescripciónDescription ValorValue
None Devuelve la salida predeterminada.Return default output 0
ContextInfo Devuelve información de contexto de lista.Return list context information 1
ListData Devuelve datos de lista (igual que None).Return list data (same as None) 2
ListSchema Devuelve el esquema de lista.Return list schema 4
MenuView Devuelve el código HTML para el menú de lista.Return HTML for the list menu 8
ListContentType Devuelve información sobre los tipos de contenido de lista.Returns information about list content types. Se debe combinar con la marca ContextInfo.Must be combined with the ContextInfo flag 16
FileSystemItemId La lista devuelta tendrá un campo FileSystemItemId en cada elemento, si es posible.The returned list will have a FileSystemItemId field on each item if possible. Se debe combinar con la marca ListData.Must be combined with the ListData flag 32
ClientFormSchema Devuelve el esquema de formulario de cliente para agregar y editar elementos.Returns the client form schema to add and edit items. 64
QuickLaunch Devuelve los nodos de navegación de Inicio rápido.Returns QuickLaunch navigation nodes. 128
Spotlight Devuelve información de representación de contenido destacado.Returns Spotlight rendering information. 256
Visualization Devuelve información de representación de visualización.Returns Visualization rendering information. 512
ViewMetadata Devuelve el XML de la vista y otra información sobre la vista actual.Returns view XML and other information about the current view. 1024
DisableAutoHyperlink Impide que AutoHyperlink se ejecute en los campos de texto de esta consulta.Prevents AutoHyperlink from being run on text fields in this query. 2048
EnableMediaTAUrls Permite las direcciones URL que apuntan al servicio TA multimedia, como .thumbnailUrl, .videoManifestUrl y .pdfConversionUrls.Enables URLs pointing to Media TA service, such as .thumbnailUrl, .videoManifestUrl, .pdfConversionUrls. 4096
ParentInfo Devuelve información de la carpeta principal.Returns parent folder information. 8192
PageContextInfo Devuelve información contextual de página de la lista actual que se va a representar.Returns page context info for the current list being rendered. 16384
ClientSideComponentManifest Devuelve información del manifiesto de componente del cliente asociada a la lista.Return client-side component manifest information associated with the list. Reservado para uso posterior.Reserved for future use 32768

EjemplosExamples

Recuperar un elemento con un ID específicoRetrieve 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

Ordenar elementos de manera descendente por IDSort 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

Recuperar elementos desde la carpeta especificadaRetrieve 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"
    }
}

Recuperar el esquema de listaRetrieve 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
    }
}

Recuperar información sobre los tipos de contenido de listaRetrieve 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
    }
}

Crear elemento de listaCreate list item

En el siguiente ejemplo se muestra cómo crear un elemento de lista.The following example shows how to create a list item.

Nota

Para ejecutar esta operación, debe saber la propiedad ListItemEntityTypeFullName de la lista y pasarla como valor de type en el cuerpo de la solicitud HTTP.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
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

Crear elemento de lista en una carpetaCreate list item in a folder

En el siguiente ejemplo se muestra cómo crear un elemento de lista en una carpeta.The following example shows how to create a list item in a folder.

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

Parámetros de URIURI parameters

NingunoNone

Encabezados de solicitudRequest headers

EncabezadoHeader ValorValue
AcceptAccept application/json;odata=nometadataapplication/json;odata=nometadata
Content-TypeContent-Type application/json;odata=nometadataapplication/json;odata=nometadata
x-requestdigestx-requestdigest Resumen adecuado del sitio actualThe appropriate digest for current site

Cuerpo de la solicitudRequest body

{
    "listItemCreateInfo": {
        "FolderPath":  { "DecodedUrl": "https://contoso.sharepoint.com/lists/Test/Folder/SubFolder" },
        "UnderlyingObjectType": 0
    },
    "formValues": [
        {
            "FieldName": "Title",
            "FieldValue": "Item"
        }
    ],
    "bNewDocumentUpdate": false
}
PropiedadProperty DescripciónDescription
listItemCreateInfolistItemCreateInfo Información sobre la lista y la carpeta en la que se debe crear el elemento.Information about the list and folder where the item should be created
listItemCreateInfo.FolderPath.DecodedUrllistItemCreateInfo.FolderPath.DecodedUrl Dirección URL absoluta de la carpeta en la que se debe crear el elemento.Absolute URL of the folder where the item should be created
listItemCreateInfo.UnderlyingObjectTypelistItemCreateInfo.UnderlyingObjectType Tipo de elemento que se va a crear.Type of item to create. Para más información, vea 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 Matriz de valores y nombres de campo que se establecen en el elemento recién creado.Array of field names and values to set on the newly created item
bNewDocumentUpdatebNewDocumentUpdate Se establece en false para crear un elemento de lista.Set to false to create a list item

RespuestasResponses

NombreName TipoType DescripciónDescription
200 Correcto200 OK BooleanBoolean CorrectoSuccess
{
  "value": [
    {
      "ErrorMessage": null,
      "FieldName": "Title",
      "FieldValue": "Item",
      "HasException": false,
      "ItemId": 0
    },
    {
      "ErrorMessage": null,
      "FieldName": "Id",
      "FieldValue": "1",
      "HasException": false,
      "ItemId": 0
    }
  ]
}

La propiedad value contiene la lista de propiedades que se han establecido al crear el elemento de lista.The value property contains the list of properties that have been set when creating the list item.

Actualizar elemento de listaUpdate list item

En el siguiente ejemplo se muestra cómo actualizar un elemento de lista.The following example shows how to update a list item.

Nota

Para ejecutar esta operación, debe saber la propiedad ListItemEntityTypeFullName de la lista y pasarla como valor de type en el cuerpo de la solicitud HTTP.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

Eliminar elemento de listaDelete list item

En el siguiente ejemplo se muestra cómo eliminar un elemento de lista.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"


Uso de valores ETag para el control de versiones en documentos y elementos de listaUsing ETag values to determine document and list item versioning

El servicio REST de SharePoint, que cumple el estándar OData, usa Etags de encabezado de las listas y los elementos de lista de SharePoint.The SharePoint REST service, which follows the OData standard, uses Header ETags of SharePoint lists and list items. Para comprobar la versión de un elemento al efectuar una solicitud PUT, MERGE o DELETE, especifique una ETag en el encabezado de la solicitud HTTP If-Match.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.

Si la ETag especificada en la solicitud no coincide con la ETag del documento o con el elemento de lista del servidor, el servicio REST devolverá una excepción 412, de acuerdo con la especificación OData.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.

  • Para forzar una sobrescritura del elemento independientemente de la versión, establezca el valor de la ETag en "*".To force an overwrite of the item regardless of version, set the ETag value to "*".

  • Si no especifica ninguna ETag, SharePoint sobrescribirá el elemento independientemente de la versión.If you do not specify an ETag, SharePoint overwrites the item regardless of version.

En SharePoint, las ETags solo se aplican a las listas y a los elementos de lista de SharePoint.Within SharePoint, ETags apply only to SharePoint lists and list items.

Vea tambiénSee also