POST api/List/{listId}/UploadFile?folderUrl={folderUrl}&overwrite={overwrite}

Uploads a file on the given listId.

Request Information

URI Parameters

Name	Description	Type	Additional information
listId	The id of the list.	string	Required
folderUrl	An optional parameter. The relative folder Url from the list. By default the file will be uploaded to the root folder of the list.	string	Default value is
overwrite	An optional parameter. A boolean indicating if any existing file, with the same filename, should be overwritten. By default the file will not overwrite any existing files.	boolean	Default value is False

Body Parameters

The file object that will be uploaded to the list

WorkPoint365.WebAPI.Model.SharePoint.ListItem+File

Name	Description	Type	Additional information
Id	Gets or sets the identifier.	integer	None.
UniqueId	Gets or sets the unique identifier.	globally unique identifier	None.
FileBytes	Gets or sets the file bytes. that is actually FileBytesAsBase64	string	None.
ExtractedText	Gets or sets extracted readable text from the file when requested and supported.	string	None.
TextExtraction	Gets or sets metadata about text extraction.	WorkPoint365.WebAPI.Model.SharePoint.ListItem+TextExtractionInfo	None.
FileName	Gets or sets the name of the file.	string	None.
Length	Gets or sets the length.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "UniqueId": "887ac135-0f56-4e19-83d1-2fa9d141269b",
  "FileBytes": "sample string 3",
  "ExtractedText": "sample string 4",
  "TextExtraction": {
    "Status": "sample string 1",
    "Message": "sample string 2",
    "Truncated": true,
    "MaxCharacters": 4
  },
  "FileName": "sample string 5",
  "Length": 6
}

application/xml, text/xml

Sample:

<ListItem.File xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.SharePoint">
  <ExtractedText>sample string 4</ExtractedText>
  <FileBytes>sample string 3</FileBytes>
  <FileName>sample string 5</FileName>
  <Id>1</Id>
  <Length>6</Length>
  <TextExtraction>
    <MaxCharacters>4</MaxCharacters>
    <Message>sample string 2</Message>
    <Status>sample string 1</Status>
    <Truncated>true</Truncated>
  </TextExtraction>
  <UniqueId>887ac135-0f56-4e19-83d1-2fa9d141269b</UniqueId>
</ListItem.File>

Response Information

Resource Description

Returns a bool to indicate if the upload was succesful.

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.