UpdateFile
Updates files or folders. To update files or folders, specify the types of updates to make using UpdateFileOperationGroup, then specify which files or folders to update.
To update the properties of a file or folder, you must have the write privilege on the file or folder. To update privileges to the file or folder, you must have the grant privilege on the file or folder.
To update a single file or folder, specify Name or Id. To update a list of files or folders, specify NameList or IdList. To update files or folders matching the specified conditions, specify Search.
Request schema
<xsd:complexType name="UpdateFile">
<xsd:sequence>
<xsd:choice minOccurs="0">
<xsd:element name="WorkingFolderId" type="xsd:string"/>
<xsd:element name="WorkingFolderName" type="xsd:string"/>
</xsd:choice>
<xsd:element name="LatestVersionOnly" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="Recursive" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="UpdateFileOperationGroup"/>
<xsd:choice>
<xsd:element name="Search" type="typens:FileSearch"/>
<xsd:element name="NameList" type="typens:ArrayOfString"/>
<xsd:element name="IdList" type="typens:ArrayOfString"/>
<xsd:element name="Id" type="xsd:string"/>
<xsd:element name="Name" type="xsd:string"/>
</xsd:choice>
<xsd:element name="IgnoreMissing" type="xsd:boolean"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
WorkingFolderId
The ID of the working folder of the file or folder to update. Specify either WorkingFolderId or WorkingFolderName.
WorkingFolderName
The name of the working folder of the file or folder to update. Specify either WorkingFolderName or WorkingFolderId.
LatestVersionOnly
Specifies whether to search all versions of the file. If True, the search includes only the latest version. The default value is False.
Recursive
Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.
UpdateFileOperationGroup
The tasks to perform.
Search
The search conditions. If conditions apply to multiple fields, use ConditionArray.
NameList
The list of file or folder names to update. Specify either NameList or IdList.
IdList
The list of file or folder IDs to update. Specify either IdList or NameList.
Id
The ID of the single file or folder to update. Specify either Id or Name.
Name
The name of the single file or folder to update. Specify either Name or Id.
IgnoreMissing
Specifies what to do if the specified file or folder does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.