POST api/Document/uploadForm
Uploads a form for processing within a campaign
Request Information
URI Parameters
None.
Body Parameters
The campaign id, mapping, supplier, content type of the form, filename, base64 encoded data of the file, metaData (optional) and form id
uploadFormParam| Name | Description | Type | Additional information |
|---|---|---|---|
| campaignId |
The internal campaign id to upload the form to |
string |
None. |
| partMapping |
The mapping to associate the form to a given set of internal CMAP item ids |
string |
None. |
| supplierId |
The supplier id to associate (optional) |
string |
None. |
| contentType |
The mime type of the file |
string |
None. |
| fileName |
The filename |
string |
None. |
| data |
Base64 encoded data of the file |
string |
None. |
| metaData |
Any metadata to associate to the file upload (optional) |
string |
None. |
| formId |
The form to associate to the file uploaded (optional) |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"campaignId": "sample string 1",
"partMapping": "sample string 2",
"supplierId": "sample string 3",
"contentType": "sample string 4",
"fileName": "sample string 5",
"data": "sample string 6",
"metaData": "sample string 7",
"formId": "sample string 8"
}
application/xml, text/xml
Sample:
<DocumentController.uploadFormParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMAPWebAPI.Controllers"> <campaignId>sample string 1</campaignId> <contentType>sample string 4</contentType> <data>sample string 6</data> <fileName>sample string 5</fileName> <formId>sample string 8</formId> <metaData>sample string 7</metaData> <partMapping>sample string 2</partMapping> <supplierId>sample string 3</supplierId> </DocumentController.uploadFormParam>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
None.