PUT api/2.0/files/batch/properties This function requires authentication

Description

Saves file properties to the specified files.

Parameters

Name	Description	Type	Example
FilesId sent in body	List of file IDs	System.Text.Json.JsonElement[]
CreateSubfolder sent in body	Specifies whether to create a subfolder or not	System.Boolean
FileProperties sent in body	File properties that are represented as the EntryPropertiesRequestDto object	ASC.Files.Core.ApiModels.RequestDto.EntryPropertiesRequestDto

Example

PUT api/2.0/files/batch/properties
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "CreateSubfolder": true,
  "FileProperties": {
    "FormFilling": {
      "CollectFillForm": true,
      "ToFolderId": "some text",
      "ToFolderPath": "some text",
      "CreateFolderTitle": "some text",
      "CreateFileMask": "some text"
    }
  }
}

Returns

List of file properties: collects the data from the filled forms or not, folder ID where a file will be saved, folder path where a file will be saved, new folder title, file name mask

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "FormFilling": {
        "CollectFillForm": true,
        "ToFolderId": "some text",
        "ToFolderPath": "some text",
        "CreateFolderTitle": "some text",
        "CreateFileMask": "some text"
      }
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <FormFilling>
      <CollectFillForm>True</CollectFillForm>
      <ToFolderId>some text</ToFolderId>
      <ToFolderPath>some text</ToFolderPath>
      <CreateFolderTitle>some text</CreateFolderTitle>
      <CreateFileMask>some text</CreateFileMask>
    </FormFilling>
  </response>
</result>