POST api/Documents/FolderStructure/DownloadAsZip

Descarga en un archivo zip los documentos seleccionados de una estructura de carpetas en eSAM. Downloads the selected documents from an eSAM folder structure into a zip file.

Request Information

URI Parameters

None.

Body Parameters

Parámetros con los identificadores y rutas de los documentos a comprimir.

DownloadZipDto

Name	Description	Type	Additional information
DocumentIds		Collection of integer	None.
Documents		Collection of DownloadDocumentParamsDto	None.

Request Formats

application/json, text/json

Sample:

{
  "documentIds": [
    1,
    2
  ],
  "documents": [
    {
      "relativePath": "sample string 1",
      "fileName": "sample string 2",
      "extension": "sample string 3",
      "version": "sample string 4",
      "pathLocation": "sample string 5"
    },
    {
      "relativePath": "sample string 1",
      "fileName": "sample string 2",
      "extension": "sample string 3",
      "version": "sample string 4",
      "pathLocation": "sample string 5"
    }
  ]
}

text/html

Sample:

{"documentIds":[1,2],"documents":[{"relativePath":"sample string 1","fileName":"sample string 2","extension":"sample string 3","version":"sample string 4","pathLocation":"sample string 5"},{"relativePath":"sample string 1","fileName":"sample string 2","extension":"sample string 3","version":"sample string 4","pathLocation":"sample string 5"}]}

application/xml, text/xml

Sample:

<DownloadZipDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.Dtos.DocumentAgg">
  <DocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </DocumentIds>
  <Documents>
    <DownloadDocumentParamsDto>
      <Extension>sample string 3</Extension>
      <FileName>sample string 2</FileName>
      <PathLocation>sample string 5</PathLocation>
      <RelativePath>sample string 1</RelativePath>
      <Version>sample string 4</Version>
    </DownloadDocumentParamsDto>
    <DownloadDocumentParamsDto>
      <Extension>sample string 3</Extension>
      <FileName>sample string 2</FileName>
      <PathLocation>sample string 5</PathLocation>
      <RelativePath>sample string 1</RelativePath>
      <Version>sample string 4</Version>
    </DownloadDocumentParamsDto>
  </Documents>
</DownloadZipDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Resultado HTTP con el archivo zip generado.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.