List Biological Assets

curl --request GET \
  --url https://api.example.com/api/forest/biological-assets

{
  "items": [
    {
      "id": "<string>",
      "level4Id": "<string>",
      "biologicalAssetKey": "<string>",
      "accountingKey": "<string>",
      "establishmentDate": "<string>",
      "plantingYear": 123,
      "geneticMaterialCode": "<string>",
      "geneticMaterialName": "<string>",
      "assetType": "<string>",
      "managementSchemeCode": "<string>",
      "managementSchemeName": "<string>",
      "inventoryCode": "<string>",
      "inventoryType": "<string>",
      "inventoryDate": "<string>",
      "inventoryAgeYears": 123,
      "level5UnitCount": 123,
      "spacingCode": "<string>",
      "spacingDescription": "<string>",
      "spacingBetweenRowsM": 123,
      "spacingBetweenTreesM": 123,
      "treeDensityPerHa": 123,
      "survivalRate": 123,
      "dominantHeightM": 123,
      "meanHeightM": 123,
      "quadraticDiameterM": 123,
      "basalAreaM2": 123,
      "unitVolumeM3NoBarkPerHa": 123,
      "unitVolumeM3WithBarkPerHa": 123,
      "totalVolumeM3NoBark": 123,
      "totalVolumeM3WithBark": 123,
      "adjustedVolumeM3NoBarkPerHa": 123,
      "adjustedVolumeM3WithBarkPerHa": 123,
      "imaClassCode": "<string>",
      "imaClassName": "<string>",
      "actualCostUsd": 123,
      "isActive": true,
      "createdAt": {},
      "updatedAt": {},
      "level4": {
        "id": "<string>",
        "code": "<string>",
        "name": "<string>"
      }
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

GET

api

forest

biological-assets

List Biological Assets

curl --request GET \
  --url https://api.example.com/api/forest/biological-assets

{
  "items": [
    {
      "id": "<string>",
      "level4Id": "<string>",
      "biologicalAssetKey": "<string>",
      "accountingKey": "<string>",
      "establishmentDate": "<string>",
      "plantingYear": 123,
      "geneticMaterialCode": "<string>",
      "geneticMaterialName": "<string>",
      "assetType": "<string>",
      "managementSchemeCode": "<string>",
      "managementSchemeName": "<string>",
      "inventoryCode": "<string>",
      "inventoryType": "<string>",
      "inventoryDate": "<string>",
      "inventoryAgeYears": 123,
      "level5UnitCount": 123,
      "spacingCode": "<string>",
      "spacingDescription": "<string>",
      "spacingBetweenRowsM": 123,
      "spacingBetweenTreesM": 123,
      "treeDensityPerHa": 123,
      "survivalRate": 123,
      "dominantHeightM": 123,
      "meanHeightM": 123,
      "quadraticDiameterM": 123,
      "basalAreaM2": 123,
      "unitVolumeM3NoBarkPerHa": 123,
      "unitVolumeM3WithBarkPerHa": 123,
      "totalVolumeM3NoBark": 123,
      "totalVolumeM3WithBark": 123,
      "adjustedVolumeM3NoBarkPerHa": 123,
      "adjustedVolumeM3WithBarkPerHa": 123,
      "imaClassCode": "<string>",
      "imaClassName": "<string>",
      "actualCostUsd": 123,
      "isActive": true,
      "createdAt": {},
      "updatedAt": {},
      "level4": {
        "id": "<string>",
        "code": "<string>",
        "name": "<string>"
      }
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

Retrieves a paginated list of biological assets (Level 6) associated with Level 4 patrimony units. Results can be filtered by Level 4 unit and searched by biological key, accounting key, genetic material name, or inventory code.

Authentication

Requires authentication with valid session token. Users must have forest-biological-asset READ or CREATE/UPDATE/DELETE permissions. SUPER_ADMIN role has full access.

Query Parameters

level4Id

string

Filter by Level 4 patrimony unit ID (UUID format)

string

Search term to filter by biological asset key, accounting key, genetic material name, or inventory code (case-insensitive)

sortBy

string

default:"biologicalAssetKey"

Field to sort by. Options: biologicalAssetKey, accountingKey, assetType, plantingYear, inventoryCode, isActive, createdAt

sortOrder

string

default:"asc"

Sort direction. Options: asc, desc

page

number

default:"1"

Page number for pagination (minimum: 1)

limit

number

default:"25"

Number of items per page (minimum: 1, maximum: 100)

Response

items

array

Array of biological asset objects

Show Biological Asset Object

string

Unique identifier (UUID)

level4Id

string

Associated Level 4 patrimony unit ID

biologicalAssetKey

string

required

Unique biological asset key (max 220 characters)

accountingKey

string

Accounting key for financial tracking

establishmentDate

date

Date when the biological asset was established

plantingYear

number

Year of planting

geneticMaterialCode

string

Code for genetic material

geneticMaterialName

string

Name of genetic material

assetType

string

Type of asset. Options: COMERCIAL, INVESTIGACION

managementSchemeCode

string

Management scheme code

managementSchemeName

string

Management scheme name

inventoryCode

string

Inventory code

inventoryType

string

Type of inventory

inventoryDate

date

Date of inventory

inventoryAgeYears

number

Age of inventory in years

level5UnitCount

number

Number of Level 5 units

spacingCode

string

Spacing code

spacingDescription

string

Description of spacing

spacingBetweenRowsM

decimal

Spacing between rows in meters (up to 12 decimal places with 4 precision)

spacingBetweenTreesM

decimal

Spacing between trees in meters

treeDensityPerHa

decimal

Tree density per hectare

survivalRate

decimal

Survival rate percentage (up to 5 digits with 2 decimal precision)

dominantHeightM

decimal

Dominant height in meters

meanHeightM

decimal

Mean height in meters

quadraticDiameterM

decimal

Quadratic diameter in meters

basalAreaM2

decimal

Basal area in square meters

unitVolumeM3NoBarkPerHa

decimal

Unit volume without bark per hectare (cubic meters)

unitVolumeM3WithBarkPerHa

decimal

Unit volume with bark per hectare (cubic meters)

totalVolumeM3NoBark

decimal

Total volume without bark (cubic meters)

totalVolumeM3WithBark

decimal

Total volume with bark (cubic meters)

adjustedVolumeM3NoBarkPerHa

decimal

Adjusted volume without bark per hectare (cubic meters)

adjustedVolumeM3WithBarkPerHa

decimal

Adjusted volume with bark per hectare (cubic meters)

imaClassCode

string

IMA classification code

imaClassName

string

IMA classification name

actualCostUsd

decimal

Actual cost in USD (up to 18 digits with 2 decimal precision)

isActive

boolean

Whether the asset is active

createdAt

datetime

Creation timestamp

updatedAt

datetime

Last update timestamp

level4

object

Associated Level 4 patrimony unit details

Show Level 4 Details

string

Level 4 unit ID

code

string

Level 4 unit code

name

string

Level 4 unit name

pagination

object

Pagination metadata

Show Pagination

total

number

Total number of items

page

number

Current page number

limit

number

Items per page

totalPages

number

Total number of pages

Error Responses

400: Invalid parameters
401: Unauthorized (not authenticated)
403: Forbidden (user lacks required permissions or organization)

Example Request

curl -X GET "https://api.example.com/api/forest/biological-assets?level4Id=123e4567-e89b-12d3-a456-426614174000&search=pine&page=1&limit=25" \
  -H "Authorization: Bearer YOUR_TOKEN"

Example Response

{
  "items": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "level4Id": "123e4567-e89b-12d3-a456-426614174000",
      "biologicalAssetKey": "BA-PINE-001",
      "accountingKey": "ACC-001",
      "establishmentDate": "2020-03-15T00:00:00Z",
      "plantingYear": 2020,
      "geneticMaterialCode": "GM-001",
      "geneticMaterialName": "Pinus caribaea",
      "assetType": "COMERCIAL",
      "inventoryCode": "INV-2023-001",
      "inventoryType": "Full Inventory",
      "inventoryDate": "2023-06-01T00:00:00Z",
      "inventoryAgeYears": 3,
      "treeDensityPerHa": 1111,
      "survivalRate": 95.5,
      "dominantHeightM": 12.5,
      "meanHeightM": 11.2,
      "actualCostUsd": 15000.00,
      "isActive": true,
      "createdAt": "2023-01-10T14:30:00Z",
      "updatedAt": "2023-06-15T09:20:00Z",
      "level4": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "L4-001",
        "name": "Rodal Norte"
      }
    }
  ],
  "pagination": {
    "total": 48,
    "page": 1,
    "limit": 25,
    "totalPages": 2
  }
}

Level 5 - Reference Units

Create Biological Asset

⌘I

Build docs developers (and LLMs) love

Get started for free Talk to us

Authentication

Organizations

Forest Patrimony

Biological Assets

Geospatial

Configuration

List Biological Assets

Authentication

Query Parameters

Response

Error Responses

Example Request

Example Response

Build docs developers (and LLMs) love

Authentication

Organizations

Forest Patrimony

Biological Assets

Geospatial

Configuration

​Authentication

​Query Parameters

​Response

​Error Responses

​Example Request

​Example Response

Build docs developers (and LLMs) love

Authentication

Query Parameters

Response

Error Responses

Example Request

Example Response