3.1.4.4.2.2 GetChangesExRequest

The GetChangesExRequest element is an element of the GetChangesSoapIn request message, and has the following schema:

 <s:element name="GetChangesExRequest">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="1" maxOccurs="1" name="ObjectType" type="tns:ObjectType" />
       <s:element minOccurs="1" maxOccurs="1" name="ContentDatabaseId" type="s:string" />
       <s:element minOccurs="1" maxOccurs="1" name="StartChangeId" type="s:string" />
       <s:element minOccurs="0" maxOccurs="1" name="EndChangeId" type="s:string" />
       <s:element minOccurs="0" maxOccurs="1" name="IgnoreSecurityIfInherit" type="s:boolean" />
       <s:element minOccurs="0" maxOccurs="1" name="GetMetadata" type="s:boolean" />
       <s:element minOccurs="0" maxOccurs="1" name="RequestLoad" type="s:int" />
     </s:sequence>
   </s:complexType>
 </s:element>

ObjectType: Specifies the change tracking space to report about, either "ContentDatabase" or "SiteCollection". All other ObjectType values, as defined in section 2.2.5.3 MUST NOT be used. Note that "Site" in the context of this parameter actually means site collection.

ContentDatabaseId: Specifies the GUID of the content database, known in advance or obtained by GetContent request.

StartChangeId: Specifies a token specifying the starting point for the requested change report. Normally the protocol client obtains this value from the response to a previous GetContent or GetChangesEx operation.

EndChangeId: Specifies a token specifying the endpoint for the requested change report. If not empty, EndChangeId MUST be a valid token obtained from the response to a previous GetChangesEx operation. If this element is empty, the protocol server MUST return all changes starting from the starting point up to the present time.

IgnoreSecurityIfInherit: A Boolean value specifying whether permission information for objects in the change report is to be returned, if they inherit permissions from parent objects. If this value is not specified, the protocol server MUST return permission information for all objects.

GetMetadata: A Boolean value specifying whether basic information for each object in the change report is to be returned, along with the change information. If this value is not specified, the protocol server MUST return the metadata for each object in the change report.

RequestLoad: Specifies a value that determines how many changes can be fetched in the current operation, where the value represents the percentage of total changes that can be processed in the request. If this value is not specified or is 100, the protocol server MUST return all changes that can be processed in a single request. If this value is 0, the protocol server MUST return no changes. If this value is x, the protocol server MUST return x% of the total changes that can be processed in the request. This value MUST NOT be less than zero or greater than 100.

The protocol client MUST pass tokens that correspond to the change tracking space specified by the objectType and the target URL of the SOAP request.