PUT api/RequiredDocumentations/{requiredDocumentationId}
Updates a required documentation list
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| requiredDocumentationId | integer |
Required |
Body Parameters
RequiredDocumentationCuDto| Name | Description | Type | Additional information |
|---|---|---|---|
| SubcontractId | integer |
None. |
|
| RequiredDocTypeId | integer |
None. |
|
| Required | boolean |
None. |
|
| Name | string |
None. |
|
| DeliveryDeadline | date |
None. |
|
| DeliveredDate | date |
None. |
|
| ApprovedDate | date |
None. |
|
| ApprovalUser | string |
None. |
|
| IsDefault | boolean |
None. |
|
| DocumentId | integer |
None. |
|
| DeleteSubcontractDocumentId | boolean |
None. |
|
| Title | string |
None. |
|
| DocCode | string |
None. |
|
| TrNumber | string |
None. |
|
| ClientCode | string |
None. |
|
| RequiredForCert | boolean |
None. |
|
| Criticality | string |
None. |
|
| Equipments | string |
None. |
|
| Status | string |
None. |
|
| IsAsBuild | boolean |
None. |
|
| IsNative | boolean |
None. |
|
| ObjectId | string |
None. |
|
| Files | Collection of DocumentBasicInfoDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"subcontractId": 1,
"requiredDocTypeId": 2,
"required": true,
"name": "sample string 4",
"deliveryDeadline": "2026-05-08T21:00:24.8475655+02:00",
"deliveredDate": "2026-05-08T21:00:24.8475655+02:00",
"approvedDate": "2026-05-08T21:00:24.8475655+02:00",
"approvalUser": "sample string 5",
"isDefault": true,
"documentId": 1,
"deleteSubcontractDocumentId": true,
"title": "sample string 7",
"docCode": "sample string 8",
"trNumber": "sample string 9",
"clientCode": "sample string 10",
"requiredForCert": true,
"criticality": "sample string 11",
"equipments": "sample string 12",
"status": "sample string 13",
"isAsBuild": true,
"isNative": true,
"objectId": "sample string 14",
"files": [
{
"id": 1,
"name": "sample string 2"
},
{
"id": 1,
"name": "sample string 2"
}
]
}
text/html
Sample:
{"subcontractId":1,"requiredDocTypeId":2,"required":true,"name":"sample string 4","deliveryDeadline":"2026-05-08T21:00:24.8475655+02:00","deliveredDate":"2026-05-08T21:00:24.8475655+02:00","approvedDate":"2026-05-08T21:00:24.8475655+02:00","approvalUser":"sample string 5","isDefault":true,"documentId":1,"deleteSubcontractDocumentId":true,"title":"sample string 7","docCode":"sample string 8","trNumber":"sample string 9","clientCode":"sample string 10","requiredForCert":true,"criticality":"sample string 11","equipments":"sample string 12","status":"sample string 13","isAsBuild":true,"isNative":true,"objectId":"sample string 14","files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}]}
application/xml, text/xml
Sample:
<RequiredDocumentationCuDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.RequiredDocumentationAgg">
<ApprovalUser>sample string 5</ApprovalUser>
<ApprovedDate>2026-05-08T21:00:24.8475655+02:00</ApprovedDate>
<ClientCode>sample string 10</ClientCode>
<Criticality>sample string 11</Criticality>
<DeleteSubcontractDocumentId>true</DeleteSubcontractDocumentId>
<DeliveredDate>2026-05-08T21:00:24.8475655+02:00</DeliveredDate>
<DeliveryDeadline>2026-05-08T21:00:24.8475655+02:00</DeliveryDeadline>
<DocCode>sample string 8</DocCode>
<DocumentId>1</DocumentId>
<Equipments>sample string 12</Equipments>
<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>
<IsAsBuild>true</IsAsBuild>
<IsDefault>true</IsDefault>
<IsNative>true</IsNative>
<Name>sample string 4</Name>
<ObjectId>sample string 14</ObjectId>
<Required>true</Required>
<RequiredDocTypeId>2</RequiredDocTypeId>
<RequiredForCert>true</RequiredForCert>
<Status>sample string 13</Status>
<SubcontractId>1</SubcontractId>
<Title>sample string 7</Title>
<TrNumber>sample string 9</TrNumber>
</RequiredDocumentationCuDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
booleanResponse Formats
application/json, text/json, text/html
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>