Referencia de API de REST de listas y elementos de lista

Obtenga información sobre listas, elementos de vistas, vistas y otros recursos relacionados con listas y extremos en la API de REST.

Última modificación: jueves, 17 de septiembre de 2015

Hace referencia a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Acerca de los ejemplos de solicitudes en este artículo

En los ejemplos de solicitud en este artículo, se supone que está utilizando la biblioteca entre dominios (SP.RequestExecutor.js) para realizar las solicitudes entre dominios, por lo que usan SP.AppContextSite en el URI del extremo. Consulte Cómo obtener acceso a los datos de SharePoint 2013 desde aplicaciones con la biblioteca entre dominios para obtener más informacion.

Antes de usar un ejemplo de solicitud, realice lo siguiente:

  • Cambie <url de web de aplicación>, <url de web de host> y otros datos de marcador de posición, como cualquier identificador, nombre o ruta de acceso de entidades de SharePoint.

  • Si no está utilizando la biblioteca entre dominios, incluya un encabezado X-RequestDigest para enviar el valor de síntesis de formulario en todas las solicitudes POST y un encabezado content-length para solicitudes POST que envían datos en el cuerpo de la solcitud.

  • Si no realiza solicitudes entre dominios, quite SP.AppContextSite(@target) y ?@target='<host web url>' del extremo del identificador URI.

  • Si está utilizando OAuth, incluya un encabezado Authorization ("Authorization": "Bearer " + <access token>) para enviar el token de acceso OAuth.

  • Quite los saltos de línea de los valores de propiedad url y body en los ejemplos de solicitud. Se agregan saltos de línea a los ejemplos para facilitar la lectura.

  • Si quiere que el servidor devuelva respuestas en formato Atom, quite el encabezado "accept": "application/json; odata=verbose".

Consulte Recursos adicionales para obtener más información acerca del uso de la biblioteca entre dominios, OAuth y el servicio REST de SharePoint. Consulte Cómo difieren las solicitudes REST por entorno y Propiedades usadas en solicitudes de REST para obtener informacion acerca de formatos de solicitudes.

Sugerencia

El servicio REST de SharePoint Online admite la combinación de varias solicitudes en una sola llamada al servicio mediante el uso de la opción de consulta $batch de OData. Para obtener información detallada y vínculos a los ejemplos de código, vea Realizar solicitudes de lote con las API de REST. Esta opción aún no está disponible para la implementación de SharePoint local.

Exploración de la sintaxis de REST de los elementos de lista y las listas de SharePoint 2013

Explorar la lista de servicio REST y la sintaxis de elemento de lista

Exploración visual de la sintaxis de REST de los elementos de lista y las listas de SharePoint 2013.

Exploración de otros diagramas de sintaxis de REST de SharePoint:

Archivos y carpetas | Usuarios y grupos

Descargue el PDF combinado de todos los diagramas de sintaxis de REST de SharePoint.

Nota

La opción de consulta $skip de OData no funciona al consultar elementos de una lista en particular. Sí funciona al consultar el extremo de listas.

Recurso de lista

Representa una lista de SharePoint. Una lista es un tipo de SP.SecurableObject.

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

URI del extremo

http://<url del sitio>/web/lists(guid'<id. de lista>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener una lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede usar el método GetByTitle del recurso Recurso ListCollection para obtener una lista por su título. Ejemplo: …/web/lists/getbytitle('Access Requests').

Ejemplo de solicitud POST: crear una lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
    'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
  headers: { "content-type": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud MERGE: cambiar una lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
    'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
  headers: { 
    "IF-MATCH”: "*",
    "X-HTTP-Method": "MERGE",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud DELETE: eliminar una lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "POST",
  headers: { 
    "IF-MATCH”: "*",
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Si quiere reciclar una lista y obtener el GUID del elemento de la papelera de reciclaje, use el método Recycle de la lista para quitar el archivo.

Propiedades de lista

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Description

AllowContentTypes

Boolean

L

Obtiene un valor que especifica si la lista admite tipos de contenido.

BaseTemplate

Int32

L

Obtiene el tipo de definición de lista en el que se basa la lista. Representa un valor ListTemplateType. Consulte ListTemplateType en la referencia de modelo de objetos de cliente .NET para ver los valores de tipos de plantilla.

BaseType

Int32

L

Obtiene el tipo de base de la lista. Representa un valor SP.BaseType: Generic List = 0; Document Library = 1; Discussion Board = 3; Survey = 4; Issue = 5.

BrowserFileHandling

Int32

L

No

Obtiene un valor que especifica la invalidación de la propiedad BrowserFileHandling de la aplicación web en el nivel de la lista. Representa un valor SP.BrowserFileHandling: Permissive = 0; Strict = 1.

ContentTypes

SP.ContentTypeCollection

L

No

Obtiene los tipos de contenido asociados con la lista.

ContentTypesEnabled

Boolean

LE

Obtiene o establece un valor que especifica si los tipos de contenido están habilitados para la lista.

Created

DateTime

L

Obtiene un valor que especifica cuándo se creó la lista.

DataSource

SP.ListDataSource

L

No

Obtiene el origen de datos asociado con la lista, o bien obtiene null si no se trata de una lista virtual. Devuelve null si la propiedad HasExternalDataSource es false.

DefaultContentApprovalWorkflowId

GUID

LE

Obtiene o establece un valor que especifica el identificador de flujo de trabajo predeterminado para la aprobación de contenido en la lista. Devuelve un GUID vacío si no hay un flujo de trabajo de aprobación de contenido predeterminado.

DefaultDisplayFormUrl

String

LE

No

Obtiene o establece un valor que especifica la ubicación del formulario de presentación predeterminado para la lista. Los clientes especifican una dirección URL relativa al servidor y el servidor devuelve una dirección URL relativa al sitio

DefaultEditFormUrl

String

LE

No

Obtiene o establece un valor que especifica la dirección URL del formulario de edición que se usará para los elementos de lista de la lista. Los clientes especifican una dirección URL relativa al servidor y el servidor devuelve una dirección URL relativa al sitio.

DefaultNewFormUrl

String

LE

No

Obtiene o establece un valor que especifica la ubicación del formulario nuevo predeterminado para la lista. Los clientes especifican una dirección URL relativa al servidor y el servidor devuelve una dirección URL relativa al sitio.

DefaultView

SP.View

L

No

DefaultViewUrl

String

L

No

Obtiene la dirección URL de la vista predeterminada de la lista.

Description

String

LE

Obtiene o establece un valor que especifica la descripción de la lista.

Direction

String

LE

Obtiene o establece un valor que especifica el orden de lectura de la lista. Devuelve "NONE", "LTR" o "RTL".

DocumentTemplateUrl

String

LE

Obtiene o establece un valor que especifica la dirección URL relativa al servidor de la plantilla de documento de la lista. Devuelve una dirección URL relativa al servidor si el tipo de base es DocumentLibrary, de lo contrario devuelve null.

DraftVersionVisibility

Int32

LE

Obtiene o establece un valor que especifica los permisos mínimos necesarios para ver borradores y versiones secundarias dentro de la lista. Representa un valor SP.DraftVisibilityType: Reader = 0; Author = 1; Approver = 2.

EffectiveBasePermissions

SP.BasePermissions

L

No

Obtiene un valor que especifica los permisos efectivos de la lista asignados al usuario actual.

EffectiveBasePermissionsForUI

SP.BasePermissions

L

No

EnableAttachments

Boolean

LE

Obtiene o establece un valor que especifica si los datos adjuntos de elemento de lista están habilitados para la lista.

EnableFolderCreation

Boolean

LE

Obtiene o establece un valor que especifica si se pueden agregar carpetas de lista nuevas a la lista.

EnableMinorVersions

Boolean

LE

Obtiene o establece un valor que especifica si las versiones secundarias están habilitadas para la lista.

EnableModeration

Boolean

LE

Obtiene o establece un valor que especifica si está habilitada la aprobación de contenido para la lista.

EnableVersioning

Boolean

LE

Obtiene o establece un valor que especifica si se pueden crear versiones históricas de los elementos de lista y los documentos en la lista.

EntityTypeName

String

L

EventReceivers

SP.EventReceiverDefinitionCollection

L

No

Campos

SP.FieldCollection

L

No

Obtiene un valor que especifica la colección de todos los campos de la lista.

FirstUniqueAncestorSecurableObject

SP.SecurableObject

L

No

Obtiene el objeto en el que están definidas las asignaciones de roles para este objeto. Si las asignaciones de roles se definen directamente en el objeto actual, se devuelve el objeto actual.

ForceCheckout

Boolean

LE

Obtiene o establece un valor que indica si está habilitada la desprotección forzada para la biblioteca de documentos.

Forms

SP.FormCollection

L

No

Obtiene un valor que especifica la colección de todos los formularios de lista de la lista.

HasExternalDataSource

Boolean

L

Obtiene un valor que especifica si la lista es una lista externa.

HasUniqueRoleAssignments

Boolean

L

No

Obtiene un valor que especifica si las asignaciones de roles se definen exclusivamente para este objeto protegible o se heredan de un objeto protegible primario.

Hidden

Boolean

LE

Obtiene o establece un valor booleano que especifica si la lista está oculta. Si true, el servidor establece la propiedad OnQuickLaunch en false.

Id

GUID

L

Obtiene el GUID que identifica la lista en la base de datos.

ImageUrl

String

L

Obtiene un valor que especifica el URI del icono de la lista.

InformationRightsManagementSettings

SP.InformationRightsManagementSettings

L

No

IrmEnabled

Boolean

LE

IrmExpire

Boolean

LE

IrmReject

Boolean

LE

IsApplicationList

Boolean

LE

Obtiene o establece un valor que especifica una marca que puede usar una aplicación cliente para determinar si se muestra la lista.

IsCatalog

Boolean

L

Obtiene un valor que especifica si la lista es una galería.

IsPrivate

Boolean

L

IsSiteAssetsLibrary

Boolean

L

No

Obtiene un valor que indica si la lista está designada como una ubicación de activos predeterminada para imágenes u otros archivos que los usuarios cargan en sus páginas wiki.

ItemCount

Int32

L

Obtiene un valor que especifica el número de elementos de lista de la lista.

Elementos

SP.ListItemCollection

L

No

Obtiene todos los elementos en la lista.

Puede usar las Operaciones de consulta de OData para filtrar elementos (ejemplo: …/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items?$filter=Status eq 'not started'&$select=Title&$top=5).

LastItemDeletedDate

DateTime

L

Obtiene un valor que especifica la última vez que se eliminó un elemento de lista de la lista.

LastItemModifiedDate

DateTime

LE

Obtiene un valor que especifica la última vez que se modificó un elemento de lista, un campo o una propiedad de la lista.

ListItemEntityTypeFullName

String

L

MultipleDataList

Boolean

LE

Obtiene o establece un valor que indica si la lista de un sitio Área de trabajo contiene datos de varias instancias de reunión dentro del sitio.

NoCrawl

Boolean

LE

Obtiene o establece un valor que especifica que el rastreador (crawler) no debe rastrear la lista.

OnQuickLaunch

Boolean

LE

No

Obtiene o establece un valor que especifica si la lista aparece en el Inicio rápido del sitio. Si true, el servidor establece la propiedad Hidden en false.

ParentWeb

SP.Web

L

No

Obtiene un valor que especifica el sitio que contiene la lista.

ParentWebUrl

String

L

Obtiene un valor que especifica la dirección URL relativa al servidor del sitio que contiene la lista.

RoleAssignments

SP.RoleAssignmentCollection

L

No

Obtiene las asignaciones de roles para el objeto protegible.

RootFolder

SP.Folder

L

No

Obtiene la carpeta raíz que contiene los archivos de la lista y cualquier archivo relacionado.

SchemaXml

String

L

No

Obtiene un valor que especifica el esquema de lista de la lista.

ServerTemplateCanCreateFolders

Boolean

L

Obtiene un valor que indica si se pueden crear carpetas dentro de la lista.

TemplateFeatureId

GUID

L

Obtiene un valor que especifica el identificador de característica de la característica que contiene el esquema de lista de la lista. Devuelve un GUID vacío si el esquema de listas no se incluye en una característica.

Title

String

LE

Obtiene o establece el título que se muestra para la lista. Su longitud debe ser <= 255 caracteres.

UserCustomActions

SP.UserCustomActionCollection

L

No

Obtiene un valor que especifica la colección de todas las acciones personalizadas de usuario de la lista.

ValidationFormula

String

LE

No

Obtiene o establece un valor que especifica los criterios de validación de datos de un elemento de lista. Su longitud debe ser <= 1023.

ValidationMessage

String

LE

No

Obtiene o establece un valor que especifica el mensaje de error que se devuelve cuando se produce un error en la validación de datos de un elemento de lista. Su longitud debe ser <= 1023.

Views

Recurso ViewCollection

L

No

Obtiene un valor que especifica la colección de todas las vistas públicas de la lista y las vistas personales del usuario actual en la lista.

WorkflowAssociations

SP.Workflow.WorkflowAssociationCollection

L

No

Obtiene un valor que especifica la colección de todas las asociaciones de flujo de trabajo de la lista.

Métodos de lista

AddItem
BreakRoleInheritance
DeleteObject
GetChanges
GetItemById
GetItems
GetListItemChangesSinceToken
GetRelatedFields
GetUserEffectivePermissions
GetView
Recycle
RenderListData
RenderListFormData
ReserveListItemId
ResetRoleInheritance

Método AddItem

Ejemplos

Método BreakRoleInheritance

Crea asignaciones de roles únicas para el objeto protegible.

Extremo

/breakroleinheritance(copyroleassignments, clearsubscopes)

Parámetros

copyroleassignments

Tipo: Boolean
true para copiar las asignaciones de roles del objeto protegible primario; false para quitar las asignaciones de roles heredadas excepto una que contiene el usuario actual.

clearsubscopes

Tipo: Boolean
Opcional. true para hacer que todos los objetos protegibles secundarios hereden asignaciones de roles del objeto actual; false (valor predeterminado) para dejar asignaciones de roles sin cambios para objetos protegibles secundarios que no heredan asignaciones de roles del objeto primario.

HTTP method

POST

Respuesta

Ninguna

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')
    /breakroleinheritance(copyroleassignments=false, clearsubscopes=true)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método DeleteObject

El método recomendado para eliminar una lista es enviar una solicitud DELETE al extremo del recurso List, tal como se muestra en los ejemplos de solicitudes de lista

Método GetChanges

Devuelve la colección de los cambios del registro de cambios realizados dentro de la lista, en función de la consulta especificada.

Extremo

/getchanges

Parámetros

query

Tipo: SP.ChangeQuery
La consulta de cambio. Pase este parámetro en el cuerpo de solicitud, tal como se muestra en el ejemplo de la solicitud.

HTTP method

POST

Respuesta

Tipo: SP.ChangeCollection
Los cambios en la lista que coinciden con los criterios de la consulta de cambio especificada.

Ejemplo de solicitud

var metadata = "{ 'query' : { '__metadata': { 'type': 'SP.ChangeQuery' },
    'Add': 'True', 'Item': 'True' }}";

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getchanges
    ?@target='<host web url>'",
  method: "POST",
  body: metadata,
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json; odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de respuesta

    {"d":
      {"results":[{
        "__metadata":{
          "id":"https://<site url>/_api/SP.ChangeItema7e7c6e9-2c41-47c3-aae9-2b4a63b7a087",
          "uri":"https://<site url>/_api/SP.ChangeItem",
          "type":"SP.ChangeItem"
        },
        "ChangeToken":{"__metadata":{"type":"SP.ChangeToken"}, "StringValue":"1;3;482e418a-0900-414b-8902-02248c2e44e8;634955266749500000;5749111"},
        "ChangeType":1,
        "SiteId":"ce11bfbb-cf9d-4b2b-a642-8673bd48cceb",
        "Time":"2013-02-03T22:17:54Z",
        "ItemId":1,
        "ListId":"482e418a-0900-414b-8902-02248c2e44e8",
        "WebId":"a975b994-fc67-4203-a519-b160175ca967"
      }]
    }}

Método GetItemById

Devuelve el elemento de lista con el identificador de elemento de lista especificado.

Extremo

/getitembyid(<id. de elemento>)

Parámetros

Tipo: Int32
El id. del elemento de lista.

HTTP method

GET

Respuesta

Tipo: SP.ListItem
El elemento de lista con el id. especificado.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')
    /getitembyid(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, puede pasar el id. del elemento de lista al recurso Recurso ListItemCollection. Ejemplo: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items(2).

Método GetItems

Devuelve una colección de elementos de la lista en función de la consulta especificada.

Extremo

/getitems

Parámetros

query

Tipo: SP.CamlQuery
La consulta de filtro. Pase este parámetro en el cuerpo de solicitud, tal como se muestra en el ejemplo de la solicitud.

HTTP method

POST

Respuesta

Tipo: SP.ListItemCollection
Los elementos de la lista que coinciden con la consulta especificada.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
    /getitems
    ?@target='<host web url>'",
  method: "POST",
  body: "{ 'query' : {'__metadata': { 'type': 'SP.CamlQuery' }, "ViewXml": "<View><Query><Where><Contains><FieldRef Name='Status'/><Value Type='CHOICE'>in progress</Value></Contains></Where></Query></View>" } }",
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json; odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Método GetListItemChangesSinceToken

Extremo

/getlistitemchangessincetoken

Parámetros

query

Tipo: SP.ChangeLogItemQuery
La consulta que contiene el token de cambio. Pase este parámetro en el cuerpo de solicitud, tal como se muestra en el ejemplo de la solicitud.

HTTP method

POST

Respuesta

Tipo: GetListItemChangesSinceTokenResult
Un Stream que contiene una representación XML de los cambios en los elementos de lista que han sucedido tras el cambio especificado.

Ejemplo de solicitud

var metadata = "{ 'query': { '__metadata': { 'type': 'SP.ChangeLogItemQuery' },
    'ChangeToken': '1;3;79cc20e6-adda-438e-8a96-792041b33168;635103901830230000;33050019' }}";

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getlistitemchangessincetoken
    ?@target='<host web url>'",
  method: "POST",
  body: metadata,
  headers: { "content-type": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Consulte Sincronizar elementos de SharePoint con el servicio REST para ver un ejemplo de cómo especificar una consulta filtrada.

Ejemplo de respuesta

<?xml version="1.0" encoding="utf-8" ?>
<GetListItemChangesSinceTokenResult>
  <listitems MinTimeBetweenSyncs='0' RecommendedTimeBetweenSyncs='180' MaxBulkDocumentSyncSize='500' MaxRecommendedEmbeddedFileSize='500' EffectivePermMask='FullMask' xmlns:s='uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882' xmlns:dt='uuid:C2F41010-65B3-11d1-A29F-00AA00C14882' xmlns:rs='urn:schemas-microsoft-com:rowset' xmlns:z='#RowsetSchema'>
    <Changes LastChangeToken="1;3;79cc20e6-adda-438e-8a96-792041b33168;635110802324330000;33811711">
    <List DocTemplateUrl="" DefaultViewUrl="/Lists/TestList/AllItems.aspx" MobileDefaultViewUrl="" ID="{79CC20E6-ADDA-438E-8A96-792041B33168}" Title="TestList" Description="" ImageUrl="/_layouts/15/images/itgen.png?rev=26" Name="{79CC20E6-ADDA-438E-8A96-792041B33168}" BaseType="0" FeatureId="00bfea71-de22-43b2-a848-c05709900100" ServerTemplate="100" Created="20130725 22:22:35" Modified="20130802 22:43:52" LastDeleted="20130725 22:22:35" Version="4" Direction="none" ThumbnailSize="" WebImageWidth="" WebImageHeight="" Flags="545263616" ItemCount="2" AnonymousPermMask="0" RootFolder="/Lists/TestList" ReadSecurity="1" WriteSecurity="1" Author="11" EventSinkAssembly="" EventSinkClass="" EventSinkData="" EmailAlias="" WebFullUrl="/" WebId="a975b994-fc67-4203-a519-b160175ca967" SendToLocation="" ScopeId="ad9949be-be16-4946-b5de-66c912eda54a" MajorVersionLimit="0" MajorWithMinorVersionsLimit="0" WorkFlowId="" HasUniqueScopes="False" NoThrottleListOperations="False" HasRelatedLists="" Followable="False" AllowDeletion="True" AllowMultiResponses="False" EnableAttachments="True" EnableModeration="False" EnableVersioning="False" HasExternalDataSource="False" Hidden="False" MultipleDataList="False" Ordered="False" ShowUser="True" EnablePeopleSelector="False" EnableResourceSelector="False" EnableMinorVersion="False" RequireCheckout="False" ThrottleListOperations="False" ExcludeFromOfflineClient="False" CanOpenFileAsync="True" EnableFolderCreation="False" IrmEnabled="False" IsApplicationList="False" PreserveEmptyValues="False" StrictTypeCoercion="False" EnforceDataValidation="False" MaxItemsPerThrottledOperation="5000">
      <Fields>
        <Field ID="{03e45e84-1992-4d42-9116-26f756012634}" RowOrdinal="0" Type="ContentTypeId" Sealed="TRUE" ReadOnly="TRUE" Hidden="TRUE" DisplayName="Content Type ID" Name="ContentTypeId" DisplaceOnUpgrade="TRUE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentTypeId" ColName="tp_ContentTypeId" FromBaseType="TRUE"/>
        <Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Type="Text" Name="Title" DisplayName="Title" Required="TRUE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" FromBaseType="TRUE" ColName="nvarchar1"/>
        <Field ID="{34ad21eb-75bd-4544-8c73-0e08330291fe}" ReadOnly="TRUE" Type="Note" Name="_ModerationComments" DisplayName="Approver Comments" Hidden="TRUE" CanToggleHidden="TRUE" Filterable="FALSE" Sortable="FALSE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="_ModerationComments" FromBaseType="TRUE" ColName="ntext1"/>
        <Field ID="{39360f11-34cf-4356-9945-25c44e68dade}" ReadOnly="TRUE" Hidden="TRUE" Type="Text" Name="File_x0020_Type" DisplaceOnUpgrade="TRUE" DisplayName="File Type" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="File_x0020_Type" FromBaseType="TRUE" ColName="nvarchar2"/>
        <Field ID="{fc2e188e-ba91-48c9-9dd3-16431afddd50}" Name="WorkAddress" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="WorkAddress" Group="Core Contact and Calendar Columns" DisplayName="Address" Type="Note" NumLines="2" Sortable="FALSE" ColName="ntext2" RowOrdinal="0"/>
        <Field ID="{fce16b4c-fe53-4793-aaab-b4892e736d15}" Name="EMail" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="EMail" Group="Core Contact and Calendar Columns" DisplayName="E-Mail" ReadOnly="FALSE" Type="Text" FromBaseType="TRUE" AllowDeletion="TRUE" ColName="nvarchar3" RowOrdinal="0"/>
        <Field Type="Lookup" DisplayName="anewishlisttitle" Required="FALSE" EnforceUniqueValues="FALSE" List="{482e418a-0900-414b-8902-02248c2e44e8}" ShowField="Title" UnlimitedLengthInDocumentLibrary="FALSE" RelationshipDeleteBehavior="None" ID="{9919f3f8-88fb-43fc-b4cb-658b1db1bfe3}" SourceID="{79cc20e6-adda-438e-8a96-792041b33168}" StaticName="anewishlisttitle" Name="anewishlisttitle" ColName="int1" RowOrdinal="0"/>
        <Field Type="Lookup" DisplayName="Books title" Required="FALSE" EnforceUniqueValues="FALSE" List="{90146606-81fd-410d-9fdd-d03b6349fbcd}" ShowField="Title" UnlimitedLengthInDocumentLibrary="FALSE" RelationshipDeleteBehavior="None" ID="{879a1cba-91b6-4c0a-99fb-29f877aae3ea}" SourceID="{79cc20e6-adda-438e-8a96-792041b33168}" StaticName="Books_x0020_title" Name="Books_x0020_title" ColName="int2" RowOrdinal="0"/>
        <Field ID="{1d22ea11-1e32-424e-89ab-9fedbadb6ce1}" ColName="tp_ID" RowOrdinal="0" ReadOnly="TRUE" Type="Counter" Name="ID" PrimaryKey="TRUE" DisplayName="ID" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ID" FromBaseType="TRUE"/>
        <Field ID="{c042a256-787d-4a6f-8a8a-cf6ab767f12d}" Type="Computed" DisplayName="Content Type" Name="ContentType" DisplaceOnUpgrade="TRUE" RenderXMLUsingPattern="TRUE" Sortable="FALSE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentType" Group="_Hidden" PITarget="MicrosoftWindowsSharePointServices" PIAttribute="ContentTypeID" FromBaseType="TRUE">
          <FieldRefs>
            <FieldRef Name="ContentTypeId"/>
          </FieldRefs>
          <DisplayPattern>
            <MapToContentType>
              <Column Name="ContentTypeId"/>
            </MapToContentType>
          </DisplayPattern>
        </Field>
        <…>
      </Fields>
      <RegionalSettings>
        <Language>1033</Language>
        <Locale>1033</Locale>
        <AdvanceHijri>0</AdvanceHijri>
        <CalendarType>1</CalendarType>
        <Time24>False</Time24>
        <TimeZone>480</TimeZone>
        <SortOrder>2070</SortOrder>
        <Presence>True</Presence>
      </RegionalSettings>
      <ServerSettings>
        <ServerVersion>16.0.1810.1236</ServerVersion>
        <RecycleBinEnabled>True</RecycleBinEnabled>
        <ServerRelativeUrl>/</ServerRelativeUrl>
       </ServerSettings>
      </List>
    </Changes>
    <rs:data ItemCount="1">
      <z:row ows_ContentTypeId='0x0100C8CFB1DE383F1B49A44ABD2EB9AC7322' ows_Title='<item title>' ows_ID='2' ows_ContentType='Item' ows_Modified='2013-07-25T23:21:50Z' ows_Created='2013-07-25T23:21:50Z' ows_Author='<author>' ows_Editor='<editor>' ows_owshiddenversion='1' ows_WorkflowVersion='1' ows__UIVersion='512' ows__UIVersionString='1.0' ows_Attachments='0' ows__ModerationStatus='0' ows_LinkTitleNoMenu='<item title>' ows_LinkTitle='<item title>' ows_LinkTitle2='<item title>' ows_SelectTitle='2' ows_Order='200.000000000000' ows_GUID='{D38981C3-2735-4FDF-9B41-91F3ADA8F3F0}' ows_FileRef='2;#Lists/TestList/2_.000' ows_FileDirRef='2;#Lists/TestList' ows_Last_x0020_Modified='2;#2013-07-25T23:21:50Z' ows_Created_x0020_Date='2;#2013-07-25T23:21:50Z' ows_FSObjType='2;#0' ows_SortBehavior='2;#0' ows_PermMask='0x7fffffffffffffff' ows_FileLeafRef='2;#2_.000' ows_UniqueId='2;#{4D719C3B-B8AB-46A0-A080-402DF6EE31C1}' ows_ProgId='2;#' ows_ScopeId='2;#{AD9949BE-BE16-4946-B5DE-66C912EDA54A}' ows__EditMenuTableStart='2_.000' ows__EditMenuTableStart2='2' ows__EditMenuTableEnd='2' ows_LinkFilenameNoMenu='2_.000' ows_LinkFilename='2_.000' ows_LinkFilename2='2_.000' ows_ServerUrl='/Lists/TestList/2_.000' ows_EncodedAbsUrl='https://<site url>.sharepoint.com/Lists/TestList/2_.000' ows_BaseName='2_' ows_MetaInfo='2;#' ows__Level='1' ows__IsCurrentVersion='1' ows_ItemChildCount='2;#0' ows_FolderChildCount='2;#0' ows_ServerRedirected='0' />
    </rs:data>
  </listitems>
</GetListItemChangesSinceTokenResult>

Método GetRelatedFields

Devuelve una colección de campos de búsqueda que usan esta lista como origen de datos y que tienen FieldLookup.IsRelationship establecido en true.

Extremo

/getrelatedfields

Parámetros

Ninguna

HTTP method

GET

Respuesta

Tipo: SP.RelatedFieldCollection
Una colección de objetos SP.RelatedField con información sobre la relación entre un campo en una lista y un campo de búsqueda en otra lista.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getrelatedfields
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetUserEffectivePermissions

Extremo

/getusereffectivepermissions(@user)?@user='<nombre de inicio de sesión de usuario>'

Parámetros

Tipo: String
El nombre de inicio de sesión del usuario para el cual se van a obtener permisos, pasado como un alias en la cadena de consulta. Por ejemplo:
SharePoint Online o local mediante formularios: …/getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cusuario%40dominio.onmicrosoft.com'
  Local mediante notificaciones de Windows: …/getusereffectivepermissions(@v)?@v='i%3A0%23.w%7Cdominio\usuario'
  Local mediante notificaciones de SAML: …/getusereffectivepermissions(@v)?@v='i%3A05%3At%7Cadfs+with+roles%7Cusuario%40dominio.com'

HTTP method

GET

Respuesta

Tipo: SP.BasePermissions
El conjunto de permisos para el usuario especificado: valores Int64 para elementos de orden superior e inferior de los permisos.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getusereffectivepermissions(@user)?@user='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'
    &@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetView

Devuelve la vista de lista con el identificador de vista especificado.

Extremo

/getview('<id. de vista>')

Parámetros

Tipo: String
El identificador único para la vista de lista.

HTTP method

GET

Respuesta

Tipo: SP.View
La vista de lista especificada.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getview('4814949d-3e17-444c-a1a3-cb69bc77e95f')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, simplemente puede especificar el id. de vista en el recurso ViewCollection. Ejemplo: …/_api/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/views('4814949d-3e17-444c-a1a3-cb69bc77e95f')

Método Recycle

Mueve la lista a la papelera de reciclaje y devuelve el identificador del elemento de papelera de reciclaje nuevo.

Extremo

/recycle

Parámetros

Ninguna

HTTP method

POST

Respuesta

Tipo: GUID
El GUID de la lista reciclada.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método RenderListData

Extremo

/renderlistdata('<ver xml>')

Parámetros

Tipo: String
Una consulta CAML que define los elementos y campos que quiere que se devuelvan.

HTTP method

POST

Respuesta

Tipo: String
Los datos de la lista solicitada en la vista definida por el XML especificado.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /renderlistdata(@viewXml)?@viewXml='<View><RowLimit>10</RowLimit></View>'
    &@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método RenderListFormData

Extremo

/renderlistformdata(itemid, formid, mode)

Parámetros

itemid

Tipo: Int32
El identificador del elemento de lista que se va a representar.

formid

Tipo: String
El identificador del formulario.

mode

Tipo: Int32
El SP.ControlMode del control usado para mostrar el elemento: 1 = mostrar; 2 = editar; 3 = nuevo.

HTTP method

POST

Respuesta

Tipo: String
Los valores de campo y los atributos de esquema de campo para un elemento de lista.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /renderlistformdata(itemid=4, formid='e8b2f6e3-1081-4b18-833b-475f76473cde', mode=2)
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método ReserveListItemId

Reserva un id. de elemento de lista para la creación de elementos de lista idempotent.

Extremo

/reservelistitemid

Parámetros

Ninguna

HTTP method

POST

Respuesta

Tipo: Int32
El identificador de elemento de lista que se va a reservar.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /reservelistitemid
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método ResetRoleInheritance

Restablece la herencia de roles para el objeto protegible y hereda asignaciones de roles del objeto protegible primario.

Extremo

/resetroleinheritance

Parámetros

Ninguna

HTTP method

POST

Respuesta

Ninguna

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /resetroleinheritance
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Representación OData

El siguiente ejemplo representa un recurso de List en formato JSON.

    {"d":{
      "__metadata":{
        "id":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')",
        "uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')",
        "etag":"\"0\"",
        "type":"SP.List"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/RoleAssignments"}},
      "ContentTypes":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/ContentTypes"}},
      "DefaultView":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/DefaultView"}},
      "EventReceivers":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/EventReceivers"}},
      "Fields":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/Fields"}},
      "Forms":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/Forms"}},
      "InformationRightsManagementSettings":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/InformationRightsManagementSettings"}},
      "AllowContentTypes":true, 
      "BaseTemplate":100, 
      "BaseType":0, 
      "ContentTypesEnabled":false, 
      "Created":"2013-02-02T21:11:56Z",
      "DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
      "Description":"",
      "Direction":"none",
      "DocumentTemplateUrl":null, 
      "DraftVersionVisibility":0, 
      "EnableAttachments":true, 
      "EnableFolderCreation":false, 
      "EnableMinorVersions":false, 
      "EnableModeration":false, 
      "EnableVersioning":false,
      "EntityTypeName":"ANewList",
      "ForceCheckout":false, 
      "HasExternalDataSource":false, 
      "Hidden":false, 
      "Id":"8ade7551-f53c-48c5-9d2b-e89f6528cf47",
      "ImageUrl":"/_layouts/15/images/itgen.png?rev=23",
      "IrmEnabled":false, 
      "IrmExpire":false, 
      "IrmReject":false, 
      "IsApplicationList":false, 
      "IsCatalog":false, 
      "IsPrivate":false, 
      "ItemCount":1, 
      "LastItemDeletedDate":"2013-02-02T21:11:56Z",
      "LastItemModifiedDate":"2013-02-03T22:17:55Z",
      "ListItemEntityTypeFullName":"SP.Data.ANewListItem",
      "MultipleDataList":false, 
      "NoCrawl":false, 
      "ParentWebUrl":"/",
      "ServerTemplateCanCreateFolders":true, 
      "TemplateFeatureId":"00bfea71-de22-43b2-a848-c05709900100",
      "Title":"ANewList"
    }}

Recurso ListCollection

Representa una colección de listas.

URI del extremo  |  Métodos  |  Representación OData

URI del extremo

http://<url del sitio>/web/lists

Métodos HTTP compatibles

GET  |  POST

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener las listas en el sitio raíz

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud GET: obtener una lista por título

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists/getbytitle('Access Requests')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud GET: obtener una lista por identificador

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud POST: crear una lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
    'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
  headers: { "content-type": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Métodos ListCollection

EnsureSiteAssetsLibrary
EnsureSitePagesLibrary
GetById
GetByTitle

Método EnsureSiteAssetsLibrary

Obtiene una lista que es la ubicación de activos predeterminada para imágenes u otros archivos que los usuarios cargan en sus páginas wiki.

Extremo

/ensuresiteassetslibrary

Parámetros

Ninguna

HTTP method

POST

Respuesta

Tipo: SP.List
La lista que es la ubicación predeterminada de los activos de la página wiki.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    /ensuresiteassetslibrary
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método EnsureSitePagesLibrary

Obtiene una lista que es la ubicación predeterminada de las páginas wiki.

Extremo

/ensuresitepageslibrary

Parámetros

Ninguna

HTTP method

POST

Respuesta

Tipo: SP.List
La lista que es la ubicación predeterminada de las páginas wiki.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    /ensuresitepageslibrary
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetById

Devuelve la lista con el identificador de lista especificado.

Extremo

/getbyid

Parámetros

Tipo: String
El identificador de la lista.

HTTP method

GET

Respuesta

Tipo: SP.List
La lista con el identificador especificado.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    /getbyid('51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, simplemente puede pasar el id. de la lista al Recurso ListCollection. Ejemplo: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b').

Método GetByTitle

Devuelve la lista con el título especificado de la colección.

Extremo

/getbytitle

Parámetros

Tipo: String
El título de la lista.

HTTP method

GET

Respuesta

Tipo: SP.List
La lista con el título especificado.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    /getbytitle('Access Requests')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Representación OData

El siguiente ejemplo representa un Recurso ListCollection en formato JSON.

    {"d":{
      "results":[{
        "__metadata":{"id":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')",
        "uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-
    4bfa4e69d48b')",
        "etag":"\"6\"",
        "type":"SP.List"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/RoleAssignments"}},
      "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/ContentTypes"}},
      "DefaultView":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/DefaultView"}},
      "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/EventReceivers"}},
      "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Fields"}},
      "Forms":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Forms"}},
      "InformationRightsManagementSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/InformationRightsManagementSettings"}},
      "Items":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Items"}},
      "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/ParentWeb"}},
      "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/RootFolder"}},
      "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/UserCustomActions"}},
      "Views":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Views"}},
      "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/WorkflowAssociations"}},
      "AllowContentTypes":true,
      "BaseTemplate":160,"BaseType":0,
      "ContentTypesEnabled":true,
      "Created":"2013-06-10T17:14:49Z",
      "DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
      "Description":"Use this list to track access requests to a site or uniquely permissioned items in the site.",
      "Direction":"none",
      "DocumentTemplateUrl":null,
      "DraftVersionVisibility":0,
      "EnableAttachments":false,
      "EnableFolderCreation":false,
      "EnableMinorVersions":false,
      "EnableModeration":false,
      "EnableVersioning":true,
      "EntityTypeName":"Access_x0020_Requests",
      "ForceCheckout":false,
      "HasExternalDataSource":false,
      "Hidden":true,
      "Id":"51925dd7-2108-481a-b1ef-4bfa4e69d48b",
      "ImageUrl":"/_layouts/15/images/itgen.gif?rev=26",
      "IrmEnabled":false,
      "IrmExpire":false,
      "IrmReject":false,
      "IsApplicationList":false,
      "IsCatalog":false,
      "IsPrivate":false,
      "ItemCount":3,
      "LastItemDeletedDate":"2013-06-10T17:14:49Z",
      "LastItemModifiedDate":"2013-06-10T17:20:48Z",
      "ListItemEntityTypeFullName":"SP.Data.Access_x0020_RequestsItem",
      "MultipleDataList":false,
      "NoCrawl":true,
      "ParentWebUrl":"/",
      "ServerTemplateCanCreateFolders":true,
      "TemplateFeatureId":"a0f12ee4-9b60-4ba4-81f6-75724f4ca973",
      "Title":"Access Requests"},
      {
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')",
          "uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-
    02248c2e44e8')",
          "etag":"\"1\"",
          "type":"SP.List"
        },
        "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902- 
    02248c2e44e8')/FirstUniqueAncestorSecurableObject"}},
        "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/RoleAssignments"}},
        "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/ContentTypes"}},
        "DefaultView":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/DefaultView"}},
        "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/EventReceivers"}},
        "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Fields"}},
        "Forms":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Forms"}},
        "InformationRightsManagementSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/InformationRightsManagementSettings"}},
        "Items":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Items"}},
        "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/ParentWeb"}},
        "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/RootFolder"}},
        "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/UserCustomActions"}},
        "Views":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Views"}},
        "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/WorkflowAssociations"}},
        "AllowContentTypes":true,
        "BaseTemplate":100,
        "BaseType":0,
        "ContentTypesEnabled":false,
        "Created":"2013-02-02T21:11:56Z",
        "DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
        "Description":"",
        "Direction":"none",
        "DocumentTemplateUrl":null,
        "DraftVersionVisibility":0,
        "EnableAttachments":true,
        "EnableFolderCreation":false,
        "EnableMinorVersions":false,
        "EnableModeration":false,
        "EnableVersioning":false,
        "EntityTypeName":"AList",
        "ForceCheckout":false,
        "HasExternalDataSource":false,
        "Hidden":false,
        "Id":"482e418a-0900-414b-8902-02248c2e44e8",
        "ImageUrl":"/_layouts/15/images/itgen.png?rev=23",
        "IrmEnabled":false,
        "IrmExpire":false,
        "IrmReject":false,
        "IsApplicationList":false,
        "IsCatalog":false,
        "IsPrivate":false,
        "ItemCount":3,
        "LastItemDeletedDate":"2013-02-02T21:11:56Z",
        "LastItemModifiedDate":"2013-06-26T22:31:03Z",
        "ListItemEntityTypeFullName":"SP.Data.AListListItem",
        "MultipleDataList":false,
        "NoCrawl":false,
        "ParentWebUrl":"/",
        "ServerTemplateCanCreateFolders":true,
        "TemplateFeatureId":"00bfea71-de22-43b2-a848-c05709900100",
        "Title":"AList"
      }]
    }}

Recurso ListItem

Representa un elemento o una fila de una lista. Un elemento de lista es un tipo de SP.SecurableObject.

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

Nota

La opción de consulta $skip de OData no funciona con este extremo.

URI del extremo

http://<url del sitio>/web/lists(guid'<id. de lista>')/items(<id. de elemento>)
http://<url del sitio>/web/lists/getbytitle('<título de lista>')/items(<id. de lista>)

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener un elemento de lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud POST: crear un elemento de lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
    'Title': 'Teams incorporate feedback', 'AssignedToId': {"results":[1]},
    'StartDate':'2014-01-29T08:00:00Z', 'DueDate':'2014-01-31T08:00:00Z',
    'PredecessorsId': {"results":[4]}}",
  headers: { 
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Nota

Para crear o cambiar un elemento de lista, debe conocer la propiedad ListItemEntityTypeFullName de la lista y pasarla como valor de type en el cuerpo de solicitud de HTTP.

Ejemplos

Ejemplo de solicitud MERGE: cambiar un elemento de lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
    'Priority': '(1) High', 'Status': 'In Progress', 'PercentComplete': 0.3 }",
  headers: { 
    "IF-MATCH": "*",
    "content-type": "application/json;odata=verbose",
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Nota

Para crear o cambiar un elemento de lista, debe conocer la propiedad ListItemEntityTypeFullName de la lista y pasarla como valor de type en el cuerpo de solicitud de HTTP.

Ejemplo de solicitud DELETE: eliminar un elemento de lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "POST",
  headers: { 
    "IF-MATCH”: "*",
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Si quiere obtener el GUID de la operación de reciclaje, use el método Recycle del elemento.

Propiedades ListItem

Propiedad

Tipo

L/E

Devuelta con recurso

Description

AttachmentFiles

SP.AttachmentCollection

L

No

Especifica la colección de datos adjuntos que están asociados con el elemento de lista.

ContentType

SP.ContentType

L

No

Obtiene un valor que especifica el tipo de contenido del elemento de lista.

DisplayName

String

L

Sí (se muestra como el valor "Title")

Obtiene un valor que especifica el nombre para mostrar del elemento de lista.

EffectiveBasePermissions

SP.BasePermissions

L

Obtiene un valor que especifica los permisos efectivos del elemento de lista asignados al usuario actual.

EffectiveBasePermissionsForUI

SP.BasePermissions

L

Obtiene los permisos básicos efectivos para el usuario actual, tal como se deberían mostrar en la UI.

FieldValuesAsHtml

SP.FieldStringValues

L

No

Obtiene los valores del elemento de lista como HTML.

FieldValuesAsText

SP.FieldStringValues

L

No

Obtiene los valores de campo del elemento de lista como una colección de valores de cadena.

FieldValuesForEdit

SP.FieldStringValues

L

No

Obtiene los valores con formato que se mostrarán en un formulario de edición.

Archivo

SP.File

L

No

Obtiene el archivo representado por el elemento desde una biblioteca de documentos.

FileSystemObjectType

Int32

L

Obtiene un valor que especifica si el elemento de lista es un archivo o una carpeta de lista. Representa un valor SP.FileSystemObjectType: Invalid = -1; File = 0; Folder = 1; Web = 2.

FirstUniqueAncestorSecurableObject

SP.SecurableObject

L

No

Obtiene el objeto en el que están definidas las asignaciones de roles para este objeto. Si las asignaciones de roles se definen directamente en el objeto actual, se devuelve el objeto actual.

Carpeta

SP.Folder

L

No

Obtiene un objeto de carpeta que está asociado con un elemento de carpeta.

HasUniqueRoleAssignments

Boolean

L

No

Obtiene un valor que especifica si las asignaciones de roles se definen exclusivamente para este objeto protegible o se heredan de un objeto protegible primario.

Id

Int32

L

Obtiene un valor que especifica el identificador del elemento de lista.

ParentList

SP.List

L

No

Obtiene la lista primaria que contiene el elemento de lista.

RoleAssignments

SP.RoleAssignmentCollection

L

No

Obtiene las asignaciones de roles para el objeto protegible.

Métodos ListItem

BreakRoleInheritance
DeleteObject
GetUserEffectivePermissions
Recycle
ResetRoleInheritance
ValidateUpdateListItem

Método BreakRoleInheritance

Crea asignaciones de roles únicas para el objeto protegible.

Extremo

/breakroleinheritance(copyroleassignments, clearsubscopes)

Parámetros

copyroleassignments

Tipo: Boolean
true para copiar las asignaciones de roles del objeto protegible primario; false para quitar las asignaciones de roles heredadas excepto una que contiene el usuario actual.

clearsubscopes

Tipo: Boolean
true para hacer que todos los objetos protegibles secundarios hereden asignaciones de roles del objeto actual; false para dejar asignaciones de roles sin cambios para objetos protegibles secundarios que no heredan asignaciones de roles del objeto primario.

HTTP method

POST

Respuesta

Ninguna

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /breakroleinheritance(copyroleassignments=true, clearsubscopes=false)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,par
  error: errorHandler
});

Método DeleteObject

El método recomendado para eliminar un elemento de lista es enviar una solicitud DELETE al extremo del recurso ListItem, tal como se muestra en los ejemplos de solicitudes ListItem

Método GetUserEffectivePermissions

Obtiene el permiso efectivo que un usuario especificado tiene en el elemento de lista.

Extremo

/getusereffectivepermissions(@v)?@v='<nombre de inicio de sesión de usuario>'

Parámetros

Tipo: String
El nombre de inicio de sesión del usuario para el que se van a obtener permisos. Por ejemplo:
SharePoint Online: …/getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7C<usuario>%40<dominio>.onmicrosoft.com'
  Local mediante notificaciones: …/getusereffectivepermissions(@v)?@v='i%3A0%23.w%7C<dominio\usuario>'
  Local mediante formularios: …/getusereffectivepermissions(@v)?@v='<dominio\usuario>'

HTTP method

GET

Respuesta

Tipo: SP.BasePermissions
Los permisos básicos para el elemento de lista del usuario especificado: valores Int64 para elementos de orden superior e inferior de los permisos.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'
    &@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método Recycle

Mueve el elemento de lista a la papelera de reciclaje y devuelve el identificador del elemento de papelera de reciclaje nuevo.

Extremo

/recycle

Parámetros

Ninguna

HTTP method

POST

Respuesta

Tipo: GUID
El GUID del elemento de lista reciclado.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método ResetRoleInheritance

Restablece la herencia de roles para el objeto protegible y hereda asignaciones de roles del objeto protegible primario.

Extremo

/resetroleinheritance

Parámetros

Ninguna

HTTP method

POST

Respuesta

Ninguna

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /resetroleinheritance
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método ValidateUpdateListItem

Valida y establece los valores de la colección de campos especificada para el elemento de la lista.

Extremo

/validateupdatelistitem

Parámetros

formValues

Tipo: SP.ListItemFormUpdateValue[]
Los campos que se van a cambiar y sus nuevos valores. Pase este parámetro en el cuerpo de solicitud, tal como se muestra en el ejemplo de la solicitud.

bNewDocumentUpdate

Tipo: Boolean
true si el elemento de lista es un documento que se está actualizando tras la carga; de lo contrario, false. Pase este parámetro en el cuerpo de solicitud, tal como se muestra en el ejemplo de la solicitud o en la ruta de acceso del URI.

HTTP method

POST

Respuesta

Tipo: SP.ListItemFormUpdateValue[]
Una matriz de objetos que representan los campos y valores cambiados.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /validateupdatelistitem
    ?@target='<host web url>'",
  method: "POST",
  body: "{ 'formValues':[{'FieldName':'Status', 'FieldValue':'Deferred'},
    {'FieldName':'StartDate', 'FieldValue':'12/31/2014'}], 'bNewDocumentUpdate': false }",
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de respuesta

    {"d":{
      "ValidateUpdateListItem":{"results":[
        {
          "__metadata":{"type":"SP.ListItemFormUpdateValue"},
          "ErrorMessage":null,
          "FieldName":"Status",
          "FieldValue":"Deferred",
          "HasException":false
        },{
          "__metadata":{"type":"SP.ListItemFormUpdateValue"},
          "ErrorMessage":null,
          "FieldName":"StartDate",
          "FieldValue":"12/31/2014",
          "HasException":false
        }
      ]}
    }}

Representación OData

El siguiente ejemplo representa un recurso ListItem en formato JSON. El recurso también devuelve sus valores de campo.

    {"d":{
      "__metadata":{,
        "id":"2bbdaee6-1172-4e36-9f90-ce35ec9b6207",
        "uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)",
        "etag":"\"1\"",
        "type":"SP.Data.Team_x0020_tasksListItem"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/RoleAssignments"}},
      "AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/AttachmentFiles"}},
      "ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ContentType"}},
      "FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsHtml"}},
      "FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsText"}},
      "FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesForEdit"}},
      "File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/File"}},
      "Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/Folder"}},
      "ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ParentList"}},
      "FileSystemObjectType":0,
      "Id":2,
      "ID":2,
      "ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
      "Title":"Assign teams",
      "Modified":"2013-09-03T17:50:30Z",
      "Created":"2013-09-03T17:50:30Z",
      "AuthorId":1073741823,
      "EditorId":1073741823,
      "OData__UIVersionString":"1.0",
      "Attachments":false,
      "GUID":"ce6e516e-2da4-4a3e-9325-daf7d7f61490",
      "PredecessorsId":{"results":[1]},
      "Priority":"(2) Normal",
      "Status":"Not Started",
      "PercentComplete":0,
      "AssignedToId":{"results":[1]},
      "Body":null,
      "StartDate":"2014-01-02T08:00:00Z",
      "DueDate":"2014-01-02T08:00:00Z",
      "Checkmark":"0",
      "RelatedItems":null
    }}

Recurso ListItemCollection

Representa una colección de recursos ListItem.

URI del extremo  |  Métodos  |  Representación OData

URI del extremo

http://<url del sitio>/web/lists(guid'<id, de lista>')/items
http://<url del sitio>/web/lists/getbytitle('<título de lista>')/items

Métodos HTTP compatibles

GET  |  POST

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener todos los elementos de lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud GET: obtener un elemento de lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Puede usar las Operaciones de consulta de OData para filtrar elementos en particular (ejemplo: …/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items?$filter=Status eq 'not started'&$select=Title&$top=5).

Ejemplo de solicitud POST: crear un elemento de lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
    'Title': 'Teams incorporate feedback', 'AssignedToId': {"results":[1]},
    'StartDate':'2014-01-29T08:00:00Z', 'DueDate':'2014-01-31T08:00:00Z',
    'PredecessorsId': {"results":[4]} }",
  headers: { 
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Nota

Para crear o cambiar un elemento de lista, debe conocer la propiedad ListItemEntityTypeFullName de la lista y pasarla como valor de type en el cuerpo de solicitud de HTTP.

Consulte los ejemplos de solicitudes ListItem para ver ejemplos que muestren cómo cambiar o eliminar un elemento de lista.

Métodos ListItemCollection

GetById

Método GetById

Devuelve el elemento de lista con el identificador de elemento de lista especificado.

Extremo

/getbyid(<id. de elemento>)

Parámetros

Tipo: Int32
El id. del elemento de lista.

HTTP method

GET

Respuesta

Tipo: SP.ListItem
El elemento de lista con el id. especificado.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    /getbyid(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O bien, simplemente puede especificar el id. del elemento de lista en el Recurso ListItemCollection. Ejemplo: …/_api/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2).

Representación OData

El siguiente ejemplo representa un recurso ListItemCollection en formato JSON, que devuelve una colección de recursos ListItem.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"dd9ab60c-4653-4654-85de-1d090f0d416f",
          "uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)",
          "etag":"\"1\"",
          "type":"SP.Data.Team_x0020_tasksListItem"
        },
        "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FirstUniqueAncestorSecurableObject"}},
        "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/RoleAssignments"}},
        "AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/AttachmentFiles"}},
        "ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/ContentType"}},
        "FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesAsHtml"}},
        "FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesAsText"}},
        "FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesForEdit"}},
        "File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/File"}},
        "Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/Folder"}},
        "ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/ParentList"}},
        "FileSystemObjectType":0,
        "Id":1,
        "ID":1,
        "ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
        "Title":"Triage requests",
        "Modified":"2013-09-03T17:49:26Z",
        "Created":"2013-09-03T17:49:26Z",
        "AuthorId":1073741823,
        "EditorId":1073741823,
        "OData__UIVersionString":"1.0",
        "Attachments":false,
        "GUID":"e132ef1b-698e-4d21-ba1b-29fa5c38fe8e",
        "PredecessorsId":{"results":[]},
        "Priority":"(2) Normal",
        "Status":"Not Started",
        "PercentComplete":0,
        "AssignedToId":{"results":[1,21]},
        "Body":null,
        "StartDate":"2014-01-01T08:00:00Z",
        "DueDate":"2014-01-02T08:00:00Z",
        "Checkmark":"0",
        "RelatedItems":null
        },{
        "__metadata":{
          "id":"687e63a4-ed44-4bf2-881f-c83e5d3fd020",
          "uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)",
          "etag":"\"5\"",
          "type":"SP.Data.Team_x0020_tasksListItem"
        },
        "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FirstUniqueAncestorSecurableObject"}},
        "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/RoleAssignments"}},
        "AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/AttachmentFiles"}},
        "ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ContentType"}},
        "FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsHtml"}},
        "FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsText"}},
        "FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesForEdit"}},
        "File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/File"}},
        "Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/Folder"}},
        "ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ParentList"}},
        "FileSystemObjectType":0,
        "Id":2,
        "ID":2,
        "ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
        "Title":"Assign teams",
        "Modified":"2013-09-03T19:24:51Z",
        "Created":"2013-09-03T17:50:30Z",
        "AuthorId":1073741823,
        "EditorId":1073741823,
        "OData__UIVersionString":"1.0",
        "Attachments":false,
        "GUID":"ce6e516e-2da4-4a3e-9325-daf7d7f61490",
        "PredecessorsId":{"results":[1]},
        "Priority":"(1) High",
        "Status":"In Progress",
        "PercentComplete":0.3,
        "AssignedToId":{"results":[1]},
        "Body":null,
        "StartDate":"2014-01-02T08:00:00Z",
        "DueDate":"2014-01-02T08:00:00Z",
        "Checkmark":"0",
        "RelatedItems":null
        },{
        …
      }]
    }}

Recurso View

Especifica una vista de lista.

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

URI del extremo

http://<url del sitio>/_api/web/lists(guid'<id. de lista>')/views('<id. de vista>')

Métodos HTTP compatibles

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener una vista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

También puede usar el método GetByTitle del recurso ViewCollection para obtener una vista por su título (con distinción de mayúsculas y minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views/getbytitle('By Status').

Ejemplo de solicitud MERGE: cambiar una vista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.View' }, 'Title': 'New Mobile Default View',
    'MobileDefaultView': true, 'RowLimit': 5 }",
  headers: { 
    "content-type": "application/json;odata=verbose",
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud DELETE: eliminar una vista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "POST",
  headers: { "X-HTTP-Method": "DELETE" },
  success: successHandler,
  error: errorHandler
});

Ejemplos

Propiedades View

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Description

Aggregations

String

LE

Obtiene o establece un valor que especifica los campos y las funciones que definen los totales mostrados en una vista de lista. Si no es nulo, el XML debe cumplir con FieldRefDefinitionAggregation, tal como se especifica en [MS-WSSCAML].

AggregationsStatus

String

LE

Obtiene o establece un valor que especifica si se muestran los totales en la vista de lista.

BaseViewId

String

L

Obtiene un valor que especifica el identificador de vista básico de la vista de lista.

ContentTypeId

SP.ContentTypeId

LE

Obtiene o establece el identificador del tipo de contenido con el que está asociada la lista a fin de que esta solo esté disponible en las carpetas de dicho tipo de contenido.

DefaultView

Boolean

LE

Obtiene o establece un valor que especifica si la vista de lista es la predeterminada.

DefaultViewForContentType

Boolean

LE

Obtiene o establece un valor que especifica si la vista de lista es la predeterminada para el tipo de contenido especificado por contentTypeId.

EditorModified

Boolean

LE

Obtiene o establece un valor que especifica si se modificó la vista de lista en un editor.

Formats

String

LE

Obtiene o establece un valor que especifica el formato de columnas y filas para la vista de lista. Si no es nulo, el XML debe cumplir con ViewFormatDefinitions, tal como se especifica en [MS-WSSCAML].

Hidden

Boolean

LE

Obtiene o establece un valor que especifica si la vista de lista está oculta.

HtmlSchemaXml

String

L

Obtiene un valor que especifica el documento XML que representa la vista de lista.

Id

GUID

L

Obtiene un valor que especifica el identificador de vista de la vista de lista.

ImageUrl

String

L

Obtiene un valor que especifica el URI (Identificador uniforme de recursos) de la imagen para la vista de lista.

IncludeRootFolder

Boolean

LE

Obtiene o establece un valor que especifica si la carpeta actual se muestra en la vista de lista.

JsLink

String

LE

Obtiene o establece el nombre del archivo JavaScript que se usa para la vista.

ListViewXml

String

LE

Obtiene o establece una cadena que representa el XML de vista.

Method

String

LE

Obtiene o establece un valor que especifica el método de vista de la vista de lista. Si no es nulo, el XML debe cumplir con Method, tal como se especifica en [MS-WSSCAP].

MobileDefaultView

Boolean

LE

Obtiene o establece un valor que especifica si la vista de lista es la vista de lista móvil predeterminada.

MobileView

Boolean

LE

Obtiene o establece un valor que especifica si la vista de lista es móvil.

ModerationType

String

L

Obtiene un valor que especifica el tipo de aprobación de contenido de la vista de lista.

OrderedView

Boolean

L

Obtiene un valor que especifica si se pueden reordenar los elementos de lista en la vista de lista.

Paged

Boolean

LE

Obtiene o establece un valor que especifica si la vista de lista es una vista de página.

PersonalView

Boolean

L

Obtiene un valor que especifica si la vista de lista es una vista personal.

ReadOnlyView

Boolean

L

Obtiene un valor que especifica si la vista de lista es de solo lectura.

RequiresClientIntegration

Boolean

L

Obtiene un valor que especifica si la vista de lista requiere derechos de integración de clientes.

RowLimit

Int32

LE

Obtiene o establece un valor que especifica el número máximo de elementos de lista que se mostrarán en una página visual de la vista de lista.

Scope

Int32

LE

Obtiene o establece un valor que especifica el ámbito de la vista de lista. Representa un valor ViewScope. DefaultValue = 0, Recursive = 1, RecursiveAll = 2, FilesOnly = 3.

ServerRelativeUrl

String

L

Obtiene un valor que especifica la dirección URL relativa al servidor de la página de vista de lista.

StyleId

String

L

Obtiene un valor que especifica el identificador del estilo de vista de la vista de lista.

Threaded

Boolean

L

Obtiene un valor que especifica si la vista de lista es una vista encadenada.

Title

String

LE

Obtiene o establece un valor que especifica el nombre para mostrar de la vista de lista.

Toolbar

String

LE

Obtiene o establece un valor que especifica la barra de herramientas de la vista de lista.

ToolbarTemplateName

String

L

Obtiene un valor que especifica el nombre de la plantilla para la barra de herramientas que se usa en la vista de lista.

ViewData

String

LE

Obtiene o establece un valor que especifica los datos de vista de la vista de lista. Si no es nulo, el XML debe cumplir con FieldRefDefinitionViewData, tal como se especifica en [MS-WSSCAML].

ViewFields

SP.ViewFieldCollection

L

No

Obtiene un valor que especifica la colección de los campos de la vista de lista.

ViewJoins

String

LE

Obtiene o establece un valor que especifica las combinaciones usadas en la vista de lista. Si no es nulo, el XML debe cumplir con ListJoinsDefinition, tal como se especifica en [MS-WSSCAP].

ViewProjectedFields

String

LE

Obtiene o establece un valor que especifica los campos proyectados que usará la vista de lista. Si no es nulo, el XML debe cumplir con ProjectedFieldsDefinitionType, tal como se especifica en [MS-WSSCAML].

ViewQuery

String

LE

Obtiene o establece un valor que especifica la consulta que usa la vista de lista. Si no es nulo, el XML debe cumplir con CamlQueryRoot, tal como se especifica en [MS-WSSCAML].

ViewType

String

L

Obtiene un valor que especifica el tipo de la vista de lista. Puede ser HTML, GRID, CALENDAR, RECURRENCE, CHART o GANTT.

Métodos View

DeleteObject
RenderAsHtml

Método DeleteObject

Ejemplos

Método RenderAsHtml

Devuelve la vista de lista como HTML.

Extremo

/renderashtml

Parámetros

Ninguna

HTTP method

GET

Respuesta

Tipo: String
La vista de lista en formato HTML.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    /renderashtml
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Representación OData

El siguiente ejemplo representa un recurso View en formato JSON.

    {"d":{
      "__metadata":{,
        "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
        "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
        "type":"SP.View"
      },
      "ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
      "Aggregations":null,
      "AggregationsStatus":null,
      "BaseViewId":"2",
      "ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"}, "StringValue":"0x"},
      "DefaultView":false,
      "DefaultViewForContentType":false,
      "EditorModified":false,
      "Formats":null,
      "Hidden":false,
      "HtmlSchemaXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query></View>",
      "Id":"0dc42244-4bae-4da9-b074-8b8e9d8e50bc",
      "ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
      "IncludeRootFolder":false,
      "ViewJoins":null,
      "JSLink":"hierarchytaskslist.js",
      "ListViewXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
      "Method":null,
      "MobileDefaultView":false,
      "MobileView":true,
      "ModerationType":null,
      "OrderedView":false,
      "Paged":true,
      "PersonalView":false,
      "ViewProjectedFields":null,
      "ViewQuery":"<Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy>",
      "ReadOnlyView":false,
      "RequiresClientIntegration":false,
      "RowLimit":100,
      "Scope":0,
      "ServerRelativeUrl":"/Lists/Backlog items/late.aspx",
      "StyleId":null,
      "Threaded":false,
      "Title":"Late Tasks",
      "Toolbar":"",
      "ToolbarTemplateName":null,
      "ViewType":"HTML",
      "ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"
    }}

Recurso ViewCollection

Representa una colección de recursos View.

URI del extremo  |  Métodos  |  Representación OData

URI del extremo

http://<url del sitio>/_api/web/lists(guid'<id. de lista>')/views

Métodos HTTP compatibles

GET  |  POST

Ejemplos de solicitudes

Ejemplo de solicitud GET: Obtener todas las vistas de una lista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Ejemplo de solicitud GET: Obtener una vista específica

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

También puede usar el método GetByTitle del recurso ViewCollection para obtener una vista por su título (con distinción de mayúsculas y minúsculas). Ejemplo: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views/getbytitle('By Status').

Ejemplo de solicitud POST: Crear una vista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.View' }, 'Title': 'By Status',
    'PersonalView': false }",
  headers: { 
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Cuando se crea una vista, el servidor devuelve la vista. Para agregar, quitar o cambiar el orden de los campos de vista de la nueva vista, use ViewFieldCollection.

Métodos ViewCollection

GetById
GetByTitle

Método GetById

Obtiene la vista de lista con el identificador especificado.

Extremo

/getbyid('<id. de lista>')

Parámetros

Tipo: String
El identificador de la vista.

HTTP method

GET

Respuesta

SP.View
La vista especificada.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    /getbyid('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

También puede simplemente remitir el identificador de la vista al recursoViewCollection. Ejemplo: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc').

Método GetByTitle

Obtiene la vista de lista con el título especificado.

Extremo

/getbytitle('<título de vista>')

Parámetros

Tipo: String
El título con distinción de mayúsculas y minúsculas de la vista.

HTTP method

GET

Respuesta

SP.View
La vista especificada.

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    /getbytitle('By Status')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Representación OData

El siguiente ejemplo representa un recurso ViewCollection en formato JSON.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "type":"SP.View"
        },
        "ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
        "Aggregations":null,
        "AggregationsStatus":null,
        "BaseViewId":"1",
        "ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"},"StringValue":"0x"},
        "DefaultView":true,
        "DefaultViewForContentType":false,
        "EditorModified":false,
        "Formats":null,
        "Hidden":false,
        "HtmlSchemaXml":"<View Name=\"{9824C4FF-14FD-4F24-B481-FA33D90F2D85}\" DefaultView=\"TRUE\" MobileView=\"TRUE\" MobileDefaultView=\"TRUE\" Type=\"HTML\" DisplayName=\"All Tasks\" Url=\"/Lists/Backlog items/AllItems.aspx\" Level=\"1\" BaseViewID=\"1\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /><FieldRef Name=\"Status0\" /></ViewFields><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData></View>"
        "Id":"9824c4ff-14fd-4f24-b481-fa33d90f2d85",
        "ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
        "IncludeRootFolder":false,
        "ViewJoins":null,
        "JSLink":"hierarchytaskslist.js",
        "ListViewXml":"<View Name=\"{9824C4FF-14FD-4F24-B481-FA33D90F2D85}\" DefaultView=\"TRUE\" MobileView=\"TRUE\" MobileDefaultView=\"TRUE\" Type=\"HTML\" DisplayName=\"All Tasks\" Url=\"/Lists/Backlog items/AllItems.aspx\" Level=\"1\" BaseViewID=\"1\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /><FieldRef Name=\"Status0\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
        "Method":null,
        "MobileDefaultView":true,
        "MobileView":true,
        "ModerationType":null,
        "OrderedView":false,
        "Paged":true,
        "PersonalView":false,
        "ViewProjectedFields":null,
        "ViewQuery":null
        "ReadOnlyView":false,
        "RequiresClientIntegration":false,
        "RowLimit":100,
        "Scope":0,
        "ServerRelativeUrl":"/Lists/Backlog items/AllItems.aspx",
        "StyleId":null,
        "Threaded":false,
        "Title":"All Tasks",
        "Toolbar":"",
        "ToolbarTemplateName":null,
        "ViewType":"HTML",
        "ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"}}"
      },{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "type":"SP.View"
        },
        "ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
        "Aggregations":null,
        "AggregationsStatus":null,
        "BaseViewId":"2",
        "ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"},"StringValue":"0x"},
        "DefaultView":false,
        "DefaultViewForContentType":false,
        "EditorModified":false,
        "Formats":null,
        "Hidden":false,
        "HtmlSchemaXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query></View>",
        "Id":"0dc42244-4bae-4da9-b074-8b8e9d8e50bc",
        "ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
        "IncludeRootFolder":false,
        "ViewJoins":null,
        "JSLink":"hierarchytaskslist.js",
        "ListViewXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
        "Method":null,
        "MobileDefaultView":false,
        "MobileView":true,
        "ModerationType":null,
        "OrderedView":false,
        "Paged":true,
        "PersonalView":false,
        "ViewProjectedFields":null,
        "ViewQuery":"<Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy>",
        "ReadOnlyView":false,
        "RequiresClientIntegration":false,
        "RowLimit":100,
        "Scope":0,
        "ServerRelativeUrl":"/Lists/Backlog items/late.aspx",
        "StyleId":null,
        "Threaded":false,
        "Title":"Late Tasks",
        "Toolbar":"",
        "ToolbarTemplateName":null,
        "ViewType":"HTML",
        "ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"
      },{
        …
      }]
    }}

Recurso ViewFieldCollection

Representa una colección de campos de una vista de lista.

URI del extremo  |  Propiedades  |  Métodos  |  Representación OData

URI del extremo

http://<url del sitio>/_api/web/lists(guid'<id. de lista>')/views('<id. de vista>')/viewfields

Métodos HTTP compatibles

GET  |  POST

Ejemplos de solicitudes

Ejemplo de solicitud GET: obtener todos los campos de una vista

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedades ViewFieldCollection

Para obtener una propiedad, envíe una solicitud GET al extremo de la propiedad, tal como se muestra en el siguiente ejemplo.

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields/schemaxml
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propiedad

Tipo

L/E

Devuelta con recurso

Description

SchemaXml

String

L

Obtiene un valor que especifica el esquema XML que representa la colección.

Elementos

Collection(String)

L

Especifica el esquema XML de la colección de campos. La propiedad Items se devuelve con el recurso, pero no tiene un extremo de URI direccionable.

Métodos ViewFieldCollection

AddViewField
MoveViewFieldTo
RemoveAllViewFields
RemoveViewField

Método AddViewField

Agrega el campo con el nombre para mostrar o nombre interno de campo especificado a la colección.

Extremo

/addviewfield('<nombre de campo>')

Parámetros

Tipo: String
E nombre interno o nombre para mostrar con distinción de mayúsculas y minúsculas del campo que se va a agregar.

HTTP method

POST

Respuesta

Ninguna

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /addviewfield('AssignedTo')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método MoveViewFieldTo

Mueve el campo con el nombre interno de campo especificado a la posición especificada de la colección.

Extremo

/moveviewfieldto

Parámetros

field

Tipo: String
El nombre interno con distinción de mayúsculas y minúsculas del campo que se va a mover. Envíe este parámetro y el parámetro index en el cuerpo de la solicitud, tal como se muestra en el ejemplo.

index

Tipo: Int32
El índice de base cero de la nueva posición del campo. Envíe este parámetro y el parámetro field en el cuerpo de la solicitud, tal como se muestra en el ejemplo.

HTTP method

POST

Respuesta

Ninguna

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /moveviewfieldto
    ?@target='<host web url>'",
  method: "POST",
  body: "{ 'field': 'DueDate', 'index': 0 }",
  headers: { "content-type": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método RemoveAllViewFields

Quita todos los campos de la colección.

Extremo

/removeallviewfields

Parámetros

Ninguna

HTTP method

POST

Respuesta

Ninguna

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /removeallviewfields
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método RemoveViewField

Quita el campo con el nombre interno de campo especificado de la colección.

Extremo

/removeviewfield('<nombre de campo>')

Parámetros

Tipo: String
El nombre interno con distinción de mayúsculas y minúsculas del campo que se va a quitar de la vista.

HTTP method

POST

Respuesta

Ninguna

Ejemplo de solicitud

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /removeviewfield('AssignedTo')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Representación OData

El siguiente ejemplo muestra un Recurso ViewFieldCollection en formato JSON.

    {"d":{
      "__metadata":{
        "id":"https://<site url>/_api/SP.AppContextSite(@target)/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields",
        "uri":"https://<site url>/_api/SP.AppContextSite(@target)/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields",
        "type":"SP.ViewFieldCollection"
      },
      "SchemaXml":"<FieldRef Name=\"Checkmark\" /><FieldRef Name=\"Status\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" />",
      "Items":{"results":["Checkmark", "Status", "LinkTitle", "DueDate"]}
    }}

Recursos adicionales