POST v1/Documents
Document Upload - Multipart Request
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
DocumentDTOName | Description | Type | Additional information |
---|---|---|---|
FileName |
Name of the document file |
string |
None. |
Path |
Name of the document file |
string |
None. |
Description |
Description of the document |
string |
None. |
Category |
Document category |
DocumentCategoryCustomEnum |
None. |
SizeKB |
File size of the document |
decimal number |
None. |
CreationDate |
Upload date of the document |
date |
None. |
SystemType | SystemTypeEnum |
None. |
|
Id |
Primary Id |
integer |
None. |
WarningMessages |
List of warning messages encountered while servicing request |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "FileName": "sample string 1", "Path": "sample string 2", "Description": "sample string 3", "Category": "AgentProfile", "SizeKB": 4.0, "CreationDate": "2024-10-11T18:00:14.990234-10:00", "SystemType": "Unknown", "Id": 5 }
application/xml, text/xml
Sample:
<DocumentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound"> <Id>5</Id> <Category>AgentProfile</Category> <CreationDate>2024-10-11T18:00:14.990234-10:00</CreationDate> <Description>sample string 3</Description> <FileName>sample string 1</FileName> <Path>sample string 2</Path> <SizeKB>4</SizeKB> <SystemType>Unknown</SystemType> </DocumentDTO>