POST api/FileAssistant/Subcontract/{subcontractId}/Sfr/{sfrId}/Instructions

Create SFR Instruction

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subcontractId

integer

Required

sfrId

integer

Required

Body Parameters

SfrInstructionCreateOrUpdateDto
NameDescriptionTypeAdditional information
Code

string

None.

InstructionTypeId

integer

None.

BaseSiteActionsTypeId

BaseSiteActionsTypeId

None.

Files

Collection of DocumentBasicInfoDto

None.

Request Formats

application/json, text/json

Sample:
{
  "code": "sample string 1",
  "instructionTypeId": 2,
  "baseSiteActionsTypeId": 1,
  "files": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ]
}

text/html

Sample:
{"code":"sample string 1","instructionTypeId":2,"baseSiteActionsTypeId":1,"files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}]}

application/xml, text/xml

Sample:
<SfrInstructionCreateOrUpdateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SfrAgg">
  <BaseSiteActionsTypeId>OnlyDataBase</BaseSiteActionsTypeId>
  <Code>sample string 1</Code>
  <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>
  <InstructionTypeId>2</InstructionTypeId>
</SfrInstructionCreateOrUpdateDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SfrInstructionDto
NameDescriptionTypeAdditional information
Id

integer

None.

Code

string

None.

InstructionTypeId

integer

None.

InstructionTypeDescription

string

None.

FileName

string

None.

FileExtension

string

None.

DocumentId

integer

None.

VersionNumber

integer

None.

FolderPath

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "code": "sample string 2",
  "instructionTypeId": 3,
  "instructionTypeDescription": "sample string 4",
  "fileName": "sample string 5",
  "fileExtension": "sample string 6",
  "documentId": 7,
  "versionNumber": 8,
  "folderPath": "sample string 9"
}

text/html

Sample:
{"id":1,"code":"sample string 2","instructionTypeId":3,"instructionTypeDescription":"sample string 4","fileName":"sample string 5","fileExtension":"sample string 6","documentId":7,"versionNumber":8,"folderPath":"sample string 9"}

application/xml, text/xml

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