Share via

2.3.1.33 FileOperationSubRequestDataType

  • Article

The FileOperationSubRequestDataType complex type contains information about data or input parameters used in processing a file operation subrequest. The FileOperation attribute specified in the FileOperationSubRequestDataOptionalAttributes attribute group (section 2.3.3.8) MUST be specified for a file operation subrequest. The FileOperation attribute is specified as part of the SubRequestData element associated with a file operation SubRequest element. If the FileOperation attribute is not provided, an error code SHOULD<36> be returned. If other attributes are not provided, an "InvalidArgument" error code MUST be returned as part of the SubResponseData element associated with the file operation subresponse.

 <xs:complexType name="FileOperationSubRequestDataType">
     <xs:attributeGroup ref="tns:FileOperationSubRequestDataOptionalAttributes"/>
     <xs:attribute name="NewFileName" type="xs:string" use="optional" />
     <xs:attribute name="ExclusiveLockID" type="xs:string" use="optional"/>
 </xs:complexType>

FileOperationSubRequestDataOptionalAttributes: An attribute group that specifies the set of attributes that are provided only for a SubRequestData element whose parent SubRequest element’s Type attribute is set to "FileOperation". FileOperationSubRequestDataOptionalAttributes is defined in section 2.3.3.8.

NewFileName: A string that specifies a new name for the file on the server. This string MUST only contain a valid filename, with no relative path. The NewFileName attribute MUST be sent only when the file operation subrequest has a FileOperationSubRequestType attribute set to "Rename".

ExclusiveLockID: A string that serves as a unique identifier for the exclusive lock on the file at the time the file operation request is executed. This parameter is used to validate that the file operation can be performed even though the file is under exclusive lock. The ExclusiveLockID attribute can be optionally sent only when the file operation subrequest has a FileOperationSubRequestType attribute set to "Rename".