SP 命名空间的复杂类型

  • 项目

从 SharePoint REST 界面使用的 SP 命名空间查找复杂类型。

上次修改时间：2015年3月9日

适用范围：apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

在 REST 界面中，复杂类型在 POST、MERGE 和 PUT 请求的请求正文中作为方法参数发送，并作为对象和属性数据类型返回。

AppLicense 复杂类型

表示用于指定 SharePoint 外接程序 的指定用户的应用程序许可证。

属性名称

类型

描述

可为空值

RawXMLLicenseToken

String

获取一个表示应用程序许可证令牌的 XML 片段，该片段包含许可证属性信息。

True

AppLicenseCollection 复杂类型

属性名称

类型

描述

可为空值

Items

Collection(SP.AppLicense)

应用程序许可证集合。

True

AppPrincipalConfiguration 复杂类型

与应用程序主体相关的配置。

属性名称

类型

描述

可为空值

ApplicationEndpointAuthorities

Collection(String)

主体暴露的终结点颁发机构列表。

True

ApplicationPrincipalNames

Collection(String)

主体的名称列表。

True

NameIdentifier

String

主体的名称标识符。

True

RedirectAddresses

Collection(String)

主体的重定向地址列表。

True

AppPrincipalCredentialReference 复杂类型

表示对应用程序主体凭据的引用。

属性名称

类型

描述

可为空值

Id

Guid

主体的唯一标识符。

FALSE

NameIdentifier

String

主体的名称标识符。

True

NotAfter

DateTime

此密钥的过期时间。

FALSE

NotBefore

DateTime

此密钥的生效时间。

FALSE

BasePermissions 复杂类型

表示角色定义的基本权限。

属性名称

类型

描述

可为空值

High

Int64

权限的按位高阶边界（较高 32 位）。

FALSE

Low

Int64

权限的按位低阶边界（较低 32 位）。

FALSE

CamlQuery 复杂类型

指定对列表或联接列表的协作应用程序标记语言 (CAML) 查询。

属性名称

类型

描述

可为空值

DatesInUtc

Boolean

获取或设置一个值，该值指示查询是否使用协调世界时 (UTC) 格式返回日期。

FALSE

FolderServerRelativeUrl

String

获取或设置一个值，该值指定从中返回结果的列表文件夹相对于服务器的 URL。

True

ListItemCollectionPosition

SP.ListItemCollectionPosition

获取或设置一个值，该值指定获取列表视图的下一页数据所需的信息。

True

ViewXml

String

获取或设置一个值，该值指定定义列表视图的 XML 架构。

True

ChangeLogItemQuery 复杂类型

表示 GetListItemChangesSinceToken 方法的输入参数。

属性名称

类型

描述

可为空值

ChangeToken

String

用于请求的更改令牌。

True

Contains

String

可为查询定义自定义筛选的 XML 元素。

True

Query

String

要从列表中返回的记录及其返回顺序。

True

QueryOptions

String

用于修改查询的选项。

True

RowLimit

String

在查询中每页返回的最大项数。

True

ViewFields

String

要包含在查询结果中的字段名称。

True

ViewName

String

视图的 GUID。

True

ChangeQuery 复杂类型

定义对更改日志执行的查询。

属性名称

类型

描述

可为空值

Add

Boolean

获取或设置一个值，该值指定添加更改是否包含在查询中。

FALSE

Alert

Boolean

获取或设置一个值，该值指定对提醒所做的更改是否包含在查询中。

FALSE

ChangeTokenEnd

SP.ChangeToken

获取或设置一个值，该值指定通过查询返回的更改的结束日期和结束时间。

FALSE

ChangeTokenStart

SP.ChangeToken

获取或设置一个值，该值指定通过查询返回的更改的开始日期和开始时间。

FALSE

ContentType

Boolean

获取或设置一个值，该值指定对内容类型所做的更改是否包含在查询中。

FALSE

DeleteObject

Boolean

获取或设置一个值，该值指定对内容类型所做的更改是否包含在查询中。

FALSE

Field

Boolean

获取或设置一个值，该值指定对内容类型所做的更改是否包含在查询中。

FALSE

File

Boolean

获取或设置一个值，该值指定对内容类型所做的更改是否包含在查询中。

FALSE

Folder

Boolean

获取或设置一个值，该值指定对文件夹所做的更改是否包含在查询中。

FALSE

Group

Boolean

获取或设置一个值，该值指定对组所做的更改是否包含在查询中。

FALSE

GroupMembershipAdd

Boolean

获取或设置一个值，该值指定向组中添加用户是否包含在查询中。

FALSE

GroupMembershipDelete

Boolean

获取或设置一个值，该值指定从组中删除用户是否包含在查询中。

FALSE

Item

Boolean

获取或设置一个值，该值指定对列表项所做的常规更改是否包含在查询中。

FALSE

List

Boolean

获取或设置一个值，该值指定对列表所做的更改是否包含在查询中。

FALSE

Move

Boolean

获取或设置一个值，该值指定移动更改是否包含在查询中。

FALSE

Navigation

Boolean

获取或设置一个值，该值指定对网站集的导航结构所做的更改是否包含在查询中。

FALSE

Rename

Boolean

获取或设置一个值，该值指定重命名更改是否包含在查询中。

FALSE

Restore

Boolean

获取或设置一个值，该值指定从回收站或备份还原项目是否包含在查询中。

FALSE

RoleAssignmentAdd

Boolean

获取或设置一个值，该值指定添加角色分配是否包含在查询中。

FALSE

RoleAssignmentDelete

Boolean

获取或设置一个值，该值指定添加角色分配是否包含在查询中。

FALSE

RoleDefinitionAdd

Boolean

获取或设置一个值，该值指定添加角色分配是否包含在查询中。

FALSE

RoleDefinitionDelete

Boolean

获取或设置一个值，该值指定添加角色分配是否包含在查询中。

FALSE

RoleDefinitionUpdate

Boolean

获取或设置一个值，该值指定添加角色分配是否包含在查询中。

FALSE

SecurityPolicy

Boolean

获取或设置一个值，该值指定安全策略修改是否包含在查询中。

FALSE

Site

Boolean

获取或设置一个值，该值指定对网站集所做的更改是否包含在查询中。

FALSE

SystemUpdate

Boolean

获取或设置一个值，该值指定使用项目 SystemUpdate 方法进行的更新是否包含在查询中。

FALSE

Update

Boolean

获取或设置一个值，该值指定更新更改是否包含在查询中。

FALSE

User

Boolean

获取或设置一个值，该值指定对用户所做的更改是否包含在查询中。

FALSE

View

Boolean

获取或设置一个值，该值指定对视图所做的更改是否包含在查询中。

FALSE

Web

Boolean

获取或设置一个值，该值指定对网站所做的更改是否包含在查询中。

FALSE

ChangeToken 复杂类型

表示某项更改在更改日志中的唯一顺序位置。

属性名称

类型

描述

可为空值

StringValue

String

获取或设置一个字符串值，该值包含由协议服务器生成的更改令牌的序列化表示形式。

True

ContentTypeCreationInformation 复杂类型

指定将用作参数来初始化新内容类型的属性。

属性名称

类型

描述

可为空值

描述

String

获取或设置一个值，该值指定将构建的内容类型的说明。

True

Group

String

获取或设置一个值，该值指定将构建的内容类型的内容类型组。

True

Id

String

True

Property name

String

获取或设置一个值，该值指定将构建的内容类型的名称。

True

ContentTypeId 复杂类型

表示内容类型的内容类型标识符 (ID)。

属性名称

类型

描述

可为空值

StringValue

String

表示内容类型 ID 的十六进制字符的字符串。

True

ContextWebInformation 复杂类型

网站的上下文信息。

属性名称

类型

描述

可为空值

FormDigestTimeoutSeconds

Int32

表单摘要将超时的时间量，以秒为单位。

FALSE

FormDigestValue

String

表单摘要值。

True

LibraryVersion

String

库版本。

True

SiteFullUrl

String

网站集上下文的完整 URL。

True

SupportedSchemaVersions

Collection(String)

支持的客户端对象模型请求架构版本。

True

WebFullUrl

String

网站上下文的完整 URL。

True

DocumentLibraryInformation 复杂类型

表示文档库的相关信息。

属性名称

类型

描述

可为空值

Modified

DateTime

上次修改日期。

FALSE

ModifiedFriendlyDisplay

String

上次修改日期的友好显示。

True

ServerRelativeUrl

String

文档库的服务器相对 URL 。

True

Title

String

文档库的标题。

True

EventReceiverDefinitionCreationInformation 复杂类型

指定事件接收器的创建信息。

属性名称

类型

描述

可为空值

EventType

Int32

事件的类型。有关值列表，请参阅 .NET 客户端对象模型引用中的 EventReceiverType。

FALSE

ReceiverAssembly

String

指定用于接收事件的程序集的强名称。

True

ReceiverClass

String

指定表示用于接收事件的类的字符串。

True

ReceiverName

String

指定事件接收器的名称。

True

ReceiverUrl

String

指定用于接收事件的 Web 服务的 URL。

True

SequenceNumber

Int32

指定一个整数，该整数表示事件的相对顺序。

FALSE

Synchronization

Int32

指定事件接收器的执行同步。

FALSE

ExternalAppPrincipalCreationParameters 复杂类型

表示封装了用于创建新的外部应用程序主体的所有参数的对象。

属性名称

类型

描述

可为空值

AppIdentifier

String

应用程序主体的唯一标识符。

True

ApplicationEndpointAuthorities

Collection(String)

暴露应用程序终结点的 hostname[:port] 列表。

True

DisplayName

String

应用程序主体的显示名称。

True

RedirectAddresses

Collection(String)

重定向地址。

True

TrustedForDelegation

Boolean

指示应用程序主体是否可信任进行委派。

FALSE

FieldCalculatedErrorValue 复杂类型

在字段的值存在计算错误，例如被零除或溢出时，表示列表项的计算字段的值。

属性名称

类型

描述

可为空值

ErrorMessage

String

获取计算字段的错误消息。

True

FieldCreationInformation 复杂类型

表示在创建字段时可以设置的属性。

属性名称

类型

描述

可为空值

Choices

Collection(String)

可供在字段中选择的值。

True

IsCompactName

Boolean

指示是否仅前八个字符用于字段名称。

FALSE

LookupFieldName

String

源查找字段的名称。

True

LookupListId

Guid

源查找字段的目标列表的 ID。

FALSE

LookupWebId

Guid

包含为查找字段值源的网站的 ID。

FALSE

Required

Boolean

获取或设置一个值，该值指定此字段是否需要值。

FALSE

Title

String

获取或设置一个值，该值指定字段的显示名称。

True

FieldTypeKind

Int32

获取或设置一个值，该值指定字段的类型。

FALSE

FieldGeolocationValue 复杂类型

表示用于地理位置字段的海拔、纬度、经度和度量值。

属性名称

类型

描述

可为空值

Altitude

Double

用于地理位置字段的用户定义的海拔值。

FALSE

Latitude

Double

地理位置字段的纬度值。

FALSE

Longitude

Double

用于地理位置字段的经度值。

FALSE

Measure

Double

用于地理位置字段的用户定义的度量值。

FALSE

FieldLookupValue 复杂类型

指定列表项内某字段的查阅值。

属性名称

类型

描述

可为空值

LookupId

Int32

获取或设置此查阅字段实例所引用的列表项的标识符 (ID)。

FALSE

LookupValue

String

获取此查阅字段实例引用的列表项的摘要。

True

FieldRatingScaleQuestionAnswer 复杂类型

表示列表项的评估范围字段内的特定子问题和答案。

属性名称

类型

描述

可为空值

Answer

Int32

获取或设置一个值，该值指定某个子问题的答案。

FALSE

Question

String

获取或设置一个值，该值指定评估范围内的子问题。

True

FieldUrlValue 复杂类型

指定 FieldURL 的超链接和描述值。

属性名称

类型

描述

可为空值

Description

String

获取或设置一个值，该值指定 URI 的描述。

True

Url

String

指定 URI。

True

FieldUserValue 复杂类型

表示列表项的用户字段的值。 继承自 SP.FieldLookupValue。

属性名称

类型

描述

可为空值

LookupId

Int32

用户数据的查找字段的值表示的用户 ID。

FALSE

LookupValue

String

用户数据的查找字段的值表示的用户。

True

FileCreationInformation 复杂类型

表示在使用 FileCollection.Add 方法创建文件时可以设置的属性。

属性名称

类型

描述

可为空值

Content

Binary

文件的二进制内容。

True

Overwrite

Boolean

指示是否使用一个已添加文件的相同名称在其所在的相同位置覆盖现有文件。

FALSE

Url

String

文件的 URL。

True

GroupCreationInformation 复杂类型

用于加快跨网站组的创建的对象。

属性名称

类型

描述

可为空值

Description

String

获取或设置一个字符串，其中包含要创建的组的说明。

True

Title

String

获取或设置一个字符串，该字符串包含要创建的组的名称。

True

KeyValue 复杂类型

表示键值对目录。

属性

属性名称

类型

描述

可为空值

Key

String

键。

True

Value

String

值。

True

ValueType

String

值类型。

True

Language 复杂类型

表示在 Microsoft SharePoint Foundation 上下文中使用的自然语言。

属性名称

类型

描述

可为空值

DisplayName

String

表示在 Microsoft SharePoint Foundation 上下文中使用的自然语言。

True

LanguageTag

String

获取此语言的语言标记。

True

Lcid

Int32

获取语言的区域设置标识符 (LCID)。

FALSE

ListDataSource 复杂类型

表示与外部数据源连接关联的信息。

属性名称

类型

描述

可为空值

Properties

Collection(SP.KeyValue)

获取与数据源连接关联的属性。

True

ListDataValidationExceptionValue 复杂类型

当列表字段或列表项的数据验证失败时引发的异常。

属性名称

类型

描述

可为空值

FieldFailures

Collection(SP.ListDataValidationFailure)

字段验证失败。

True

ItemFailure

SP.ListDataValidationFailure

列表项验证失败。

True

ListDataValidationFailure 复杂类型

描述在插入或更新列表项时出现的特定验证失败情况。

属性名称

类型

描述

可为空值

DisplayName

String

获取验证失败的列表的标题或字段的显示名称。

True

Message

String

获取一条包含有关失败情况的信息的消息。

True

Name

String

获取验证失败的字段名称或列表 ID。

True

Reason

Int32

获取失败原因。

FALSE

ValidationType

Int32

描述导致失败的验证类型。

FALSE

ListItemCollectionPosition 复杂类型

指定获取列表视图的下一页数据所需的信息。

属性名称

类型

描述

可为空值

PagingInfo

String

获取或设置一个值，该值以名称/值对的形式指定获取列表视图的下一页数据所需的信息。

True

ListItemCreationInformation 复杂类型

指定新列表项的属性。

属性名称

类型

描述

可为空值

FolderUrl

String

获取或设置一个值，该值指定新列表项的文件夹。

True

LeafName

String

获取或设置一个值，该值指定新列表项的名称。如果列表项的父列表是文档库，则它必须是文件名称。

True

UnderlyingObjectType

Int32

获取或设置一个值，该值指定新列表项是一个文件还是一个文件夹。

FALSE

ListItemFormUpdateValue 复杂类型

表示列表项字段的属性及其值。

属性名称

类型

描述

可为空值

ErrorMessage

String

验证字段的值之后的错误消息结果。

True

FieldName

String

字段的内部名称。

True

FieldValue

String

字段的值。

True

HasException

Boolean

指示验证字段的值之后，是否存在错误结果。

FALSE

表示导航层次结构中的导航节点。导航层次结构是导航节点的树结构。

属性名称

类型

描述

可为空值

CustomProperties

Collection(SP.KeyValue)

节点属性。

True

FriendlyUrlSegment

String

与父导航节点的 URL 相对的导航节点的 URL。

True

IsHidden

Boolean

指示节点在导航菜单中是否隐藏。在编辑过程中，所有节点暂时变为可见。

FALSE

Key

String

导航节点在菜单树中的标识符。

True

Nodes

Collection(SP.MenuNode)

子节点。

True

NodeType

Int32

导航节点的类型。

FALSE

SimpleUrl

String

导航节点的相对或绝对 URL。网站相对 URL 可以"~site"令牌开头，网站集相对 URL 可以"~sitecollection"令牌开头。仅适用于 SimpleLink 节点类型。

True

Title

String

导航节点的标题。

True

表示默认 SiteMapProvider ("SPSiteMapProvider") 的菜单状态，其中转储从网站的根节点开始，深度为 10 层。

下列参数可用于查询菜单状态：

menuNodeKey

开始节点的键。如果未提供键，将使用根节点。

depth

转储深度。默认值为 10。

customProperties

（可由网站地图数据提供程序实施。）要返回的自定义属性的逗号分隔列表。使用"\"字符对属性内的逗号分隔符进行转义。

mapProviderName

指定选择网站上的哪个提供程序。如果未使用 SiteMapProvider，则使用"CurrentNavSiteMapProviderNoEncode"。

示例请求：
http://<site url>/_api/navigation/menustate?menuNodeKey='1006'&depth=5 返回"SPSiteMapProvider"的菜单状态，从深度为 5 的键 1006 的节点开始。
http://<site url>/_api/navigation/menustate?depth=5&mapProviderName='CurrentNavSiteMapProviderNoEncode' 返回"CurrentNavSiteMapProviderNoEncode"的菜单状态，从深度为 5 的提供程序的根节点开始。

属性名称

类型

描述

可为空值

FriendlyUrlPrefix

String

指定菜单树的根节点的网站集相对 URL。

True

Nodes

Collection(SP.MenuNode)

菜单树的根节点的子节点。

True

SimpleUrl

String

导航节点的相对或绝对 URL。网站相对 URL 可以"~site"URL 令牌开头，网站集相对 URL 可以"~sitecollection"URL 令牌开头。仅适用于 SimpleLink 节点类型。

True

SPSitePrefix

String

替换网站集相对链接中的"~sitecollection"令牌的字符串。例如，要使"试用链接"命令与相对链接 ~sitecollection/Pages/MyPage.aspx 一起使用，该值可为 https://contoso.com/sites/site1/。

True

SPWebPrefix

String

替换网站相对链接中的"~site"令牌的字符串。例如，要使"试用链接"命令与相对链接 ~site/Pages/MyPage.aspx 一起使用，该值可为 https://contoso.com/sites/site1/web1。

True

StartingNodeKey

String

根节点在菜单树中的标识符。

True

StartingNodeTitle

String

根节点在菜单树中的标题。（例如："Document Center"）

True

Version

String

服务器用于检测外部变更的实施特定值。例如，这可以是用于数据库或单调递增版本号的更改时间戳，例如"2009-06-15T20:45:30Z"。

True

描述要创建的新导航节点。

属性名称

类型

描述

可为空值

AsLastNode

Boolean

获取或设置一个值，该值指定导航节点是否将作为集合中的最后一个节点创建。

FALSE

IsExternal

Boolean

获取或设置一个值，该值指定导航节点 URL 是否潜在地与网站集以外的页面对应。

FALSE

Title

String

获取或设置一个值，该值指定导航节点链接的定位文本。

True

Url

String

获取或设置一个值，该值指定要随导航节点一起存储的 URL。

True

RelatedItem 复杂类型

属性名称

类型

描述

可为空值

IconUrl

String

True

ItemId

Int32

FALSE

ListId

String

True

Title

String

True

Url

String

True

WebId

String

True

RenderListDataParameters 复杂类型

表示用于列表数据表示为 JavaScript 对象表示法 (JSON) 字符串的参数。

属性名称

类型

描述

可为空值

FolderServerRelativeUrl

String

从中返回项目的文件夹的 URL。

True

Paging

String

分页信息。

True

ViewXml

String

协作应用程序标记语言 (CAML) 视图 XML。

True

RoleDefinitionCreationInformation 复杂类型

包含用作参数以初始化角色定义的属性。

属性名称

类型

描述

可为空值

BasePermissions

SP.BasePermissions

获取或设置一个值，该值指定角色定义的权限。

True

Description

String

获取或设置一个值，该值指定角色定义的说明。

True

Property name

String

获取或设置一个值，该值指定角色定义的名称。

True

Order

Int32

获取或设置一个值，该值指定角色的显示顺序。

FALSE

SimpleDataRow 复杂类型

表示数据表中的行。

属性名称

类型

描述

可为空值

Cells

Collection(SP.KeyValue)

行单元格。

True

SimpleDataTable 复杂类型

表示数据表。

属性

属性名称

类型

描述

可为空值

Rows

Collection(SP.SimpleDataRow)

表中的行。

True

TimeZoneInformation 复杂类型

表示有关时区的信息。

属性名称

类型

描述

可为空值

Bias

Int32

不同于协调世界时 (UTC) 的时区分钟数。正值表示时区晚于 UTC。

FALSE

DaylightBias

Int32

在夏令时期间添加到偏差的分钟数。

FALSE

StandardBias

Int32

在夏令时之外添加到偏差的分钟数。

FALSE

UpgradeInfo 复杂类型

表示网站集升级信息。

属性名称

类型

描述

可为空值

ErrorFile

String

包含升级错误的文件位置。

True

Errors

Int32

在网站集升级过程中遇到的错误数。

FALSE

LastUpdated

DateTime

最新升级的进度更新的 DateTime。

FALSE

LogFile

String

包含升级日志的文件位置。

True

RequestDate

DateTime

请求网站集升级时的 DateTime。

FALSE

RetryCount

Int32

尝试进行的网站集升级的次数。

FALSE

StartTime

DateTime

启动网站集升级时的 DateTime。

FALSE

Status

Int32

网站集升级的当前状态。

FALSE

UpgradeType

Int32

网站集的升级类型。该类型可以是内部版本升级（值 = 0）或版本升级（值 = 1）。

FALSE

Warnings

Int32

在网站集升级过程中遇到的警告数。

FALSE

UsageInfo 复杂类型

提供用于访问网站集使用情况信息的字段。

属性名称

类型

描述

可为空值

Bandwidth

Int64

获取一个值，该值指定在某特定实现时段内，网站集使用的累积带宽，以字节为单位。

FALSE

DiscussionStorage

Int64

获取一个值，该值指定当前用于存储网站集中的 Web 讨论备注的总磁盘空间，以字节为单位。

FALSE

Hits

Int64

获取一个值，该值指定在某特定实现时段内，对网站集中的页面的累积请求数。

FALSE

Storage

Int64

获取一个值，该值指定当前由网站集使用的总磁盘空间，以字节为单位。

FALSE

StoragePercentageUsed

Double

获取一个值，该值指定网站集当前使用的磁盘空间量与网站集配额中指定的最大磁盘空间量的比率。

FALSE

Visits

Int64

获取一个值，该值指定在某特定实现时段内，对网站集中页面的累积请求数，这些请求没有引用 URL 或者引用 URL 位于当前网站集以外。

FALSE

UserCreationInformation 复杂类型

用于邀请用户的参数。

属性名称

类型

描述

可为空值

Email

String

获取或设置一个值，该值指定要创建的用户的电子邮件地址。

True

LoginName

String

获取或设置一个值，该值指定要创建的用户的登录名。

True

Title

String

获取或设置一个值，该值指定要创建的用户的显示名称。

True

UserIdInfo 复杂类型

表示标识提供程序的唯一标识符信息。

属性名称

类型

描述

可为空值

NameId

String

标识提供程序的唯一标识符。

True

NameIdIssuer

String

按场中注册的名称显示的标识提供程序的名称。

True

ViewCreationInformation 复杂类型

指定用于创建新列表视图的属性。

属性名称

类型

描述

可为空值

Paged

Boolean

获取或设置一个值，该值指定新列表视图是否是分页视图。

FALSE

PersonalView

Boolean

获取或设置一个值，该值指定新列表视图是否是个人视图。如果值为 false，则新列表视图是公共视图。

FALSE

Query

String

获取或设置一个值，该值指定针对新列表视图的查询。

True

RowLimit

Int32

获取或设置一个值，该值指定新列表视图在列表视图的可视页面上显示的最大列表项数。

FALSE

SetAsDefaultView

Boolean

获取或设置一个值，该值指定新列表视图是否是默认列表视图。

FALSE

Title

String

获取或设置一个值，该值指定新列表视图的显示名称。

True

ViewFields

Collection(String)

获取或设置一个值，该值指定新列表视图中的列表字段的字段内部名称集合。

True

ViewTypeKind

Int32

获取或设置一个值，该值指定新列表视图的类型。

FALSE

WebCreationInformation 复杂类型

指定新网站的属性。

属性名称

类型

描述

可为空值

Description

String

获取或设置新网站的说明。

True

Language

Int32

获取或设置指定新网站的语言的区域设置 ID。

FALSE

Title

String

获取或设置一个值，该值指定新网站的标题。

True

Url

String

获取或设置新网站的 URL 叶名称。

URL 不能包含以下内容：
字符 ~、"、#、%、&、*、:、<、>、?、\、{、| 或 }
字符串 \x7f
连续 . 或 / 字符
以 .、/ 或 _ 字符开头
  以 . 或 / 字符结尾

True

UseSamePermissionsAsParentSite

Boolean

获取或设置一个值，该值指定新网站是否从其父网站继承权限。

FALSE

WebTemplate

String

获取或设置一个值，该值指定用于创建新网站的网站模板的名称。 使用 GetAvailableWebTemplates 方法获取网站上可用网站模板的名称。

True

WebInfoCreationInformation 复杂类型

表示关于网站创建的元数据。

属性名称

类型

描述

可为空值

Description

String

网站的说明。

True

Language

Int32

在网站上使用的语言的有效语言代码标识符 (LCID)。

FALSE

Title

String

网站的标题。

True

Url

String

网站的 URL。

URL 不能包含以下内容：
字符 ~、"、#、%、&、*、:、<、>、?、\、{、| 或 }
字符串 \x7f
连续 . 或 / 字符
以 .、/ 或 _ 字符开头
  以 . 或 / 字符结尾

True

UseUniquePermissions

Boolean

指示网站是否从其父网站继承权限。

FALSE

WebTemplate

String

用于创建网站的网站模板的名称。

True

WebRequestInfo 复杂类型

表示从调用方进行出站 Web 请求所需的数据。

属性名称

类型

描述

可为空值

Body

String

获取或设置 HTTP 请求消息的正文。

True

Headers

Collection(SP.KeyValue)

获取或设置一个字典，该字典包含要发送到 HTTP 请求中的标头的名称值对。

True

Method

String

获取或设置 Web 请求的 HTTP 方法。

True

Url

String

获取或设置 Web 请求的 URL。

True

WebResponseInfo 复杂类型

包含第三方服务响应的副本。

属性名称

类型

描述

可为空值

Body

String

获取或设置 HTTP 响应的正文。

True

Headers

Collection(SP.KeyValue)

获取或设置 HTTP 响应的标头。

True

StatusCode

Int32

获取或设置 HTTP 响应的状态代码。

FALSE

XmlSchemaFieldCreationInformation 复杂类型

表示在创建字段时可以设置的属性。

属性名称

类型

描述

可为空值

Options

Int32

用于添加字段的选项。有关值列表，请参阅 .NET 客户端对象模型引用中的 AddFieldOptions。

FALSE

SchemaXml

String

包含架构的协作应用程序标记语言 (CAML) 字符串。

True

实现说明

对于Nullable类型参数，可以指定空值，方法是在 URI 的查询字符串中不包含参数。

另请参阅

概念

REST API 引用和示例

其他资源

开始使用 SharePoint 2013 REST 服务

使用 SharePoint 2013 REST 终结点完成基本操作