FolderDto

A data transfer object (DTO) representing a geological structure, i.e. basin, play, segment or prospect. Geological structures in GeoX and Opportunity Assessor are commonly known and organized as folders.

idinteger, (int32)required

The unique identifier.

namestring, [ 1 .. 256 ] characters

The name of the folder (basin, play, segment or prospect).

typestringread-only

The type of geological structure object, i.e. basin, play, segment or prospect.

hasPolygonboolean

Indicates whether the folder has a related polygon.

childrenArray of objects(FolderDto)

Child folders.

analysisArray of objects(FolderAnalysisDto)

Analyses associated with this folder.

parentFolderIdinteger, (int32)

ID of the parent folder. 0 if the parent folder is a root-level basin.

{
  "id": 0,
  "name": "string",
  "type": "string",
  "hasPolygon": true,
  "children": [
    { … }
  ],
  "analysis": [
    { … }
  ],
  "parentFolderId": 0
}