POST api/sfdocs/exporttozip
Submit an Export to Zip job to be performed.
Request Information
URI Parameters
None.
Body Parameters
OperationParamsName | Description | Type | Additional information |
---|---|---|---|
DocumentNumbers |
This list will include the document numbers to perform the bulk operation on. |
Collection of string |
None. |
JobName |
Optional reference that can be submitted with a job that will be passed into VC operation processing |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "DocumentNumbers": [ "sample string 1", "sample string 2" ], "JobName": "sample string 1" }
application/xml, text/xml
Sample:
<OperationParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClaimsVCRestApi.Models.SalesforceDocuments"> <DocumentNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </DocumentNumbers> <JobName>sample string 1</JobName> </OperationParams>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | 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. |