Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products.
Microsoft SharePoint Foundation 2010
Microsoft SharePoint Foundation 2013
Microsoft SharePoint Server 2016
Microsoft SharePoint Server 2019
Microsoft SharePoint Server Subscription Edition
Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition.
Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription.
<1> Section 2.2.4: SharePoint Foundation 2010 requires that Business Logic Modules conform to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and are understood by the Microsoft .NET Framework.
<2> Section 2.2.4.4: In SharePoint Foundation 2010, only the restriction that the index value be greater than or equal to zero is enforced.
<3> Section 2.2.4.4: In SharePoint Foundation 2010, this restriction is not enforced.
<4> Section 2.2.4.21: SharePoint Foundation 2010 sets the values to zero on return.
<5> Section 2.2.4.22: SharePoint Foundation 2010 truncates this string to 255 Unicode characters if the length is more than 255 and then saves it to the server database. If the client later queries this string, the server will return the truncated string. However, the _associationName returned by the AddAssociationReferenceToAssociationGroup operation is the same as the input _associationName.
<6> Section 2.2.4.22: SharePoint Foundation 2010 truncates this string to 255 Unicode characters if the length is more than 255 and then saves it to the server database. If the client later queries this string, the server will return the truncated string. However, the _entityName returned by the AddAssociationReferenceToAssociationGroup operation is the same as the input _entityName.
<7> Section 2.2.4.22: SharePoint Foundation 2010 truncates this string to 255 Unicode characters if the length is more than 255 and then saves it to the server database. If the client later queries this string, the server will return the truncated string. However, the _entityNamespace returned by the AddAssociationReferenceToAssociationGroup operation is the same as the input _entityNamespace.
<8> Section 2.2.4.41: In SharePoint Foundation 2010, this can be other values.
<9> Section 2.2.4.51: SharePoint Foundation 2010 requires that Business Logic Modules conform to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and are understood by the .NET Framework.
<10> Section 2.2.4.53: In SharePoint Foundation 2010, when a new TypeDescriptor is created with the MetadataObjectCreate operation, the server sets this element to NULL on return. SerializedRules can be set to a non-null value using the Update operation or the MetadataObjectReadXml operation.
<11> Section 2.2.4.53: The culture names used by SharePoint Foundation 2010 are as specified in [MSDN-SharePointSDK].
<12> Section 2.2.4.53: SharePoint Foundation 2010 requires this data type to conform to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and to be understood by the .NET Framework.
<13> Section 2.2.4.53: SharePoint Foundation 2010 requires that the data type to conform to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<14> Section 2.2.4.53: The SharePoint Foundation 2010 module that performs the mapping of value of the typeName element to data types requires the value of the typeName element to be in the following format expressed in ABNF, as specified in [RFC5234]:
-
Value = TypeName *1(%x2C BusinessLogicModule) BusinessLogicModule = FullAssemblyName / LobSystemName FullAssemblyName = LibraryIdentifier %x2C VersionProperty %x2C CultureProperty %x2C PublicKeyTokenProperty
LibraryIdentifier, VersionProperty, PublicKeyTokenProperty, and CultureProperty are as specified in [MS-NRTP] section 2.2.1.3.
TypeName: The name of the type that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework. The format is as specified in [MS-NRTP] section 2.2.1.2.
LobSystemName: The name of the LobSystem that contains the TypeDescriptor.
The occurrence of the BusinessLogicModule element is required by SharePoint Foundation 2010 to yield to a LobSystemName element if the represented data type resides in the Business Logic Module associated with the LobSystem that contains the TypeDescriptor. Otherwise, the occurrence of BusinessLogicModule is required by SharePoint Foundation 2010 to be a FullAssemblyName element. The values for the TypeName specified in the following table do not require a BusinessLogicModule.
|
Value |
Description |
|---|---|
|
System.String |
A string of Unicode text. |
|
System.Int16 |
A number in the range from –32,768 through 32,767. |
|
System.Int32 |
A number in the range from –2,147,483,648 through 2,147,483,647. |
|
System.Int64 |
A number in the range from –9,223,372,036,854,775,808 through 9,223,372,036,854,775,807. |
|
System.UInt16 |
A number in the range from 0 through 65,535. |
|
System.UInt32 |
A number in the range from 0 through 4,294,967,295. |
|
System.UInt64 |
A number in the range from 0 through 18,446,744,073,709,551,615. |
|
System.DateTime |
A date and time in the range from midnight, January 1, 1 A.D. through 11:59:59 PM, December 31, 9999 A.D., with a resolution of 100 nanoseconds. |
|
System.TimeSpan |
A duration in the range from negative 10,675,199 days 2 hours 48 minutes 5 seconds 477 milliseconds 580 microseconds 800 nanoseconds through positive 10,675,199 days 2 hours 48 minutes 5 seconds 477 milliseconds 580 microseconds 700 nanoseconds, with a resolution of 100 nanoseconds. |
|
System.Single |
A single-precision number in the range from –3.402823e38 through 3.402823e38. |
|
System.Double |
A double-precision number in the range from –1.79769313486232e308 through 1.79769313486232e308, as well as positive zero, negative zero, positive infinity, negative infinity, and NaN. |
|
System.Decimal |
A number in the range from –79,228,162,514,264,337,593,543,950,335 through 79,228,162,514,264,337,593,543,950,335. |
|
System.Char |
A Unicode character. |
|
System.Byte |
A number in the range from 0 through 255. |
|
System.SByte |
A number in the range from –128 through 127. |
|
System.Guid |
A GUID. |
|
System.Boolean |
A bit. |
|
System.Uri |
<15> Section 2.2.5.7: A Business Logic Module that conforms to the [ECMA-335] specification and is understood by the .NET Framework.
<16> Section 3.1: SharePoint Foundation 2010 does this for some requests from untrusted sources.
<17> Section 3.1: SharePoint Foundation 2010 does this for some requests from highly-trusted sources.
<18> Section 3.1.4: In SharePoint Foundation 2010 implementation, the protocol client specifies the last known values for these elements. The protocol server uses the specified values to construct error messages and other informational messages.
<19> Section 3.1.4: In SharePoint Foundation 2010, the implementation-specific maximum value is 2147483646.
<20> Section 3.1.4: In SharePoint Foundation 2010,when the specific metadataObject name or namespace field is updated, the object version is incremented by 2. When the Entity name or namespace is updated, the server will return an Entity object with the version incremented by 1, but the Entity object version is incremented by 2 in the server database. If the BulkSwitchActiveOrValidate operation is called to make an entity active and the specific entity is already active, its object version will be incremented by 2.
<21> Section 3.1.4: A Business Logic Module that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<22> Section 3.1.4: The Business Logic Module conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<23> Section 3.1.4: In SharePoint Foundation 2010, this operation returns zero TypeDescriptors.
<24> Section 3.1.4: The behavior is identified by the specific implementation of the custom code that handles LobSystem data, and is not understood by the protocol server implementation.
<25> Section 3.1.4: A set of Business Logic Modules that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and are understood by the .NET Framework.
<26> Section 3.1.4: SharePoint Foundation 2010 checks the edit rights of the security principal on the LobSystemInstance to determine if the security principal is authorized to read the LobSystemInstance.
<27> Section 3.1.4: A Business Logic Module that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<28> Section 3.1.4: SharePoint Foundation 2010 checks the edit rights of the security principal on the LobSystem to determine if the security principal is authorized to read the LobSystem.
<29> Section 3.1.4: SharePoint Foundation 2010 ignores the level parameter when retrieving the TypeDescriptors.
<30> Section 3.1.4: In SharePoint Foundation 2010, if the specified MetadataObject is Action, the server will ignore the entityId specified by the client and set its value to the id of the input parentStruct.
<31> Section 3.1.4: In SharePoint Foundation 2010, if there is an error in the input XML, the server will return an error to the client, but some MetadataObjects that had been created before encountering the error could still exist.
<32> Section 3.1.4: A set of Business Logic Modules that conform to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<33> Section 3.1.4: SharePoint Foundation 2010 does not enforce the specified MetadataObject to be a Model or an LobSystem.
<34> Section 3.1.4.2.2.2: In SharePoint Foundation 2010, when the AddAssociationReferenceToAssociationGroup operation completes successfully, the returned associationGroupId element of the associationReference structure is the same as the returned id element of the associationReference structure. However, the associationGroupId element of the associationReference structure stored on the server is the same as the id element of the AssociationGroup that contains this AssociationReference structure.
<35> Section 3.1.4.5.2.1: In SharePoint Foundation 2010, when the BulkSwitchActiveOrValidate operation cannot be performed because the value of the validate element is set to "false" and the protocol server encountered reference errors (as specified in section 3.1.4.5.3.2) when performing this operation, the active fields of the Entities returned by the BulkSwitchActiveOrValidate operation are updated to TRUE, but the active fields of the Entities stored on the server are not changed by this operation.
<36> Section 3.1.4.5.3.2: SharePoint Foundation 2010 does not return this error for this condition.
<37> Section 3.1.4.5.3.2: In this case, SharePoint Foundation 2010 does not return an error.
<38> Section 3.1.4.5.3.2: In this case, SharePoint Foundation 2010 does not return an error.
<39> Section 3.1.4.13: In SharePoint Foundation 2010, the Method will not be deleted when this operation does not execute successfully and the server throws a ConcurrentModificationExceptionState exception, but the child objects of the specified Method could have been deleted before the error occurred.
<40> Section 3.1.4.13: In SharePoint Foundation 2010, the Parameter will not be deleted when this operation does not succeed. But the root TypeDescriptor of the specified Parameter, as well as all the child objects of the root TypeDescriptor, will be deleted.
<41> Section 3.1.4.14: In this case, SharePoint Foundation 2010 returns a MetadataException (from namespace Microsoft.BusinessData.SharePoint) serialized as specified in section 2.2.4.
<42> Section 3.1.4.14: In this case, SharePoint Foundation 2010 returns a MetadataException (from namespace Microsoft.BusinessData.SharePoint) serialized as specified in section 2.2.4.
<43> Section 3.1.4.16: In SharePoint Foundation 2010, the Method will not be deleted if this operation cannot execute successfully and the server throws a ConcurrentModificationExceptionState exception. But the MethodInstances, FilterDescriptors, and Parameters that are child objects of the specified Method, as well as all their child objects, could have already been deleted.
<44> Section 3.1.4.16: In SharePoint Foundation 2010, the Parameter will not be deleted if this operation cannot execute successfully and the server throws a ConcurrentModificationExceptionState exception. But the root TypeDescriptor of the specified Parameter, as well as all the child objects of the root TypeDescriptor, will be deleted.
<45> Section 3.1.4.17: A Business Logic Module that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<46> Section 3.1.4.17: In SharePoint Foundation 2010, the server does not return any error complex type for this condition, but instead returns NULL.
<47> Section 3.1.4.17.2.1: A Business Logic Module that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<48> Section 3.1.4.19: In SharePoint Foundation 2010, a security principal is authorized to export a MetadataObject if the same security principal is authorized to modify the same MetadataObject.
<49> Section 3.1.4.20: The Business Logic Module conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<50> Section 3.1.4.24: SharePoint Foundation 2010 does not raise an error in this case.
<51> Section 3.1.4.24: SharePoint Foundation 2010 does not raise an error in this case.
<52> Section 3.1.4.25: SharePoint Foundation 2010 does not raise an error in this case.
<53> Section 3.1.4.26: SharePoint Foundation 2010 does not raise an error in this case.
<54> Section 3.1.4.27: SharePoint Foundation 2010 does not raise an error in this case.
<55> Section 3.1.4.33: SharePoint Foundation 2010 does not return a fault in this case.
<56> Section 3.1.4.33: SharePoint Foundation 2010 does not return a fault in this case.
<57> Section 3.1.4.35: SharePoint Foundation 2010 does not raise an error in this case.
<58> Section 3.1.4.36: SharePoint Foundation 2010 does not raise an error in this case.
<59> Section 3.1.4.38: SharePoint Foundation 2010 does not raise an error in this case.
<60> Section 3.1.4.40: SharePoint Foundation 2010 does not raise an error in this case.
<61> Section 3.1.4.41: In SharePoint Foundation 2010, this operation returns zero TypeDescriptors.
<62> Section 3.1.4.41: SharePoint Foundation 2010 does not raise an error in this case.
<63> Section 3.1.4.41: SharePoint Foundation 2010 does not raise an error in this case.
<64> Section 3.1.4.43: SharePoint Foundation 2010 does not return a fault in this case.
<65> Section 3.1.4.45: SharePoint Foundation 2010 does not raise an error in this case.
<66> Section 3.1.4.45: SharePoint Foundation 2010 does not raise an error in this case.
<67> Section 3.1.4.46: SharePoint Foundation 2010 does not return a fault in this case.
<68> Section 3.1.4.48: SharePoint Foundation 2010 does not return a fault in this case.
<69> Section 3.1.4.50: SharePoint Foundation 2010 does not raise an error in this case.
<70> Section 3.1.4.50: SharePoint Foundation 2010 does not raise an error in this case.
<71> Section 3.1.4.51: SharePoint Foundation 2010 does not return a fault when the value of the role parameter is not zero ("0") or "1".
<72> Section 3.1.4.51: SharePoint Foundation 2010 returns a BdcExceptionState (from namespace http://schemas.datacontract.org/2004/07/Microsoft.BusinessData.Infrastructure) error complex type in this case.
<73> Section 3.1.4.56: SharePoint Foundation 2010 does not return a fault in this case.
<74> Section 3.1.4.56: SharePoint Foundation 2010 does not return a fault in this case.
<75> Section 3.1.4.58: SharePoint Foundation 2010 does not return a fault in this case.
<76> Section 3.1.4.58: SharePoint Foundation 2010 does not return a fault in this case.
<77> Section 3.1.4.60: SharePoint Foundation 2010 does not raise an error in this case.
<78> Section 3.1.4.60: SharePoint Foundation 2010 does not raise an error in this case.
<79> Section 3.1.4.61: The behavior is identified by the specific implementation of the custom code that handles LobSystem data, and is not understood by the protocol server implementation.
<80> Section 3.1.4.61: SharePoint Foundation 2010 checks the edit rights of the security principal on the LobSystem to determine if the security principal is authorized to read the LobSystem.
<81> Section 3.1.4.63: SharePoint Foundation 2010 checks the edit rights of the security principal on the LobSystem to determine if the security principal is authorized to read the LobSystem.
<82> Section 3.1.4.64: A set of Business Logic Modules that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and are understood by the .NET Framework.
<83> Section 3.1.4.64: SharePoint Foundation 2010 does not raise an error in this case.
<84> Section 3.1.4.64: SharePoint Foundation 2010 does not raise an error in this case.
<85> Section 3.1.4.64.2.2: A set of Business Logic Modules that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<86> Section 3.1.4.66: SharePoint Foundation 2010 checks the edit rights of the security principal on the LobSystemInstance to determine if the security principal is authorized to read the LobSystemInstance.
<87> Section 3.1.4.66: SharePoint Foundation 2010 does not return a fault in this case.
<88> Section 3.1.4.66: SharePoint Foundation 2010 does not return a fault in this case.
<89> Section 3.1.4.67: A Business Logic Module that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<90> Section 3.1.4.67: SharePoint Foundation 2010 checks the edit rights of the security principal on the LobSystem to determine if the security principal is authorized to read the LobSystem.
<91> Section 3.1.4.67.2.2: A set of Business Logic Modules that conform to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<92> Section 3.1.4.69: SharePoint Foundation 2010 checks the edit rights of the security principal on the LobSystem to determine if the security principal is authorized to read the LobSystem.
<93> Section 3.1.4.69: SharePoint Foundation 2010 does not return a fault in this case.
<94> Section 3.1.4.69: SharePoint Foundation 2010 does not return a fault in this case.
<95> Section 3.1.4.72: SharePoint Foundation 2010 does not raise an error in this case.
<96> Section 3.1.4.73: SharePoint Foundation 2010 does not raise an error in this case.
<97> Section 3.1.4.74: SharePoint Foundation 2010 does not return a fault in this case.
<98> Section 3.1.4.74: SharePoint Foundation 2010 does not return a fault in this case.
<99> Section 3.1.4.77: SharePoint Foundation 2010 does not return a fault in this case.
<100> Section 3.1.4.80: SharePoint Foundation 2010 does not return a fault in this case.
<101> Section 3.1.4.80: SharePoint Foundation 2010 does not return a fault in this case.
<102> Section 3.1.4.83.2.2: SharePoint Foundation 2010 requires the identifier to be in the following format as expressed in ABNF, as specified in [RFC5234]:
-
Identifier = TypeName (%x2C FullAssemblyName) FullAssemblyName = LibraryIdentifier %x2C VersionProperty %x2C CultureProperty %x2C PublicKeyTokenProperty
LibraryIdentifier, VersionProperty, PublicKeyTokenProperty, and CultureProperty are as specified in [MS-NRTP] section 2.2.1.3.
TypeName: The name of the type that conforms to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework. The format is specified in [MS-NRTP] section 2.2.1.2. The specified type implements operations that are described in [MSDN-SharePointSDK].
<103> Section 3.1.4.86: SharePoint Foundation 2010 ignores the level parameter when retrieving the TypeDescriptors.
<104> Section 3.1.4.94.2.2: SharePoint Foundation 2010 sets this element to false regardless of whether or not the specified Parameter contains a ReturnTypeDescriptor.
<105> Section 3.1.4.95: In SharePoint Foundation 2010, if the specified MetadataObject is Action, the server will ignore the entityId specified by the client and set its value to the id of the input parentStruct.
<106> Section 3.1.4.95.2.2: In SharePoint Foundation 2010, if the MetadataObject specified in the request is a MetadataCatalog and the client specifies a name for it, the server will ignore the name set by the client and set the new created MetadataCatalog name with the input partitionId. If the MetadataObject specified in the request is associated with the empty DestinationEntityName and empty DestinationEntityNamespace set by the client, the server will create the association using "," as the DestinationEntityName value and DestinationEntityNamespace value. If the MetadataObject specified in the request is associated with the empty DestinationEntityName and non-empty DestinationEntityNamespace set by the client, the server will create the association using "," as the DestinationEntityName value and will use the associated input DestinationEntityNamespace value appended with a "," as the DestinationEntityNamespace value.
<107> Section 3.1.4.97: In SharePoint Foundation 2010, if there is an error in the input XML, the server will return an error to the client, but some MetadataObjects that had been created before encountering the error could still exist.
<108> Section 3.1.4.97: SharePoint Foundation 2010 returns a fault containing the InvalidOperationException (from namespace http://schemas.datacontract.org/2004/07/System) complex type in this case.
<109> Section 3.1.4.99: SharePoint Foundation 2010 returns a fault containing the InvalidOperationException (from namespace http://schemas.datacontract.org/2004/07/System) complex type in this case.
<110> Section 3.1.4.99.2.1: In SharePoint Foundation 2010, if this element is set to TRUE, the protocol server does not remove the Entity references from the Model and does not create Entity references in the Model for all Entities in the specified MetadataModel.
<111> Section 3.1.4.100.2.1: SharePoint Foundation 2010 does not validate this constraint.
<112> Section 3.1.4.100.2.1: SharePoint Foundation 2010 does not enforce this to be MetadataCatalog.
<113> Section 3.1.4.110: A set of Business Logic Modules that conform to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<114> Section 3.1.4.110.2.1: A set of Business Logic Modules that conform to the Common Language Infrastructure (CLI), as specified in [ECMA-335], and is understood by the .NET Framework.
<115> Section 3.1.4.114: SharePoint Foundation 2010 does not return a fault in this case.
<116> Section 3.1.4.114: SharePoint Foundation 2010 does not return a fault in this case.
<117> Section 3.1.4.114: SharePoint Foundation 2010 does not raise an error in this case.
<118> Section 3.1.4.114: In SharePoint Foundation 2010, if the ordinalNumber attribute of the specified Parameter is the same as the ordinalNumber attribute of another Parameter contained by the Method containing the specified Parameter, the server throws the BdcExceptionState error, and the ordinalNumber attribute of the specified Parameter is updated to the same as the ordinalNumber attribute in the request message. After the operation completes, there are two Parameters with the same ordinalNumber attribute.
<119> Section 3.1.4.114: In SharePoint Foundation 2010, if the isDefault attribute of the specified MethodInstance is set to "false"(and the previous isDefault attribute of all MethodInstances that have the same value for the MethodInstanceType attribute in the containing DataClass is "false") the protocol server sets the IsDefault attribute of one MethodInstance with the same value for MethodInstanceType in the containing DataClass to "true". The algorithm used by the server to determine which MethodInstance to alter is based on an implementation-specific algorithm, and is therefore nondeterministic.
<120> Section 3.1.4.115: SharePoint Foundation 2010 does not enforce the specified MetadataObject to be a Model or an LobSystem.
<121> Section 3.1.4.115.2.1: SharePoint Foundation 2010 does not validate this constraint.