POST api/FileAssistant/Supplements/{supplementId}/Documents

Create supplement document

Request Information

URI Parameters

Name	Description	Type	Additional information
supplementId		integer	Required

Body Parameters

CreateSupplementDocumentDto

Name	Type	Additional information
Version	integer	None.
SuplementVersionId	integer	None.
Title	string	None.
FolderPath	string	None.
BaseSiteActionsTypeId	BaseSiteActionsTypeId	None.
Files	Collection of DocumentBasicInfoDto	None.

Request Formats

application/json, text/json

Sample:

{
  "version": 1,
  "suplementVersionId": 1,
  "title": "sample string 2",
  "folderPath": "sample string 3",
  "baseSiteActionsTypeId": 1,
  "files": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ]
}

text/html

Sample:

{"version":1,"suplementVersionId":1,"title":"sample string 2","folderPath":"sample string 3","baseSiteActionsTypeId":1,"files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}]}

application/xml, text/xml

Sample:

<CreateSupplementDocumentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SuplementAgg">
  <BaseSiteActionsTypeId>OnlyDataBase</BaseSiteActionsTypeId>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.Dtos.DocumentAgg">
    <d2p1:DocumentBasicInfoDto>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:DocumentBasicInfoDto>
    <d2p1:DocumentBasicInfoDto>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:DocumentBasicInfoDto>
  </Files>
  <FolderPath>sample string 3</FolderPath>
  <SuplementVersionId>1</SuplementVersionId>
  <Title>sample string 2</Title>
  <Version>1</Version>
</CreateSupplementDocumentDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SupplementDocumentDto

Name	Type	Additional information
Id	integer	None.
SuplementId	integer	None.
SuplementVersionId	integer	None.
Title	string	None.
VersionToSign	integer	None.
Signed	boolean	None.
SignedVersion	integer	None.
DocumentId	integer	None.
FileName	string	None.
FileExtension	string	None.
VersionNumber	integer	None.
FolderPath	string	None.
FileSize	integer	None.
FileSizeKB	decimal number	None.
FileSizeMB	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "suplementId": 2,
  "suplementVersionId": 1,
  "title": "sample string 3",
  "versionToSign": 4,
  "signed": true,
  "signedVersion": 6,
  "documentId": 7,
  "fileName": "sample string 8",
  "fileExtension": "sample string 9",
  "versionNumber": 10,
  "folderPath": "sample string 11",
  "fileSize": 1,
  "fileSizeKB": 0.0009765625,
  "fileSizeMB": 9.5367431640625E-07
}

text/html

Sample:

{"id":1,"suplementId":2,"suplementVersionId":1,"title":"sample string 3","versionToSign":4,"signed":true,"signedVersion":6,"documentId":7,"fileName":"sample string 8","fileExtension":"sample string 9","versionNumber":10,"folderPath":"sample string 11","fileSize":1,"fileSizeKB":0.0009765625,"fileSizeMB":0.00000095367431640625}

application/xml, text/xml

Sample:

<SupplementDocumentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SuplementAgg">
  <DocumentId>7</DocumentId>
  <FileExtension>sample string 9</FileExtension>
  <FileName>sample string 8</FileName>
  <FileSize>1</FileSize>
  <FolderPath>sample string 11</FolderPath>
  <Id>1</Id>
  <Signed>true</Signed>
  <SignedVersion>6</SignedVersion>
  <SuplementId>2</SuplementId>
  <SuplementVersionId>1</SuplementVersionId>
  <Title>sample string 3</Title>
  <VersionNumber>10</VersionNumber>
  <VersionToSign>4</VersionToSign>
</SupplementDocumentDto>