POST api/Subcontracts/{subcontractId}/FolderStructure/TreeNodeId

Get a subcontract folder structure

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subcontractId

integer

Required

Body Parameters

FolderStructureNodeFilter
NameDescriptionTypeAdditional information
Key

string

None.

EntityId

integer

None.

SubcontractId

integer

None.

ProjectId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "key": "sample string 1",
  "entityId": 1,
  "subcontractId": 2,
  "projectId": 3
}

text/html

Sample:
{"key":"sample string 1","entityId":1,"subcontractId":2,"projectId":3}

application/xml, text/xml

Sample:
<FolderStructureNodeFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.Dtos.StructureAgg">
  <EntityId>1</EntityId>
  <Key>sample string 1</Key>
  <ProjectId>3</ProjectId>
  <SubcontractId>2</SubcontractId>
</FolderStructureNodeFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of FolderTreeNode
NameDescriptionTypeAdditional information
Label

string

None.

Data

integer

None.

EntityId

integer

None.

Key

string

None.

RelativePath

string

None.

ExpandedIcon

string

None.

CollapsedIcon

string

None.

Children

Collection of FolderTreeNode

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "label": "sample string 1",
    "data": 2,
    "entityId": 1,
    "key": "sample string 3",
    "relativePath": "sample string 4",
    "expandedIcon": "fa-folder-open",
    "collapsedIcon": "fa-folder",
    "children": []
  },
  {
    "label": "sample string 1",
    "data": 2,
    "entityId": 1,
    "key": "sample string 3",
    "relativePath": "sample string 4",
    "expandedIcon": "fa-folder-open",
    "collapsedIcon": "fa-folder",
    "children": []
  }
]

text/html

Sample:
[{"label":"sample string 1","data":2,"entityId":1,"key":"sample string 3","relativePath":"sample string 4","expandedIcon":"fa-folder-open","collapsedIcon":"fa-folder","children":[]},{"label":"sample string 1","data":2,"entityId":1,"key":"sample string 3","relativePath":"sample string 4","expandedIcon":"fa-folder-open","collapsedIcon":"fa-folder","children":[]}]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.