POST api/Document/CompressToZip

Compress to ZIP file

Request Information

URI Parameters

None.

Body Parameters

WorkPoint365.WebAPI.Model.Document+CompressToZipModel

Name	Type	Additional information
Items	Collection of Object	None.
BusinessModuleId	globally unique identifier	Required
EntityId	integer	Required
List	string	Required
Folder	string	None.
OutputExistsBehaviour	WorkPoint365.WebAPI.Model.Document+OutputExistsBehaviour	Required
AddIndex	boolean	None.
AddSourceInformation	boolean	None.
FieldValues	WorkPoint365.WebAPI.Model.Controllers.ListItem.FieldValuesParameter	None.
Async	boolean	None.
CallbackHeaders	Dictionary of string [key] and string [value]	None.
CallbackUrl	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Items": null,
  "BusinessModuleId": "3cd01798-3216-4ad6-9447-57734dd7d627",
  "EntityId": 2,
  "List": "sample string 3",
  "Folder": "sample string 4",
  "OutputExistsBehaviour": 10,
  "AddIndex": true,
  "AddSourceInformation": true,
  "FieldValues": {},
  "Async": true,
  "CallbackHeaders": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "CallbackUrl": "sample string 7"
}

application/xml, text/xml

Sample:

<Document.CompressToZipModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <AddIndex>true</AddIndex>
  <AddSourceInformation>true</AddSourceInformation>
  <Async>true</Async>
  <BusinessModuleId>3cd01798-3216-4ad6-9447-57734dd7d627</BusinessModuleId>
  <CallbackHeaders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CallbackHeaders>
  <CallbackUrl>sample string 7</CallbackUrl>
  <EntityId>2</EntityId>
  <FieldValues xmlns:d2p1="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.Controllers.ListItem" />
  <Folder>sample string 4</Folder>
  <Items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <List>sample string 3</List>
  <OutputExistsBehaviour>Cancel</OutputExistsBehaviour>
</Document.CompressToZipModel>

Response Information

Resource Description

The id of the created entity.

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.