POST documents/upload/{projectId}

Uploads a document. 1st step: document metadata

Request Information

URI Parameters

Name	Description	Type	Additional information
projectId		globally unique identifier	Required

Body Parameters

DocumentUploadRequest

Name	Description	Type	Additional information
Id	Upload request ID	integer	None.
DocumentProperties	Document properties	PropertyBagDocument	Required

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "DocumentProperties": {
    "Title": "sample string 1",
    "Filename": "sample string 2",
    "Folder": "sample string 3",
    "Type": "Work"
  }
}

application/xml, text/xml

Sample:

<DocumentUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sif.Source.Api.Models">
  <DocumentProperties>
    <Filename>sample string 2</Filename>
    <Folder>sample string 3</Folder>
    <Title>sample string 1</Title>
  </DocumentProperties>
  <Id>1</Id>
</DocumentUploadRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Document upload request

DocumentUploadRequest

Name	Description	Type	Additional information
Id	Upload request ID	integer	None.
DocumentProperties	Document properties	PropertyBagDocument	Required

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "DocumentProperties": {
    "Title": "sample string 1",
    "Filename": "sample string 2",
    "Folder": "sample string 3",
    "Type": "Work"
  }
}

application/xml, text/xml

Sample:

<DocumentUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sif.Source.Api.Models">
  <DocumentProperties>
    <Filename>sample string 2</Filename>
    <Folder>sample string 3</Folder>
    <Title>sample string 1</Title>
  </DocumentProperties>
  <Id>1</Id>
</DocumentUploadRequest>