PUT api/FileAssistant/UpdateDocument

Create Document in database

Request Information

URI Parameters

None.

Body Parameters

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 Folder Path on Site

ApiResult

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Errors	Collection of CustomError	None.
Warnings	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "success": false,
  "message": "sample string 1",
  "errors": [
    {
      "errorCode": 1,
      "errorMessage": "sample string 2"
    },
    {
      "errorCode": 1,
      "errorMessage": "sample string 2"
    }
  ],
  "warnings": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:

{"success":false,"message":"sample string 1","errors":[{"errorCode":1,"errorMessage":"sample string 2"},{"errorCode":1,"errorMessage":"sample string 2"}],"warnings":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample:

<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.DistributedServices.WebApi.Base.Results">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.Infrastructure.Crosscutting.Exceptions">
    <d2p1:CustomError>
      <d2p1:ErrorCode>1</d2p1:ErrorCode>
      <d2p1:ErrorMessage>sample string 2</d2p1:ErrorMessage>
    </d2p1:CustomError>
    <d2p1:CustomError>
      <d2p1:ErrorCode>1</d2p1:ErrorCode>
      <d2p1:ErrorMessage>sample string 2</d2p1:ErrorMessage>
    </d2p1:CustomError>
  </Errors>
  <Message>sample string 1</Message>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Warnings>
</ApiResult>