Tipos complejos en el espacio de nombres de SP
Búsqueda de tipos complejos del espacio de nombres de SP que la interfaz REST de SharePoint utiliza.
Última modificación: lunes, 9 de marzo de 2015
Hace referencia a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013
En la interfaz REST, los tipos complejos se envían en el cuerpo de la solicitud en POST, MERGE, y las solicitudes PUT y como parámetros de método. A continuación, regresan copo tipos de datos de propiedad y objeto.
Tipo complejo AppLicense
Representa una licencia de la aplicación para el usuario especificado para la Complemento de SharePoint determinada.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
RawXMLLicenseToken |
String |
Obtiene un fragmento de XML que representa el token de licencia de la aplicación, que contiene información de propiedad de la licencia. |
verdadero |
Tipo complejo AppLicenseCollection
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Items |
Collection(SP.AppLicense) |
Una colección de licencias de aplicaciones. |
verdadero |
Tipo complejo AppPrincipalConfiguration
La configuración asociada con una entidad de seguridad de aplicaciones.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
ApplicationEndpointAuthorities |
Collection(String) |
La lista de autoridades de extremo expuestas por la entidad de seguridad. |
verdadero |
ApplicationPrincipalNames |
Collection(String) |
La lista de nombres de la entidad de seguridad. |
verdadero |
NameIdentifier |
String |
El identificador del nombre de la entidad de seguridad. |
verdadero |
RedirectAddresses |
Collection(String) |
La lista de direcciones de la redirección para la entidad de seguridad. |
verdadero |
Tipo complejo AppPrincipalCredentialReference
Representa una referencia a una credencial para una entidad de seguridad de aplicaciones.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Id |
Guid |
El identificador único de la entidad de seguridad. |
falso |
NameIdentifier |
String |
El identificador del nombre de la entidad de seguridad. |
verdadero |
NotAfter |
DateTime |
El tiempo en que vence esta clave. |
falso |
NotBefore |
DateTime |
La hora en que se valida esta clave. |
falso |
Tipo complejo BasePermissions
Representa permisos de base para una definición de roles.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
High |
Int64 |
El límite de orden superior bit a bit (32 bits superiores) del permiso. |
falso |
Low |
Int64 |
El límite de orden inferior bit a bit (32 bits inferiores) del permiso. |
falso |
Tipo complejo CamlQuery
Especifica una consulta de Lenguaje de marcado de aplicaciones de colaboración (CAML) en una lista o en listas combinadas.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
DatesInUtc |
Boolean |
Obtiene o establece un valor que indica si la consulta devuelve las fechas en formato de hora universal coordinada (UTC). |
falso |
FolderServerRelativeUrl |
String |
Obtiene o establece un valor que especifica la dirección URL relativa al servidor de una carpeta de lista desde la cual se devolverán resultados. |
verdadero |
ListItemCollectionPosition |
Obtiene o establece un valor que especifica la información necesaria para obtener la página de datos siguiente de la vista de lista. |
verdadero |
|
ViewXml |
String |
Obtiene o establece un valor que especifica el esquema XML que define la vista de lista. |
verdadero |
Tipo complejo ChangeLogItemQuery
Representa el parámetro de entrada del método GetListItemChangesSinceToken.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
ChangeToken |
String |
El token de cambio para la solicitud. |
verdadero |
Contains |
String |
El elemento XML que define el filtrado personalizado para la consulta. |
verdadero |
Query |
String |
Los registros de la lista que se devolverán y su orden de devolución. |
verdadero |
QueryOptions |
String |
Las opciones para modificar la consulta. |
verdadero |
RowLimit |
String |
El número máximo de elementos en la consulta que se devolverá por página. |
verdadero |
ViewFields |
String |
Los nombres de los campos que se incluirán en el resultado de la consulta. |
verdadero |
ViewName |
String |
El GUID de la vista. |
verdadero |
Tipo complejo ChangeQuery
Define una consulta realizada en el registro de cambios.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Add |
Boolean |
Obtiene o establece un valor que especifica si los cambios de adición se incluyen en la consulta. |
falso |
Alert |
Boolean |
Obtiene o establece un valor que especifica si los cambios en las alertas se incluyen en la consulta. |
falso |
ChangeTokenEnd |
Obtiene o establece un valor que especifica la fecha y hora de finalización de los cambios que se devuelven mediante la consulta. |
falso |
|
ChangeTokenStart |
Obtiene o establece un valor que especifica la fecha y hora de inicio de los cambios que se devuelven mediante la consulta. |
falso |
|
ContentType |
Boolean |
Obtiene o establece un valor que especifica si los cambios en los tipos de contenido se incluyen en la consulta. |
falso |
DeleteObject |
Boolean |
Obtiene o establece un valor que especifica si los cambios en los tipos de contenido se incluyen en la consulta. |
falso |
Field |
Boolean |
Obtiene o establece un valor que especifica si los cambios en los tipos de contenido se incluyen en la consulta. |
falso |
File |
Boolean |
Obtiene o establece un valor que especifica si los cambios en los tipos de contenido se incluyen en la consulta. |
falso |
Folder |
Boolean |
Obtiene o establece un valor que especifica si los cambios en las carpetas se incluyen en la consulta. |
falso |
Group |
Boolean |
Obtiene o establece un valor que especifica si los cambios en los grupos se incluyen en la consulta. |
falso |
GroupMembershipAdd |
Boolean |
Obtiene o establece un valor que especifica si la adición de usuarios a grupos se incluye en la consulta. |
falso |
GroupMembershipDelete |
Boolean |
Obtiene o establece un valor que especifica si la eliminación de usuarios de los grupos se incluye en la consulta. |
falso |
Item |
Boolean |
Obtiene o establece un valor que especifica si los cambios generales en los elementos de lista se incluyen en la consulta. |
falso |
List |
Boolean |
Obtiene o establece un valor que especifica si los cambios en las listas se incluyen en la consulta. |
falso |
Move |
Boolean |
Obtiene o establece un valor que especifica si los cambios de movimiento se incluyen en la consulta. |
falso |
Navigation |
Boolean |
Obtiene o establece un valor que especifica si los cambios en la estructura de navegación de una colección de sitios se incluyen en la consulta. |
falso |
Rename |
Boolean |
Obtiene o establece un valor que especifica si los cambios de nombre se incluyen en la consulta. |
falso |
Restore |
Boolean |
Obtiene o establece un valor que especifica si la restauración de elementos desde la papelera de reciclaje o desde copias de seguridad se incluye en la consulta. |
falso |
RoleAssignmentAdd |
Boolean |
Obtiene o establece un valor que especifica si la adición de asignaciones de roles se incluye en la consulta. |
falso |
RoleAssignmentDelete |
Boolean |
Obtiene o establece un valor que especifica si la adición de asignaciones de roles se incluye en la consulta. |
falso |
RoleDefinitionAdd |
Boolean |
Obtiene o establece un valor que especifica si la adición de asignaciones de roles se incluye en la consulta. |
falso |
RoleDefinitionDelete |
Boolean |
Obtiene o establece un valor que especifica si la adición de asignaciones de roles se incluye en la consulta. |
falso |
RoleDefinitionUpdate |
Boolean |
Obtiene o establece un valor que especifica si la adición de asignaciones de roles se incluye en la consulta. |
falso |
SecurityPolicy |
Boolean |
Obtiene o establece un valor que especifica si las modificaciones en las directivas de seguridad se incluyen en la consulta. |
falso |
Site |
Boolean |
Obtiene o establece un valor que especifica si los cambios en las colecciones de sitios se incluyen en la consulta. |
falso |
SystemUpdate |
Boolean |
Obtiene o establece un valor que especifica si las actualizaciones realizadas mediante el método SystemUpdate del elemento se incluyen en la consulta. |
falso |
Update |
Boolean |
Obtiene o establece un valor que especifica si los cambios de actualización se incluyen en la consulta. |
falso |
User |
Boolean |
Obtiene o establece un valor que especifica si los cambios en los usuarios se incluyen en la consulta. |
falso |
View |
Boolean |
Obtiene o establece un valor que especifica si los cambios en las vistas se incluyen en la consulta. |
falso |
Web |
Boolean |
Obtiene o establece un valor que especifica si los cambios en los sitios web se incluyen en la consulta. |
falso |
Tipo complejo ChangeToken
Representa la ubicación secuencial única de un cambio dentro del registro de cambios.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
StringValue |
String |
Obtiene o establece un valor de cadena que contiene la representación serializada del token de cambio generado por el servidor de protocolo. |
verdadero |
Tipo complejo ContentTypeCreationInformation
Especifica propiedades que se usan como parámetros para inicializar un nuevo tipo de contenido.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Descripción |
String |
Obtiene o establece un valor que especifica la descripción del tipo de contenido que se creará. |
verdadero |
Group |
String |
Obtiene o establece un valor que especifica el grupo de tipos de contenido del tipo de contenido que se creará. |
verdadero |
Id |
String |
verdadero |
|
Nombre de la propiedad |
String |
Obtiene o establece un valor que especifica el nombre del tipo de contenido que se creará. |
verdadero |
Tipo complejo ContentTypeId
Representa el identificador de tipo de contenido de un tipo de contenido.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
StringValue |
String |
Una cadena de caracteres hexadecimales que representa el identificador de tipo de contenido. |
verdadero |
Tipo complejo ContextWebInformation
La información de contexto para un sitio.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
FormDigestTimeoutSeconds |
Int32 |
La cantidad de tiempo en segundos en que se agotará el tiempo de espera de la síntesis del formulario. |
falso |
FormDigestValue |
String |
El valor de síntesis del formulario. |
verdadero |
LibraryVersion |
String |
La versión de la biblioteca. |
verdadero |
SiteFullUrl |
String |
La dirección URL completa del contexto de colección de sitios. |
verdadero |
SupportedSchemaVersions |
Collection(String) |
La versión compatible de esquema de solicitud del modelo de objetos de cliente. |
verdadero |
WebFullUrl |
String |
La dirección URL completa del contexto de sitio. |
verdadero |
Tipo complejo DocumentLibraryInformation
Representa información sobre una biblioteca de documentos.
Nombre de la propiedad |
Tipo |
Descripción |
Acepta valores NULL |
---|---|---|---|
Modificado |
DateTime |
La última fecha de modificación. |
falso |
ModifiedFriendlyDisplay |
String |
La pantalla descriptiva para la última fecha de modificación. |
verdadero |
ServerRelativeUrl |
String |
La dirección URL relativa al servidor de la biblioteca de documentos. |
verdadero |
Title |
String |
El título de la biblioteca de documentos. |
verdadero |
Tipo complejo EventReceiverDefinitionCreationInformation
Especifica la información de creación del receptor de eventos.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
EventType |
Int32 |
El tipo de evento. Consulte EventReceiverType en la referencia de modelo de objetos de cliente .NET para ver una lista de valores. |
falso |
ReceiverAssembly |
String |
Especifica el nombre seguro del ensamblado que se usa para recibir eventos. |
verdadero |
ReceiverClass |
String |
Especifica una cadena que representa la clase que se usa para recibir eventos. |
verdadero |
ReceiverName |
String |
Especifica el nombre del receptor de eventos. |
verdadero |
ReceiverUrl |
String |
Especifica la dirección URL de un servicio web que se usa para recibir eventos. |
verdadero |
SequenceNumber |
Int32 |
Especifica un entero que representa la secuencia relativa del evento. |
falso |
Synchronization |
Int32 |
Especifica la sincronización de la ejecución del receptor de eventos. |
falso |
Tipo complejo ExternalAppPrincipalCreationParameters
Representa el objeto que encapsula todos los parámetros utilizados para crear una nueva entidad de seguridad de aplicaciones externa.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
AppIdentifier |
String |
El identificador único de la entidad de seguridad de aplicaciones. |
verdadero |
ApplicationEndpointAuthorities |
Collection(String) |
La lista de hostname[:port] que expone los extremos de la aplicación. |
verdadero |
DisplayName |
String |
El nombre para mostrar de la entidad de seguridad de aplicaciones. |
verdadero |
RedirectAddresses |
Collection(String) |
Las direcciones de redirección. |
verdadero |
TrustedForDelegation |
Boolean |
Indica si la entidad de seguridad de la aplicación es de confianza para la delegación. |
falso |
Tipo complejo FieldCalculatedErrorValue
Representa el valor del campo calculado de un elemento de lista cuando el valor del campo es un error de cálculo, como una división por cero o un desbordamiento.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
ErrorMessage |
String |
Obtiene el mensaje de error de un campo calculado. |
verdadero |
Tipo complejo FieldCreationInformation
Representa las propiedades que se pueden establecer al crear un campo.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Choices |
Collection(String) |
Los valores que están disponibles para selección en el campo. |
verdadero |
IsCompactName |
Boolean |
Indica si se utilizan solo los ocho primeros caracteres del nombre de campo. |
falso |
LookupFieldName |
String |
El nombre del campo de búsqueda de origen. |
verdadero |
LookupListId |
Guid |
El Id. de la lista de destino para el campo de búsqueda de origen. |
falso |
LookupWebId |
Guid |
El Id. del sitio que contiene la lista que es el origen para el valor del campo de búsqueda. |
falso |
Required |
Boolean |
Obtiene o establece un valor que especifica si el campo requiere un valor. |
falso |
Title |
String |
Obtiene o establece un valor que especifica el nombre para mostrar del campo. |
verdadero |
FieldTypeKind |
Int32 |
Obtiene o establece un valor que especifica el tipo del campo. |
falso |
Tipo complejo FieldGeolocationValue
Representa los valores de altitud, latitud, longitud y medida de un campo de geolocalización.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Altitude |
Double |
El valor de altitud definido por el usuario para un campo de geolocalización. |
falso |
Latitude |
Double |
El valor de latitud de un campo de geolocalización. |
falso |
Longitude |
Double |
El valor de longitud de un campo de geolocalización. |
falso |
Measure |
Double |
El valor de medida definido por el usuario para un campo de geolocalización. |
falso |
Tipo complejo FieldLookupValue
Especifica el valor de una búsqueda de un campo dentro de un elemento de lista.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
LookupId |
Int32 |
Obtiene o establece el identificador del elemento de lista al que hace referencia esta instancia del campo de búsqueda. |
falso |
LookupValue |
String |
Obtiene un resumen del elemento de lista al que hace referencia esta instancia del campo de búsqueda. |
verdadero |
Tipo complejo FieldRatingScaleQuestionAnswer
Representa una subpregunta y una subrespuesta específicas dentro de un campo de escala de clasificación de un elemento de lista.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Answer |
Int32 |
Obtiene o establece un valor que especifica la respuesta a una subpregunta. |
falso |
Question |
String |
Obtiene o establece un valor que especifica una subpregunta dentro de una escala de clasificación. |
verdadero |
Tipo complejo FieldUrlValue
Especifica el hipervínculo y los valores de descripción de FieldURL.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Descripción |
String |
Obtiene o establece un valor que especifica la descripción del URI. |
verdadero |
Url |
String |
Especifica el URI. |
verdadero |
Tipo complejo FieldUserValue
Representa el valor de un campo de usuario de un elemento de lista. Hereda de SP.FieldLookupValue.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
LookupId |
Int32 |
El identificador de usuario que el valor de un campo de búsqueda para datos de usuario representa. |
falso |
LookupValue |
String |
El usuario que el valor de un campo de búsqueda para datos de usuario representa. |
verdadero |
Tipo complejo FileCreationInformation
Representa las propiedades que se pueden establecer al crear un archivo mediante el método FileCollection.Add.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Content |
Binary |
El contenido binario del archivo. |
verdadero |
overwrite |
Boolean |
Indica si se debe sobrescribir un archivo existente con el mismo nombre y en la misma ubicación que el que se agrega. |
falso |
Url |
String |
La dirección URL del archivo. |
verdadero |
Tipo complejo GroupCreationInformation
Un objeto que se usa para facilitar la creación de un grupo entre sitios.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Descripción |
String |
Obtiene o establece una cadena que contiene la descripción del grupo que se creará. |
verdadero |
Title |
String |
Obtiene o establece una cadena que contiene el nombre del grupo que se creará. |
verdadero |
Tipo complejo KeyValue
Representa un diccionario de pares de clave y valor.
Propiedades
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Key |
String |
La clave. |
verdadero |
Value |
String |
El valor. |
verdadero |
ValueType |
String |
El tipo de valor |
verdadero |
Tipo complejo Language
Representa un lenguaje natural usado dentro del contexto de Microsoft SharePoint Foundation.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
DisplayName |
String |
Representa un lenguaje natural usado dentro del contexto de Microsoft SharePoint Foundation. |
verdadero |
LanguageTag |
String |
Obtiene la etiqueta de idioma para este idioma. |
verdadero |
Lcid |
Int32 |
Obtiene el identificador de configuración regional (LCID) para el idioma. |
falso |
Tipo complejo ListDataSource
Representa información asociada con una conexión a un origen de datos externo.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Propiedades |
Collection(SP.KeyValue) |
Obtiene las propiedades asociadas con la conexión al origen de datos. |
verdadero |
Tipo complejo ListDataValidationExceptionValue
Excepción que se arroja cuando se produce un error en la validación de los datos de un campo de lista o de un elemento de lista.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
FieldFailures |
Collection(SP.ListDataValidationFailure) |
Los errores de validación de un campo. |
verdadero |
ItemFailure |
Los errores de validación de un elemento de lista. |
verdadero |
Tipo complejo ListDataValidationFailure
Describe un error de validación específico cuando se inserta o actualiza un elemento de lista.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
DisplayName |
String |
Obtiene el título de la lista o el nombre para mostrar del campo donde se produjo el error de validación. |
verdadero |
Message |
String |
Obtiene un mensaje con información sobre el error. |
verdadero |
Name |
String |
Obtiene el nombre de campo o el identificador de lista en el que se produjo el error de validación. |
verdadero |
Reason |
Int32 |
Obtiene el motivo del error. |
falso |
ValidationType |
Int32 |
Describe el tipo de validación que ocasionó el error. |
falso |
Tipo complejo ListItemCollectionPosition
Especifica la información necesaria para obtener la página de datos siguiente de una vista de lista.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
PagingInfo |
String |
Obtiene o establece un valor que especifica la información necesaria, como pares nombre-valor, para obtener la página de datos siguiente de una vista de lista. |
verdadero |
Tipo complejo ListItemCreationInformation
Especifica las propiedades del elemento de lista nuevo.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
FolderUrl |
String |
Obtiene o establece un valor que especifica la carpeta del elemento de lista nuevo. |
verdadero |
LeafName |
String |
Obtiene o establece un valor que especifica el nombre del elemento de lista nuevo. Debe ser el nombre del archivo si la lista primaria del elemento de lista es una biblioteca de documentos. |
verdadero |
UnderlyingObjectType |
Int32 |
Obtiene o establece un valor que especifica si el elemento de lista nuevo es un archivo o una carpeta. |
falso |
Tipo complejo ListItemFormUpdateValue
Representa las propiedades de un campo de elemento de lista y su valor.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
ErrorMessage |
String |
El resultado del mensaje de error después de validar el valor para el campo. |
verdadero |
FieldName |
String |
El nombre interno del campo. |
verdadero |
FieldValue |
String |
El valor del campo. |
verdadero |
HasException |
Boolean |
Indica si se produjo un resultado de error después de validar el valor para el campo. |
falso |
Tipo complejo MenuNode
Representa un nodo de navegación en la jerarquía de navegación. Una jerarquía de navegación es una estructura de árbol de nodos de navegación.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
CustomProperties |
Collection(SP.KeyValue) |
Propiedades Node. |
verdadero |
FriendlyUrlSegment |
String |
La dirección URL del nodo de navegación en relación con la dirección URL del nodo de navegación principal. |
verdadero |
IsHidden |
Boolean |
Indica si el nodo está oculto en el menú de navegación. Durante la edición, todos los nodos quedan visibles temporalmente. |
falso |
Key |
String |
El identificador del nodo de navegación en el árbol de menú. |
verdadero |
Nodes |
Collection(SP.MenuNode) |
Los nodos secundarios. |
verdadero |
NodeType |
Int32 |
El tipo del nodo de navegación. |
falso |
SimpleUrl |
String |
La dirección de URL absoluta o relativa del nodo de navegación. Las direcciones URL relativas del sitio pueden comenzar con el token "~ sitio", y las direcciones URL relativas de la colección pueden comenzar con el token "~ sitecollection". Se aplica solo a tipos de nodo SimpleLink. |
verdadero |
Title |
String |
El título del nodo de navegación. |
verdadero |
Tipo complejo MenuState
Representa el estado de menú del SiteMapProvider ("SPSiteMapProvider") predeterminado donde comienza el volcado en el nodo raíz del sitio con una profundidad de 10 niveles.
Los parámetros siguientes están disponibles para consultar el estado del menú:
menuNodeKey |
La clave del nodo de inicio. Si no se proporciona ninguna clave, se utiliza el nodo raíz. |
depth |
La profundidad del volcado. El valor predeterminado es 10. |
customProperties |
(Opcionalmente, implementado por un proveedor de datos de mapas de sitio). Una lista separada por comas de propiedades personalizadas para devolver. Utilice el carácter "\" para escape de un separador de coma dentro de una propiedad. |
mapProviderName |
Especifica qué proveedor está seleccionado en el sitio. Si no se usa ningún SiteMapProvider, se usa "CurrentNavSiteMapProviderNoEncode". |
Solicitudes de ejemplo:
http://<site url>/_api/navigation/menustate?menuNodeKey='1006'&depth=5 devuelve el estado del menú de "SPSiteMapProvider", comenzando por el nodo con la clave 1006 con una profundidad de 5.
http://<site url>/_api/navigation/menustate?depth=5&mapProviderName='CurrentNavSiteMapProviderNoEncode' devuelve el estado del menú de "CurrentNavSiteMapProviderNoEncode" desde el nodo raíz del proveedor con una profundidad de 5.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
FriendlyUrlPrefix |
String |
Especifica la dirección URL relativa a la colección de sitios para el nodo raíz del árbol de menú. |
verdadero |
Nodes |
Collection(SP.MenuNode) |
Los nodos secundarios del nodo raíz del árbol de menú. |
verdadero |
SimpleUrl |
String |
La dirección de URL absoluta o relativa del nodo de navegación. Las direcciones URL relativas del sitio pueden comenzar con el token URL "~ sitio", y las direcciones URL relativas de la colección pueden comenzar con el token URL "~ sitecollection". Se aplica solo a tipos de nodo SimpleLink. |
verdadero |
SPSitePrefix |
String |
La cadena que reemplaza al token "~ sitecollection" en vínculos relativos a la colección de sitios. Por ejemplo, para hacer que el comando Probar vínculo funcione con el vínculo relativo ~sitecollection/Pages/MyPage.aspx, este valor podría ser https://contoso.com/sites/site1/. |
verdadero |
SPWebPrefix |
String |
La cadena que reemplaza al token "~ site" en vínculos relativos a sitios. Por ejemplo, para hacer que el comando Probar vínculo funcione con el vínculo relativo ~site/Pages/MyPage.aspx, este valor podría ser https://contoso.com/sites/site1/web1. |
verdadero |
StartingNodeKey |
String |
El identificador del nodo raíz del árbol de menú. |
verdadero |
StartingNodeTitle |
String |
El título del nodo raíz del árbol de menú. (Ejemplo: "Centro de documentos") |
verdadero |
Version |
String |
Un valor específico de la implementación que el servidor utiliza para detectar los cambios externos. Por ejemplo, podría ser una marca de tiempo del cambio de la base de datos o un número de versión de incremento continuo como "2009-06-15T20:45:30Z". |
verdadero |
Tipo complejo NavigationNodeCreationInformation
Describe un nodo de navegación nuevo que se creará.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
AsLastNode |
Boolean |
Obtiene o establece un valor que especifica si el nodo de navegación se creará como el último nodo de la colección. |
falso |
IsExternal |
Boolean |
Obtiene o establece un valor que especifica si es posible que la dirección URL del nodo de navegación corresponda a páginas externas de la colección de sitios. |
falso |
Title |
String |
Obtiene o establece un valor que especifica el texto de hipervínculo del vínculo del nodo de navegación. |
verdadero |
Url |
String |
Obtiene o establece un valor que especifica la dirección URL que se almacenará con el nodo de navegación. |
verdadero |
Tipo complejo RelatedItem
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
IconUrl |
String |
verdadero |
|
ItemId |
Int32 |
falso |
|
ListId |
String |
verdadero |
|
Title |
String |
verdadero |
|
Url |
String |
verdadero |
|
WebId |
String |
verdadero |
Tipo complejo RenderListDataParameters
Representa los parámetros que se utilizan para representar los datos de la lista como cadena Notación de objetos de JavaScript (JSON).
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
FolderServerRelativeUrl |
String |
La dirección URL de la carpeta desde la cual devolver los elementos. |
verdadero |
Paging |
String |
La información de paginación. |
verdadero |
ViewXml |
String |
El XML de vista de CAML (Lenguaje de marcado de aplicaciones de colaboración). |
verdadero |
Tipo complejo RoleDefinitionCreationInformation
Contiene propiedades que se usan como parámetros para inicializar una definición de roles.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
BasePermissions |
Obtiene o establece un valor que especifica los permisos de la definición de roles. |
verdadero |
|
Description |
String |
Obtiene o establece un valor que especifica una descripción de la definición de roles. |
verdadero |
Property name |
String |
Obtiene o establece un valor que especifica el nombre de la definición de roles. |
verdadero |
Order |
Int32 |
Obtiene o establece un valor que especifica el orden en que se muestran los roles. |
falso |
Tipo complejo SimpleDataRow
Representa una fila en una tabla de datos
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Cells |
Collection(SP.KeyValue) |
Las celdas de la fila. |
verdadero |
Tipo complejo SimpleDataTable
Representa una tabla de datos.
Propiedades
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Rows |
Collection(SP.SimpleDataRow) |
Las filas de la tabla. |
verdadero |
Tipo complejo TimeZoneInformation
Representa la información sobre una zona horaria.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Bias |
Int32 |
El número de minutos que la zona horaria difiere de la hora universal coordinada (UTC). Un valor positivo indica que la zona horaria está detrás de UTC. |
falso |
DaylightBias |
Int32 |
El número de minutos que se agregan a la diferencia durante el horario de verano. |
falso |
StandardBias |
Int32 |
El número de minutos que se agrega a la diferencia fuera del horario de verano. |
falso |
Tipo complejo UpgradeInfo
Representa la información de actualización de la colección de sitios.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
ErrorFile |
String |
La ubicación del archivo que contiene los errores de actualización. |
verdadero |
Errors |
Int32 |
El número de errores encontrados durante la actualización de la colección de sitios. |
falso |
LastUpdated |
DateTime |
El valor de DateTime de la última actualización del progreso de la actualización. |
falso |
LogFile |
String |
La ubicación del archivo que contiene el registro de actualización. |
verdadero |
RequestDate |
DateTime |
El valor de DateTime en que se solicitó la actualización de la colección de sitios. |
falso |
RetryCount |
Int32 |
El número de veces que se ha intentado actualizar la colección de sitios. |
falso |
StartTime |
DateTime |
El valor de DateTime en que se inició la actualización de la colección de sitios. |
falso |
Status |
Int32 |
El estado actual de la actualización de la colección de sitios. |
falso |
UpgradeType |
Int32 |
El tipo de actualización de la colección de sitios. El tipo puede ser una actualización de una compilación a otra (valor = 0) o una actualización de una versión a otra (valor = 1). |
falso |
Warnings |
Int32 |
El número de advertencias encontradas durante la actualización de la colección de sitios. |
falso |
Tipo complejo UsageInfo
Proporciona campos que se usan para obtener acceso a información sobre el uso de la colección de sitios.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Bandwidth |
Int64 |
Obtiene un valor que especifica el ancho de banda acumulativo, en bytes, que usa la colección de sitios durante un período específico de la implementación. |
falso |
DiscussionStorage |
Int64 |
Obtiene un valor que especifica la cantidad total de espacio en disco, en bytes, que se usa actualmente para almacenar comentarios de discusiones web en la colección de sitios. |
falso |
Hits |
Int64 |
Obtiene un valor que especifica el número acumulativo de solicitudes en las páginas de la colección de sitios durante un período específico de la implementación. |
falso |
Storage |
Int64 |
Obtiene un valor que especifica la cantidad total de espacio en disco, en bytes, que usa actualmente la colección de sitios. |
falso |
StoragePercentageUsed |
Double |
Obtiene un valor que especifica la relación de la cantidad de espacio en disco que usa actualmente la colección de sitios con respecto al espacio en disco máximo especificado en la cuota de la colección de sitios. |
falso |
Visits |
Int64 |
Obtiene un valor que especifica el número acumulativo de solicitudes en las páginas de la colección de sitios, sin ninguna dirección URL de referencia o con una que se encuentre fuera de la colección de sitios actual durante un período específico de la implementación. |
falso |
Tipo complejo UserCreationInformation
Parámetros para invitar a un usuario.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
String |
Obtiene o establece un valor que especifica la dirección de correo electrónico del usuario que se creará. |
verdadero |
|
LoginName |
String |
Obtiene o establece un valor que especifica el nombre de inicio de sesión del usuario que se creará. |
verdadero |
Title |
String |
Obtiene o establece un valor que especifica el nombre para mostrar del usuario que se creará. |
verdadero |
Tipo complejo UserIdInfo
Representa la información del identificador único de un proveedor de identidad.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
NameId |
String |
El Identificador único del proveedor de identidad. |
verdadero |
NameIdIssuer |
String |
El nombre para mostrar del proveedor de identidad tal como está registrado en una granja de servidores. |
verdadero |
Tipo complejo ViewCreationInformation
Especifica las propiedades usadas para crear una vista de lista nueva.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Paged |
Boolean |
Obtiene o establece un valor que especifica si la vista de lista nueva es una vista de página. |
falso |
PersonalView |
Boolean |
Obtiene o establece un valor que especifica si la vista de lista nueva es una vista personal. Si el valor es falso, la vista de lista nueva es una vista pública. |
falso |
Query |
String |
Obtiene o establece un valor que especifica la consulta de la vista de lista nueva. |
verdadero |
RowLimit |
Int32 |
Obtiene o establece un valor que especifica el número máximo de elementos de lista que muestra la vista de lista nueva en una página visual de la vista de lista. |
falso |
SetAsDefaultView |
Boolean |
Obtiene o establece un valor que especifica si la vista de lista nueva es la predeterminada. |
falso |
Title |
String |
Obtiene o establece el valor que especifica el nombre para mostrar de la vista de lista nueva. |
verdadero |
ViewFields |
Collection(String) |
Obtiene o establece el valor que especifica la colección de nombres internos de campo de los campos de lista de la vista de lista nueva. |
verdadero |
ViewTypeKind |
Int32 |
Obtiene o establece un valor que especifica el tipo de la vista de lista nueva. |
falso |
Tipo complejo WebCreationInformation
Especifica las propiedades de un sitio nuevo.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Description |
String |
Obtiene o establece la descripción del sitio nuevo. |
verdadero |
Language |
Int32 |
Obtiene o establece el identificador de configuración regional que especifica el idioma del sitio nuevo. |
falso |
Title |
String |
Obtiene o establece un valor que especifica el título del sitio nuevo. |
verdadero |
Url |
String |
Obtiene o establece el nombre de hoja de la dirección URL del sitio nuevo. La dirección URL no debe contener lo siguiente: |
verdadero |
UseSamePermissionsAsParentSite |
Boolean |
Obtiene o establece un valor que especifica si el sitio nuevo heredará los permisos de su sitio primario. |
falso |
WebTemplate |
String |
Obtiene o establece un valor que especifica el nombre de la plantilla de sitio que se usará para crear el sitio nuevo. Use el método GetAvailableWebTemplates para obtener los nombres de las plantillas web disponibles en el sitio. |
verdadero |
Tipo complejo WebInfoCreationInformation
Representa metadatos acerca de la creación de sitios.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Description |
String |
La descripción del sitio. |
verdadero |
Language |
Int32 |
Un identificador de configuración regional (LCID) del idioma que utilice en el sitio. |
falso |
Title |
String |
El título del sitio. |
verdadero |
Url |
String |
La dirección URL del sitio. La dirección URL no debe contener lo siguiente: |
verdadero |
UseUniquePermissions |
Boolean |
Indica si el sitio hereda los permisos de su elemento primario. |
falso |
WebTemplate |
String |
El nombre de la plantilla de sitio que se utiliza para crear el sitio. |
verdadero |
Tipo complejo WebRequestInfo
Representa los datos del autor de la llamada necesarios para realizar la solicitud web de salida.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Body |
String |
Obtiene o establece el cuerpo del mensaje de solicitud HTTP. |
verdadero |
Headers |
Collection(SP.KeyValue) |
Obtiene o establece un diccionario que contiene los pares de nombre y valor de los encabezados para enviar en la solicitud HTTP. |
verdadero |
Method |
String |
Obtiene o establece el método HTTP de la solicitud web. |
verdadero |
Url |
String |
Obtiene o establece la dirección URL de la solicitud web. |
verdadero |
Tipo complejo WebResponseInfo
Contiene una copia de la respuesta del servicio de terceros.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Body |
String |
Obtiene o establece el cuerpo de la respuesta HTTP. |
true |
Headers |
Collection(SP.KeyValue) |
Obtiene o establece los encabezados de la respuesta HTTP. |
verdadero |
StatusCode |
Int32 |
Obtiene o establece el código de estado de la respuesta HTTP. |
falso |
Tipo complejo XmlSchemaFieldCreationInformation
Representa las propiedades que se pueden establecer al crear un campo.
Nombre de la propiedad |
Tipo |
Descripción |
|
---|---|---|---|
Options |
Int32 |
Las opciones que se utilizan para agregar al campo. Consulte AddFieldOptions en la referencia de modelo de objetos de cliente .NET para ver una lista de valores. |
falso |
SchemaXml |
String |
Una cadena CAML (Lenguaje de marcado de aplicaciones de colaboración) que contiene el esquema. |
verdadero |
Notas de implementación
Para parámetros de tipo Nullable, puede especificar un valor null si no incluye el parámetro en la cadena de consulta de la dirección URI.
Vea también
Conceptos
Referencia y ejemplos de las API de REST
Otros recursos
Introducción al servicio REST para SharePoint 2013
Procedimiento para realizar operaciones básicas con extremos REST de SharePoint 2013