POST api/FileAssistant/Document/{structureId}

Insert document in database

Request Information

URI Parameters

Name	Description	Type	Additional information
structureId	Structure Id	integer	Required

Body Parameters

documentUpdateDto

DocumentUpdateFileAssiDto

Name	Type	Additional information
DocumentId	integer	None.
FileName	string	None.
StructureId	integer	None.
FolderStructure	string	None.
DocumentOriginTypeId	DocumentOriginTypeId	None.
LocalFileName	string	None.
Description	string	String length: inclusive between 0 and 2000
DocumentType	DocumentTypeId	None.
Tags	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "documentId": 1,
  "fileName": "sample string 1",
  "structureId": 1,
  "folderStructure": "sample string 2",
  "documentOriginTypeId": 1,
  "localFileName": "sample string 3",
  "description": "sample string 4",
  "documentType": 0,
  "tags": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:

{"documentId":1,"fileName":"sample string 1","structureId":1,"folderStructure":"sample string 2","documentOriginTypeId":1,"localFileName":"sample string 3","description":"sample string 4","documentType":0,"tags":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample:

<DocumentUpdateFileAssiDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.Dtos.DocumentAgg">
  <Description>sample string 4</Description>
  <DocumentType>Default</DocumentType>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tags>
  <DocumentId>1</DocumentId>
  <DocumentOriginTypeId>User</DocumentOriginTypeId>
  <FileName>sample string 1</FileName>
  <FolderStructure>sample string 2</FolderStructure>
  <LocalFileName>sample string 3</LocalFileName>
  <StructureId>1</StructureId>
</DocumentUpdateFileAssiDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Inserted Document Path on Site

MultipleVolumeDocumentPath

Name	Type	Additional information
BaseProjectVolumenPaths	Collection of string	None.
RelativeFolderPath	string	None.
FileNameWithVersionAndExtension	string	None.

Response Formats

application/json, text/json

Sample:

{
  "baseProjectVolumenPaths": [
    "sample string 1",
    "sample string 2"
  ],
  "relativeFolderPath": "sample string 1",
  "fileNameWithVersionAndExtension": "sample string 2"
}

text/html

Sample:

{"baseProjectVolumenPaths":["sample string 1","sample string 2"],"relativeFolderPath":"sample string 1","fileNameWithVersionAndExtension":"sample string 2"}

application/xml, text/xml

Sample:

<MultipleVolumeDocumentPath xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.FileAssistant">
  <BaseProjectVolumenPaths xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BaseProjectVolumenPaths>
  <FileNameWithVersionAndExtension>sample string 2</FileNameWithVersionAndExtension>
  <RelativeFolderPath>sample string 1</RelativeFolderPath>
</MultipleVolumeDocumentPath>