POST restapi/personal/yourfiles/files/zip/v1

Start zipping files in your files area

Request Information

URI Parameters

None.

Body Parameters

Itslearning.RestApi.Entities.YourFiles.ZipRequest

Name	Description	Type	Additional information
FileIds	The file identifiers of the files to be included in the zip archive.	Collection of integer	None.
FolderIds	The folder identifiers of the folders to be included in the zip archive.	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FileIds": [
    1,
    2
  ],
  "FolderIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<ZipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.YourFiles">
  <FileIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FileIds>
  <FolderIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FolderIds>
</ZipRequest>

application/x-www-form-urlencoded

Sample:

No sample available

Response Information

Resource Description

The zip file job

Itslearning.RestApi.Entities.YourFiles.ZipFileJobModel

Name	Description	Type	Additional information
JobId	The job identifier	integer	None.
FileRepoId	The file repository identifier for the zip file	globally unique identifier	None.
ZipFileName	The name of the zip file	string	None.
Created	When the job was created	date	None.
Status	Status for the job	string	None.
DownloadUrl	The url to download the file if status is completed	string	None.

Response Formats

application/json, text/json

Sample:

{
  "JobId": 1,
  "FileRepoId": "a0f69012-7d78-462a-8d34-c018f8f98436",
  "ZipFileName": "sample string 3",
  "Created": "2025-10-23T17:50:46Z",
  "Status": "sample string 5",
  "DownloadUrl": "sample string 6"
}

application/xml, text/xml

Sample:

<ZipFileJobModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.YourFiles">
  <Created>2025-10-23T17:50:46Z</Created>
  <DownloadUrl>sample string 6</DownloadUrl>
  <FileRepoId>a0f69012-7d78-462a-8d34-c018f8f98436</FileRepoId>
  <JobId>1</JobId>
  <Status>sample string 5</Status>
  <ZipFileName>sample string 3</ZipFileName>
</ZipFileJobModel>