POST api/Subcontracts/{subcontractId}/RequiredDocumentations/TreeQuery

Get subcontract required documentation tree view

Request Information

URI Parameters

Name	Description	Type	Additional information
subcontractId		integer	Required

Body Parameters

RequiredDocumentationFilter

Name	Type	Additional information
RequiredDocTypeId	integer	None.
Required	boolean	None.
Delivered	boolean	None.
Approved	boolean	None.
ApprovalUser	string	None.
Name	string	None.
DeliveredDate	Collection of date	None.
DeliveryDeadline	Collection of date	None.
ApprovedDate	Collection of date	None.
IsNative	boolean	None.
IsAsBuild	boolean	None.
Equipments	string	None.
Status	string	None.
ClientCode	string	None.
Criticality	string	None.
DocCode	string	None.
RequiredForCert	boolean	None.
IsDefault	boolean	None.
Page	Page	None.
SortedColumns	Collection of Order	None.

Request Formats

application/json, text/json

Sample:

{
  "requiredDocTypeId": 1,
  "required": true,
  "delivered": true,
  "approved": true,
  "approvalUser": "sample string 2",
  "name": "sample string 3",
  "deliveredDate": [
    "2026-05-09T14:03:23.6325427+02:00",
    "2026-05-09T14:03:23.6325427+02:00"
  ],
  "deliveryDeadline": [
    "2026-05-09T14:03:23.6325427+02:00",
    "2026-05-09T14:03:23.6325427+02:00"
  ],
  "approvedDate": [
    "2026-05-09T14:03:23.6325427+02:00",
    "2026-05-09T14:03:23.6325427+02:00"
  ],
  "isNative": true,
  "isAsBuild": true,
  "equipments": "sample string 4",
  "status": "sample string 5",
  "clientCode": "sample string 6",
  "criticality": "sample string 7",
  "docCode": "sample string 8",
  "requiredForCert": true,
  "isDefault": true,
  "page": {
    "number": 1,
    "size": 2,
    "skip": 0
  },
  "sortedColumns": [
    {
      "name": "sample string 1",
      "descending": true
    },
    {
      "name": "sample string 1",
      "descending": true
    }
  ]
}

text/html

Sample:

{"requiredDocTypeId":1,"required":true,"delivered":true,"approved":true,"approvalUser":"sample string 2","name":"sample string 3","deliveredDate":["2026-05-09T14:03:23.6325427+02:00","2026-05-09T14:03:23.6325427+02:00"],"deliveryDeadline":["2026-05-09T14:03:23.6325427+02:00","2026-05-09T14:03:23.6325427+02:00"],"approvedDate":["2026-05-09T14:03:23.6325427+02:00","2026-05-09T14:03:23.6325427+02:00"],"isNative":true,"isAsBuild":true,"equipments":"sample string 4","status":"sample string 5","clientCode":"sample string 6","criticality":"sample string 7","docCode":"sample string 8","requiredForCert":true,"isDefault":true,"page":{"number":1,"size":2,"skip":0},"sortedColumns":[{"name":"sample string 1","descending":true},{"name":"sample string 1","descending":true}]}

application/xml, text/xml

Sample:

<RequiredDocumentationFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.RequiredDocumentationAgg">
  <Page xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities">
    <Number>1</Number>
    <Size>2</Size>
  </Page>
  <SortedColumns xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities">
    <Order>
      <Descending>true</Descending>
      <Name>sample string 1</Name>
    </Order>
    <Order>
      <Descending>true</Descending>
      <Name>sample string 1</Name>
    </Order>
  </SortedColumns>
  <ApprovalUser>sample string 2</ApprovalUser>
  <Approved>true</Approved>
  <ApprovedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>2026-05-09T14:03:23.6325427+02:00</d2p1:dateTime>
    <d2p1:dateTime>2026-05-09T14:03:23.6325427+02:00</d2p1:dateTime>
  </ApprovedDate>
  <ClientCode>sample string 6</ClientCode>
  <Criticality>sample string 7</Criticality>
  <Delivered>true</Delivered>
  <DeliveredDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>2026-05-09T14:03:23.6325427+02:00</d2p1:dateTime>
    <d2p1:dateTime>2026-05-09T14:03:23.6325427+02:00</d2p1:dateTime>
  </DeliveredDate>
  <DeliveryDeadline xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>2026-05-09T14:03:23.6325427+02:00</d2p1:dateTime>
    <d2p1:dateTime>2026-05-09T14:03:23.6325427+02:00</d2p1:dateTime>
  </DeliveryDeadline>
  <DocCode>sample string 8</DocCode>
  <Equipments>sample string 4</Equipments>
  <IsAsBuild>true</IsAsBuild>
  <IsDefault>true</IsDefault>
  <IsNative>true</IsNative>
  <Name>sample string 3</Name>
  <Required>true</Required>
  <RequiredDocTypeId>1</RequiredDocTypeId>
  <RequiredForCert>true</RequiredForCert>
  <Status>sample string 5</Status>
</RequiredDocumentationFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of RequiredDocumentationTreeNode

Name	Type	Additional information
Data	RequiredDocumentationData	None.
Expanded	boolean	None.
Children	Collection of RequiredDocumentationTreeNode	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "data": {
      "id": 1,
      "text": "sample string 2",
      "description": "sample string 3"
    },
    "expanded": true,
    "children": []
  },
  {
    "data": {
      "id": 1,
      "text": "sample string 2",
      "description": "sample string 3"
    },
    "expanded": true,
    "children": []
  }
]

text/html

Sample:

[{"data":{"id":1,"text":"sample string 2","description":"sample string 3"},"expanded":true,"children":[]},{"data":{"id":1,"text":"sample string 2","description":"sample string 3"},"expanded":true,"children":[]}]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.