POST api/FileAssistant/Subcontracts/{subcontractId}/Progress/Documents

Create progress document

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subcontractId

integer

Required

Body Parameters

CreateProgressDocumentationDto
NameDescriptionTypeAdditional information
Version

integer

None.

SubcontractId

integer

None.

Title

string

None.

BaseSiteActionsTypeId

BaseSiteActionsTypeId

None.

Files

Collection of DocumentBasicInfoDto

None.

Request Formats

application/json, text/json

Sample:
{
  "version": 1,
  "subcontractId": 1,
  "title": "sample string 2",
  "baseSiteActionsTypeId": 1,
  "files": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ]
}

text/html

Sample:
{"version":1,"subcontractId":1,"title":"sample string 2","baseSiteActionsTypeId":1,"files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}]}

application/xml, text/xml

Sample:
<CreateProgressDocumentationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SubcontractAgg">
  <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>
  <SubcontractId>1</SubcontractId>
  <Title>sample string 2</Title>
  <Version>1</Version>
</CreateProgressDocumentationDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProgressDocumentDto
NameDescriptionTypeAdditional information
Id

integer

None.

SubcontractId

integer

None.

Title

string

None.

DocumentId

integer

None.

FileName

string

None.

FileExtension

string

None.

VersionNumber

integer

None.

FolderPath

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "subcontractId": 2,
  "title": "sample string 3",
  "documentId": 4,
  "fileName": "sample string 5",
  "fileExtension": "sample string 6",
  "versionNumber": 7,
  "folderPath": "sample string 8"
}

text/html

Sample:
{"id":1,"subcontractId":2,"title":"sample string 3","documentId":4,"fileName":"sample string 5","fileExtension":"sample string 6","versionNumber":7,"folderPath":"sample string 8"}

application/xml, text/xml

Sample:
<ProgressDocumentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SubcontractAgg">
  <DocumentId>4</DocumentId>
  <FileExtension>sample string 6</FileExtension>
  <FileName>sample string 5</FileName>
  <FolderPath>sample string 8</FolderPath>
  <Id>1</Id>
  <SubcontractId>2</SubcontractId>
  <Title>sample string 3</Title>
  <VersionNumber>7</VersionNumber>
</ProgressDocumentDto>