Skip to main content
API docs by Redocly

Sintetic GeoDB API (0.2.0)

Download OpenAPI specification:Download

License: MIT

Web API for single item identification for forest production, protection and management.

Please, notice that resource tags are ordered by dependency and/or place along the forest value chain. For instance, in order to create a Forest Operation, a respective Forest Property must be created first.

Organizations

Participant organizations with programmatic access to the Sintetic GeoDB API.

Retrieves all organizations

All organizations are returned, including those soft deleted. Available only for administrators.

Authorizations:
LoginAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an organization

Available only for administrators.

Authorizations:
LoginAuth
Request Body schema: application/json
required
name
required
string
abbreviation
required
string
website
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "abbreviation": "string",
  • "website": "string"
}

Retrieves an organization

Available only for administrators.

Authorizations:
LoginAuth
path Parameters
organization_id
required
string
Example: organization_id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "abbreviation": "string",
  • "website": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "soft_deleted_at": "2019-08-24T14:15:22Z"
}

Updates an organization

Available only for administrators.

Authorizations:
LoginAuth
path Parameters
organization_id
required
string
Example: organization_id
Request Body schema: application/json
required
name
required
string
abbreviation
required
string
website
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "abbreviation": "string",
  • "website": "string"
}

Soft deletes an organization

All of the organization's users will be soft deleted and their respective login tokens will be deactivated. Soft deletion is used to maintain data integrity and for accountability reasons. Deletion of the current logged-in user's organization is not allowed. If an organization is already soft deleted this operation has no effect. Available only for administrators.

Authorizations:
LoginAuth
path Parameters
organization_id
required
string
Example: organization_id

Responses

Restores an organization

If an organization has not been soft deleted this operation has no effect. Available only for administrators.

Authorizations:
LoginAuth
path Parameters
organization_id
required
string
Example: organization_id
Request Body schema: application/json
Schema not provided

Responses

Users

Users who belong to a participant organization and have programmatic access to the Sintetic GeoDB API.

Updates the password of the current user.

Request Body schema: application/json
required
old_password
string <password>
new_password
string <password>

Responses

Request samples

Content type
application/json
{
  • "old_password": "pa$$word",
  • "new_password": "pa$$word"
}

Retrieves all users

All users are returned, including those soft deleted. Available only for administrators.

Authorizations:
LoginAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a user

Available only for administrators.

Authorizations:
LoginAuth
Request Body schema: application/json
required
email
required
string
name
required
string
password
required
string
organization_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "password": "string",
  • "organization_id": 0
}

Retrieves a user

Available when logged in as the requested user or as an administrator.

Authorizations:
LoginAuth
path Parameters
user_id
required
string
Example: user_id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "admin": true,
  • "organization": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "soft_deleted_at": "2019-08-24T14:15:22Z"
}

Updates a user

Available only for administrators.

Authorizations:
LoginAuth
path Parameters
user_id
required
string
Example: user_id
Request Body schema: application/json
required
email
required
string
name
required
string
organization_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "organization_id": 0
}

Soft deletes a single user

All of the user's login tokens will be deactivated. Soft deletion is used to maintain data integrity and for accountability reasons. Self-deletion is not possible, i.e., the currently logged-in user cannot delete themself. If a user is already soft deleted this operation has no effect.
Available only for administrators.

Authorizations:
LoginAuth
path Parameters
user_id
required
string
Example: user_id

Responses

Restores a user

If a user has not been soft deleted this operation has no effect. Available only for administrators.

Authorizations:
LoginAuth
path Parameters
user_id
required
string
Example: user_id
Request Body schema: application/json
Schema not provided

Responses

Auth

User authentication and authorization.

List the current user's bearer logins

Only the active bearer logins of the logged-in user are returned.

Authorizations:
LoginAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create bear login token

Authorizations:
LoginAuth
Request Body schema: application/json
required

Bearer login details.

object
name
string
scopes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "bearer_login": {
    }
}

Response samples

Content type
application/json
{
  • "bearer_login": {
    },
  • "token": "string"
}

Get bearer login

Retrieves only bearer logins from the current user

Authorizations:
LoginAuth
path Parameters
bearer_login_id
required
string
Example: bearer_login_id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "scopes": [
    ],
  • "active_at": "2019-08-24T14:15:22Z",
  • "inactive_at": "2019-08-24T14:15:22Z"
}

Delete bearer login

Revokes a bearer login token by deleting.

Authorizations:
LoginAuth
path Parameters
bearer_login_id
required
string
Example: bearer_login_id

Responses

Log in using email and password

Request Body schema: application/json
required

Login credentials.

object
email
string <email>
password
string <password>

Responses

Request samples

Content type
application/json
{
  • "login": {
    }
}

Response samples

Content type
application/json
{
  • "login": {
    }
}

Log out current user

Responses

Creates password reset

A message with instructions on how to reset the passwrod will be sent to the given email address.

Request Body schema: application/json
required

Pasword reset token.

email
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Reset user password

Update password of the user associated to the password reset token, if valid.

Request Body schema: application/json
required

Pasword reset token.

token
string
object

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "password_reset": {
    }
}

Verify password reset token

Request Body schema: application/json
required

Pasword reset token.

token
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "email": "user@example.com"
}

Create a URL signature in JWT format

Bearer token with scope read required. Token expires after 10 minutes.

Authorizations:
BearerLoginAuth

Responses

Tree Species

Shared naming of tree species.

Immediate associations:

  • has many: Inventory Trees
  • has many: Harvested Trees
  • has many: Inventory Reports
  • has many: Harvesting Reports
  • has many: Tree Log Reports
  • has many: Tree Log Product Definitions

List tree species

query Parameters
name
string

Search by name

common_name
string

Search by common name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create tree species

Available only for administrators.

Authorizations:
LoginAuth
Request Body schema: application/json
required
name
required
string
common_name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "common_name": "string"
}

Get tree species

Available only for administrators.

path Parameters
tree_species_id
required
string
Example: tree_species_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "common_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update tree species

Available only for administrators.

Authorizations:
LoginAuth
path Parameters
tree_species_id
required
string
Example: tree_species_id
Request Body schema: application/json
required
name
required
string
common_name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "common_name": "string"
}

Delete tree species

If the tree species is already used elsewhere in the database the deletion will fail. Available only for administrators.

Authorizations:
LoginAuth
path Parameters
tree_species_id
required
string
Example: tree_species_id

Responses

Forest Property Owners

Proprietors of forestland used for logging operations.

Immediate associations:

  • has_many: Forest Properties

List forest property owners

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

name
string

Search by name

type
string
Enum: "legal_entity" "person"

Filter by forest property owner

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create forest property owner

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
type
string
Enum: "legal_entity" "person"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "legal_entity"
}

Get forest property owner

Authorizations:
BearerLoginAuth
path Parameters
forest_property_owner_id
required
string
Example: forest_property_owner_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "legal_entity",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update forest property owner

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
forest_property_owner_id
required
string
Example: forest_property_owner_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
type
string
Enum: "legal_entity" "person"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "legal_entity"
}

Delete forest property owner

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
forest_property_owner_id
required
string
Example: forest_property_owner_id

Responses

Forest Properties

Forestland units used for logging operations.

Immediate associations:

  • belongs to: Forest Property Owner
  • has many: Forest Operations
  • has many: Subcompartments [subcompartmentable_type=forest_property]

List forest properties

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

name
string

Search by name

created_at
string (TimeInterval)

Filter by creation datetime interval

country_iso
string

Filter by country (ISO 3166-1 alpha-2)

owner_id
string <uuid> (Universally unique identitifier)

Filter by forest property owner ID

ownership_type
string
Enum: "public" "private"

Filter by ownership type

bbox
Array of numbers (BoundingBox)
Example: bbox=11.1,43.2,12.8,44.9

Filter by intersection of location and bounding box

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create forest property

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
string <uuid> (Universally unique identitifier)
name
required
string
required
object (GeoJSONPoint)

Centroid of associated forest operation boundaries.

ownership_type
string
Enum: "public" "private"
country_iso
string

Uppercase country code (ISO 3166-1 alpha-2).

subdivision_iso
string

Uppercase administrative subsivision (ISO 3166-2).

description
string
owner_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "location": {
    },
  • "ownership_type": "public",
  • "country_iso": "IT",
  • "subdivision_iso": "IT-52",
  • "description": "string",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05"
}

Get forest property

Authorizations:
BearerLoginAuth
path Parameters
forest_property_id
required
string
Example: forest_property_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "location": {
    },
  • "ownership_type": "public",
  • "country_iso": "IT",
  • "subdivision_iso": "IT-52",
  • "description": "string",
  • "related_overview": {
    },
  • "owner": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update forest property

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
forest_property_id
required
string
Example: forest_property_id
Request Body schema: application/json
required
id
string <uuid> (Universally unique identitifier)
name
required
string
required
object (GeoJSONPoint)

Centroid of associated forest operation boundaries.

ownership_type
string
Enum: "public" "private"
country_iso
string

Uppercase country code (ISO 3166-1 alpha-2).

subdivision_iso
string

Uppercase administrative subsivision (ISO 3166-2).

description
string
owner_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "location": {
    },
  • "ownership_type": "public",
  • "country_iso": "IT",
  • "subdivision_iso": "IT-52",
  • "description": "string",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05"
}

Delete forest property

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
forest_property_id
required
string
Example: forest_property_id

Responses

Forest Operations

Operations break down forestland spatially and temporarily, easing management and reporting.

Immediate associations:

  • belongs to: Forest Property
  • has many: Forest Operation Attachments
  • has many: Sample Plots
  • has many: Subcompartments [subcompartmentable=forest_operation]
  • has many: StanForD Attachments
  • has many: Inventory Reports [forest_reportable=forest_operation]
  • has many: Harvesting Reports [forest_reportable=forest_operation]
  • has many: Tree Log Reports [forest_reportable=forest_operation]

List forest operations

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

name
string

Search by name

forest_property_id
string <uuid> (Universally unique identitifier)

Filter by forest property ID

type
string
Enum: "thinning" "clearfell" "continuous_cover_forestry"

Filter by type

status
string
Enum: "planned" "in_progress" "on_hold" "complete"

Filter by status

start_date
string (TimeInterval)

Filter by start date

end_date
string (TimeInterval)

Filter by end date

manager
string

Search by manager

bbox
Array of numbers (BoundingBox)
Example: bbox=11.1,43.2,12.8,44.9

Filter by intersection of location and bounding box

origin_property_id
string <uuid> (Universally unique identitifier)

Filter by the ID of the forest property of origin

origin_property_owner_id
string <uuid> (Universally unique identitifier)

Filter by the owner ID of the forest property of origin

origin_property_country_iso
string

Filter by the country (ISO 3166-1 alpha-2) of the forest property of origin

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create forest operation

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
status
string
Enum: "planned" "in_progress" "on_hold" "complete"
type
string
Enum: "thinning" "clearfell" "continuous_cover_forestry"
manager
string
start_date
string <date>
end_date
string <date>
object (GeoJSONPoint)
area
required
number

Unit: hectare (ha).

productive_area
number

Unit: hectare (ha).

harvested_area
number

Unit: hectare (ha).

forest_property_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "planned",
  • "type": "thinning",
  • "manager": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "location": {
    },
  • "area": 0,
  • "productive_area": 0,
  • "harvested_area": 0,
  • "forest_property_id": "5d6232cf-1bc2-4d95-b482-70ba73bac5a0"
}

Get forest operation

Authorizations:
BearerLoginAuth
path Parameters
forest_operation_id
required
string
Example: forest_operation_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "planned",
  • "type": "thinning",
  • "manager": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "location": {
    },
  • "area": 0,
  • "productive_area": 0,
  • "harvested_area": 0,
  • "related_overview": {
    },
  • "forest_property": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update forest operation

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
forest_operation_id
required
string
Example: forest_operation_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
status
string
Enum: "planned" "in_progress" "on_hold" "complete"
type
string
Enum: "thinning" "clearfell" "continuous_cover_forestry"
manager
string
start_date
string <date>
end_date
string <date>
object (GeoJSONPoint)
area
required
number

Unit: hectare (ha).

productive_area
number

Unit: hectare (ha).

harvested_area
number

Unit: hectare (ha).

forest_property_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "planned",
  • "type": "thinning",
  • "manager": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "location": {
    },
  • "area": 0,
  • "productive_area": 0,
  • "harvested_area": 0,
  • "forest_property_id": "5d6232cf-1bc2-4d95-b482-70ba73bac5a0"
}

Delete forest operation

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
forest_operation_id
required
string
Example: forest_operation_id

Responses

Forest Operation Attachments

Generic attachment files for a forest operation.

Immediate associations:

  • belongs to: Forest Operation

List forest operation attachments

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

forest_operation_id
string <uuid> (Universally unique identitifier)

Filter by forest operation ID

name
string

Search by name

type
string

Filter by type

category
string
Enum: "office" "image" "geo_vector" "geo_raster" "data_exchange" "archive"

Filter by category

tag
string

Filter by tag

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "type" "name" "largest" "smallest"

Sort results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create forest operation attachment

Authorizations:
BearerLoginAuth
Request Body schema: multipart/form-data
attachment:forest_operation_id
required
string <uuid>
attachment:name
string

If missing it will default to the filename without extension

attachment:tags
Array of strings
attachment:description
string
attachment:file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "category": "office",
  • "size": 0,
  • "url": "string",
  • "description": "string",
  • "tags": [
    ],
  • "related_overview": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Download attachment file

Authorizations:
BearerLoginAuthURLSignatureAuth
path Parameters
forest_operation_attachment_id
required
string
Example: forest_operation_attachment_id

Responses

Get forest operation attachment

Authorizations:
BearerLoginAuth
path Parameters
forest_operation_attachment_id
required
string
Example: forest_operation_attachment_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "category": "office",
  • "size": 0,
  • "url": "string",
  • "description": "string",
  • "tags": [
    ],
  • "related_overview": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete forest operation attachment

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
forest_operation_attachment_id
required
string
Example: forest_operation_attachment_id

Responses

Update forest operation attachment

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
forest_operation_attachment_id
required
string
Example: forest_operation_attachment_id
Request Body schema: application/json
required
required
object
name
string
description
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "attachment": {
    }
}

Subcompartments

Basic forest management units for mapping, display, and analysis as contextual references.

Immediate associations:

  • belongs to: subcompartmentable { Forest Property | Forest Operation }
  • has many: Harvested Trees
  • has many: Inventory Reports [forest_reportable=subcompartment]
  • has many: Harvesting Reports [forest_reportable=subcompartment]
  • has many: Tree Log Reports [forest_reportable=subcompartment]

List subcompartments

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

name
string

Search by name

subcompartmentable_type
string
Enum: "forest_operation" "forest_property"

Filter by subcompartmentable type

forest_property_id
string <uuid> (Universally unique identitifier)

Filter by forest property ID

forest_operation_id
string <uuid> (Universally unique identitifier)

Filter by forest operation ID

bbox
Array of numbers (BoundingBox)
Example: bbox=11.1,43.2,12.8,44.9

Filter by intersection of boundaries and bounding box

origin_property_id
string <uuid> (Universally unique identitifier)

Filter by the ID of the forest property of origin

origin_property_owner_id
string <uuid> (Universally unique identitifier)

Filter by the owner ID of the forest property of origin

origin_property_country_iso
string

Filter by the country (ISO 3166-1 alpha-2) of the forest property of origin

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create subcompartment

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
object (GeoJSONPolygon)
area
number

Unit: hectare (ha).

productive_area
number

Unit: hectare (ha).

harvested_area
number

Unit: hectare (ha).

altitude
number

Unit: meter (m).

exposition
string
slope
number
variety
string

Unit: percent of slope (%[slope]).

co2_capture
number

Unit: tonne (t).

distance_to_road
number
biomass
number
subcompartmentable_id
required
string <uuid> (Universally unique identitifier)
subcompartmentable_type
required
string
Enum: "forest_operation" "forest_property"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "boundaries": {
    },
  • "area": 0,
  • "productive_area": 0,
  • "harvested_area": 0,
  • "altitude": 0,
  • "exposition": "string",
  • "slope": 0,
  • "variety": "string",
  • "co2_capture": 0,
  • "distance_to_road": 0,
  • "biomass": 0,
  • "subcompartmentable_id": "9d37112e-782b-4f0c-b324-c0798cd32c2c",
  • "subcompartmentable_type": "forest_operation",
  • "subcompartmentable": {
    }
}

Get subcompartment

Authorizations:
BearerLoginAuth
path Parameters
subcompartment_id
required
string
Example: subcompartment_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "boundaries": {
    },
  • "area": 0,
  • "productive_area": 0,
  • "harvested_area": 0,
  • "altitude": 0,
  • "exposition": "string",
  • "slope": 0,
  • "variety": "string",
  • "co2_capture": 0,
  • "distance_to_road": 0,
  • "biomass": 0,
  • "subcompartmentable_type": "forest_operation",
  • "related_overview": {
    },
  • "subcompartmentable": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update subcompartment

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
subcompartment_id
required
string
Example: subcompartment_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
object (GeoJSONPolygon)
area
number

Unit: hectare (ha).

productive_area
number

Unit: hectare (ha).

harvested_area
number

Unit: hectare (ha).

altitude
number

Unit: meter (m).

exposition
string
slope
number
variety
string

Unit: percent of slope (%[slope]).

co2_capture
number

Unit: tonne (t).

distance_to_road
number
biomass
number
subcompartmentable_id
required
string <uuid> (Universally unique identitifier)
subcompartmentable_type
required
string
Enum: "forest_operation" "forest_property"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "boundaries": {
    },
  • "area": 0,
  • "productive_area": 0,
  • "harvested_area": 0,
  • "altitude": 0,
  • "exposition": "string",
  • "slope": 0,
  • "variety": "string",
  • "co2_capture": 0,
  • "distance_to_road": 0,
  • "biomass": 0,
  • "subcompartmentable_id": "9d37112e-782b-4f0c-b324-c0798cd32c2c",
  • "subcompartmentable_type": "forest_operation",
  • "subcompartmentable": {
    }
}

Delete subcompartment

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
subcompartment_id
required
string
Example: subcompartment_id

Responses

Sample Plots

Plots of landforest samples used for inventory purposes.

Immediate associations:

  • belongs to: Forest Operation
  • has many: Tree Logs
  • has many: Tree Log Reports
  • has many: Tree Log Locations
  • has many: Harvesting Reports
  • has many: StanForD Attachments

List sample plots

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

name
string

Search by name

created_at
string (TimeInterval)

Filter by creation datetime interval

forest_operation_id
string <uuid> (Universally unique identitifier)

Filter by forest operation ID

measured_at
string (TimeInterval)

Filter by measurement datetime interval

bbox
Array of numbers (BoundingBox)
Example: bbox=11.1,43.2,12.8,44.9

Filter by intersection of location and bounding box

origin_property_id
string <uuid> (Universally unique identitifier)

Filter by the ID of the forest property of origin

origin_property_owner_id
string <uuid> (Universally unique identitifier)

Filter by the owner ID of the forest property of origin

origin_property_country_iso
string

Filter by the country (ISO 3166-1 alpha-2) of the forest property of origin

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create sample plot

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
string
measured_at
string <date-time>

Timestamp of measurement in the field.

required
object (GeoJSONPoint)
shape
required
string
Enum: "circle" "rectangle" "polygon"
object (GeoJSONPolygon)

Required if shape is polygon.

radius
number

Required if shape is circle.

length
number

Required if shape is rectangle.

width
number

Required if shape is rectangle.

sample_area
number

Unit: hectare (ha).

object
forest_operation_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "shape": "circle",
  • "boundaries": {
    },
  • "radius": 0,
  • "length": 0,
  • "width": 0,
  • "sample_area": 0,
  • "additional_info": { },
  • "forest_operation_id": "e960db52-0db3-4b8c-9119-d11faac14929"
}

Get sample plot

Authorizations:
BearerLoginAuth
path Parameters
sample_plot_id
required
string
Example: sample_plot_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "shape": "circle",
  • "boundaries": {
    },
  • "radius": 0,
  • "length": 0,
  • "width": 0,
  • "sample_area": 0,
  • "additional_info": { },
  • "related_overview": {
    },
  • "forest_operation": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update sample plot

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sample_plot_id
required
string
Example: sample_plot_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
string
measured_at
string <date-time>

Timestamp of measurement in the field.

required
object (GeoJSONPoint)
shape
required
string
Enum: "circle" "rectangle" "polygon"
object (GeoJSONPolygon)

Required if shape is polygon.

radius
number

Required if shape is circle.

length
number

Required if shape is rectangle.

width
number

Required if shape is rectangle.

sample_area
number

Unit: hectare (ha).

object
forest_operation_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "shape": "circle",
  • "boundaries": {
    },
  • "radius": 0,
  • "length": 0,
  • "width": 0,
  • "sample_area": 0,
  • "additional_info": { },
  • "forest_operation_id": "e960db52-0db3-4b8c-9119-d11faac14929"
}

Delete sample plot

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sample_plot_id
required
string
Example: sample_plot_id

Responses

Tree Processors

Devices (e.g., harvesters, forwarders) used to process trees.

Immediate associations:

  • has many: Inventory Trees
  • has many: Inventory Reports [forest_reportable=sample_plot]
  • has many: Harvesting Reports [forest_reportable=sample_plot]
  • has many: Tree Log Reports [forest_reportable=sample_plot]

List tree processors

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

name
string

Search by name

created_at
string (TimeInterval)

Filter by creation datetime interval

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create tree processor

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
type
string
Enum: "harvester" "forwarder" "manual" "other"
operator_label
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "harvester",
  • "operator_label": "string"
}

Get tree processor

Authorizations:
BearerLoginAuth
path Parameters
tree_processor_id
required
string
Example: tree_processor_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "harvester",
  • "operator_label": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update tree processor

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_processor_id
required
string
Example: tree_processor_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
type
string
Enum: "harvester" "forwarder" "manual" "other"
operator_label
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "harvester",
  • "operator_label": "string"
}

Delete tree processor

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_processor_id
required
string
Example: tree_processor_id

Responses

StanForD Attachments

Attachment files in the StanForD format, both the classic and 2010 editions.

Immediate associations:

  • belongs to: Forest Operation
  • belongs to: Tree Processor

List StanForD attachments

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

forest_operation_id
string <uuid> (Universally unique identitifier)

Filter by forest operation ID

tree_processor_id
string <uuid> (Universally unique identitifier)

Filter by tree processor ID

name
string

Search by name

type
string

Filter by type

classic
boolean

Filter by classic StanForD (true) or StanForD 2010 (false)

compressed
boolean

Filter by file compression (available only for StanForD 2010)

tag
string

Filter by tag

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "type" "name" "largest" "smallest"

Sort results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create StanForD attachment

Bearer token with scope harvest_write required.

Authorizations:
BearerLoginAuth
Request Body schema: multipart/form-data
attachment:forest_operation_id
required
string <uuid>
attachment:tree_processor_id
required
string <uuid>
attachment:file
required
string <binary>
attachment:name
string

If missing it will default to the filename without extension

attachment:tags
Array of strings
attachment:description
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "size": 0,
  • "url": "string",
  • "description": "string",
  • "tags": [
    ],
  • "related_overview": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Download attachment file

Authorizations:
BearerLoginAuthURLSignatureAuth
path Parameters
stanford_attachment_id
required
string
Example: stanford_attachment_id

Responses

Get StanForD attachment

Authorizations:
BearerLoginAuth
path Parameters
stanford_attachment_id
required
string
Example: stanford_attachment_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "size": 0,
  • "url": "string",
  • "description": "string",
  • "tags": [
    ],
  • "related_overview": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete StanForD attachment

Bearer token with scope harvest_write required.

Authorizations:
BearerLoginAuth
path Parameters
stanford_attachment_id
required
string
Example: stanford_attachment_id

Responses

Update StanForD attachment

Bearer token with scope harvest_write required.

Authorizations:
BearerLoginAuth
path Parameters
stanford_attachment_id
required
string
Example: stanford_attachment_id
Request Body schema: application/json
required
required
object
name
string
description
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "attachment": {
    }
}

Tree Log Product Definitions

Definitions of targeted log products in actual or simulated harvesting.

Immediate associations:

  • belongs to: Tree Species
  • has many: Cutting Instruction Sets

List tree log product definitions

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

name
string

Search by name

tree_species_id
string <uuid> (Universally unique identitifier)

Filter by tree species ID

created_at
string (TimeInterval)

Filter by creation datetime interval

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create tree log product definition

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
max_sweep
number

Unit: millimeter per meter (mm/m).

max_length
number

Unit: meter (m).

min_length
number

Unit: meter (m).

min_small_end_diameter
integer

Unit: tenth of millimeter (mm/10).

max_small_end_diameter
integer

Unit: tenth of millimeter (mm/10).

min_large_end_diameter
integer

Unit: tenth of millimeter (mm/10).

max_large_end_diameter
integer

Unit: tenth of millimeter (mm/10).

tree_species_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "max_sweep": 0,
  • "max_length": 0,
  • "min_length": 0,
  • "min_small_end_diameter": 0,
  • "max_small_end_diameter": 0,
  • "min_large_end_diameter": 0,
  • "max_large_end_diameter": 0,
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8"
}

Get tree log product definition

Authorizations:
BearerLoginAuth
path Parameters
tree_log_product_definition_id
required
string
Example: tree_log_product_definition_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "max_sweep": 0,
  • "max_length": 0,
  • "min_length": 0,
  • "min_small_end_diameter": 0,
  • "max_small_end_diameter": 0,
  • "min_large_end_diameter": 0,
  • "max_large_end_diameter": 0,
  • "related_overview": {
    },
  • "tree_species": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update tree log product definition

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_product_definition_id
required
string
Example: tree_log_product_definition_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
max_sweep
number

Unit: millimeter per meter (mm/m).

max_length
number

Unit: meter (m).

min_length
number

Unit: meter (m).

min_small_end_diameter
integer

Unit: tenth of millimeter (mm/10).

max_small_end_diameter
integer

Unit: tenth of millimeter (mm/10).

min_large_end_diameter
integer

Unit: tenth of millimeter (mm/10).

max_large_end_diameter
integer

Unit: tenth of millimeter (mm/10).

tree_species_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "max_sweep": 0,
  • "max_length": 0,
  • "min_length": 0,
  • "min_small_end_diameter": 0,
  • "max_small_end_diameter": 0,
  • "min_large_end_diameter": 0,
  • "max_large_end_diameter": 0,
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8"
}

Delete tree log product definition

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_product_definition_id
required
string
Example: tree_log_product_definition_id

Responses

Cutting Instruction Sets

Groups of cutting instruction items related to a tree log product definition.

Immediate associations:

  • belongs to: Tree Log Product Definition
  • has many: Cutting Instruction Items
  • has many: Tree Log Reports

List cutting instruction sets

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

name
string

Search by name

created_at
string (TimeInterval)

Filter by creation datetime interval

tree_log_product_definition_id
string <uuid> (Universally unique identitifier)

Filter by tree log product definition ID

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cutting instruction set

Bearer token with scope harvest_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
source
string
tree_log_product_definition_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "tree_log_product_definition_id": "f49d7c01-e2cc-4499-b4a0-ceebfd4a8154"
}

Get cutting instruction set

Authorizations:
BearerLoginAuth
path Parameters
cutting_instruction_set_id
required
string
Example: cutting_instruction_set_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "tree_log_product_definition": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update cutting instruction set

Bearer token with scope harvest_write required.

Authorizations:
BearerLoginAuth
path Parameters
cutting_instruction_set_id
required
string
Example: cutting_instruction_set_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
source
string
tree_log_product_definition_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "tree_log_product_definition_id": "f49d7c01-e2cc-4499-b4a0-ceebfd4a8154"
}

Delete cutting instruction set

Bearer token with scope harvest_write required.

Authorizations:
BearerLoginAuth
path Parameters
cutting_instruction_set_id
required
string
Example: cutting_instruction_set_id

Responses

Cutting Instruction Items

Single cutting instructions with an assigned a weighting/priority.

List cutting instruction items

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

set_id
string <uuid> (Universally unique identitifier)

Filter by cutting instruction set ID

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cutting instruction item

Bearer token with scope harvest_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
sed_classes
Array of numbers
weightings
required
Array of numbers
set_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sed_classes": [
    ],
  • "weightings": [
    ],
  • "set_id": "516c4b88-fac0-4d1c-bb7a-9a8534cc5e71"
}

Get cutting instruction item

Authorizations:
BearerLoginAuth
path Parameters
cutting_instruction_item_id
required
string
Example: cutting_instruction_item_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sed_classes": [
    ],
  • "weightings": [
    ],
  • "set": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update cutting instruction item

Bearer token with scope harvest_write required.

Authorizations:
BearerLoginAuth
path Parameters
cutting_instruction_item_id
required
string
Example: cutting_instruction_item_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
sed_classes
Array of numbers
weightings
required
Array of numbers
set_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sed_classes": [
    ],
  • "weightings": [
    ],
  • "set_id": "516c4b88-fac0-4d1c-bb7a-9a8534cc5e71"
}

Delete cutting instruction item

Bearer token with scope harvest_write required.

Authorizations:
BearerLoginAuth
path Parameters
cutting_instruction_item_id
required
string
Example: cutting_instruction_item_id

Responses

Inventory Trees

Trees within a sample plot used for forest inventory. After harvesting, a related harvested tree record should exist. Associated tree logs are simulated.

Immediate associations:

  • belongs to: Sample Plot
  • belongs to: Tree Species
  • belongs to: Harvested Tree
  • has many: Tree Logs [simulated=true]
  • has many: Quality Indicator Items [qualifiable=harvested_tree]

List inventory trees

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

tree_species_id
string <uuid> (Universally unique identitifier)

Filter by tree species ID

sample_plot_id
string <uuid> (Universally unique identitifier)

Filter by sample plot ID

harvested_tree_id
string <uuid> (Universally unique identitifier)

Filter by harvested tree ID

measured_at
string (TimeInterval)

Filter by measurement datetime interval

external_id
string

Filter by external identifier ID

external_id_type
string
Enum: "other" "rfid" "hammer" "barcode" "paint"

Filter by external identifier type

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create inventory tree

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
tree_species_id
required
string <uuid> (Universally unique identitifier)
harvested_tree_id
string <uuid> (Universally unique identitifier)
sample_plot_id
string <uuid> (Universally unique identitifier)
measured_at
string <date-time>
planted_at
string <date-time>
object (GeoJSONPoint)
dbh
number

Unit: centimeter (cm).

biomass
number

Unit: cubic meter (m3).

volume
number

Unit: cubic meter (m3).

height
number

Unit: meter (m).

required
Array of objects (ExternalIdentifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "harvested_tree_id": "e5e92a12-2704-43b5-bb27-c19911fc2548",
  • "sample_plot_id": "dbf8a575-aa48-432f-8e2f-585e90f120b0",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "planted_at": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "dbh": 0,
  • "biomass": 0,
  • "volume": 0,
  • "height": 0,
  • "external_identifiers": [
    ]
}

Get inventory tree

Authorizations:
BearerLoginAuth
path Parameters
inventory_tree_id
required
string
Example: inventory_tree_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "planted_at": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "dbh": 0,
  • "biomass": 0,
  • "volume": 0,
  • "height": 0,
  • "tree_species": {
    },
  • "harvested_tree": {
    },
  • "sample_plot": {
    },
  • "external_identifiers": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update inventory tree

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
inventory_tree_id
required
string
Example: inventory_tree_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
tree_species_id
required
string <uuid> (Universally unique identitifier)
harvested_tree_id
string <uuid> (Universally unique identitifier)
sample_plot_id
string <uuid> (Universally unique identitifier)
measured_at
string <date-time>
planted_at
string <date-time>
object (GeoJSONPoint)
dbh
number

Unit: centimeter (cm).

biomass
number

Unit: cubic meter (m3).

volume
number

Unit: cubic meter (m3).

height
number

Unit: meter (m).

required
Array of objects (ExternalIdentifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "harvested_tree_id": "e5e92a12-2704-43b5-bb27-c19911fc2548",
  • "sample_plot_id": "dbf8a575-aa48-432f-8e2f-585e90f120b0",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "planted_at": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "dbh": 0,
  • "biomass": 0,
  • "volume": 0,
  • "height": 0,
  • "external_identifiers": [
    ]
}

Delete inventory tree

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
inventory_tree_id
required
string
Example: inventory_tree_id

Responses

Harvested Trees

Trees already harvested and processed. They must belong to a forest operation subcompartment. If the given tree was part of a sample plot, a related inventory tree record should exist. Associated tree logs are non-simulated.

Immediate associations:

  • belongs to: Subcompartment [subcompartmentable=forest_operation]
  • belongs to: Tree Species
  • has one: Inventory Tree
  • has many: Tree Logs [simulated=false]
  • has many: Quality Indicator Items [qualifiable=harvested_tree]

List harvested trees

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

tree_species_id
string <uuid> (Universally unique identitifier)

Filter by tree species ID

external_id
string

Filter by external identifier ID

external_id_type
string
Enum: "other" "rfid" "hammer" "barcode" "paint"

Filter by external identifier type

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create harvested tree

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
field_mark
string
planted_at
string <date-time>
object (GeoJSONPoint)
dbh
number

Unit: centimeter (cm).

biomass
number

Unit: cubic meter (m3).

volume
number

Unit: cubic meter (m3).

height
number

Unit: meter (m).

required
Array of objects (ExternalIdentifier)
tree_species_id
required
string <uuid> (Universally unique identitifier)
subcompartment_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "field_mark": "string",
  • "planted_at": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "dbh": 0,
  • "biomass": 0,
  • "volume": 0,
  • "height": 0,
  • "external_identifiers": [
    ],
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "subcompartment_id": "d12bd93d-888a-4a99-b8ab-a0be016fb97c"
}

Get harvested tree

Authorizations:
BearerLoginAuth
path Parameters
harvested_tree_id
required
string
Example: harvested_tree_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "field_mark": "string",
  • "planted_at": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "dbh": 0,
  • "biomass": 0,
  • "volume": 0,
  • "height": 0,
  • "external_identifiers": [
    ],
  • "tree_species": {
    },
  • "subcompartment": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update harvested tree

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
harvested_tree_id
required
string
Example: harvested_tree_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
field_mark
string
planted_at
string <date-time>
object (GeoJSONPoint)
dbh
number

Unit: centimeter (cm).

biomass
number

Unit: cubic meter (m3).

volume
number

Unit: cubic meter (m3).

height
number

Unit: meter (m).

required
Array of objects (ExternalIdentifier)
tree_species_id
required
string <uuid> (Universally unique identitifier)
subcompartment_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "field_mark": "string",
  • "planted_at": "2019-08-24T14:15:22Z",
  • "location": {
    },
  • "dbh": 0,
  • "biomass": 0,
  • "volume": 0,
  • "height": 0,
  • "external_identifiers": [
    ],
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "subcompartment_id": "d12bd93d-888a-4a99-b8ab-a0be016fb97c"
}

Delete harvested tree

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
harvested_tree_id
required
string
Example: harvested_tree_id

Responses

Tree Logs

A harvested log (related to a harvested tree) or a simulated log (related to an inventory tree) not yet harvested.

Immediate associations:

  • belongs to: Tree Processor
  • belongs_to: Inventory Tree (simulated=true)
  • belongs_to: Harvested Tree (simulated=false)
  • has many: Tree Log Locations
  • has one: Tree Log Sawmill Measurement
  • has many: Boards
  • has many: Quality Indicator Items [qualifiable=tree_log]

List tree logs

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

simulated
boolean

Filter by the given tree log being simulated or not

harvested_tree_id
string <uuid> (Universally unique identitifier)

Filter by harvested tree ID

inventory_tree_id
string <uuid> (Universally unique identitifier)

Filter by inventory tree ID

tree_processor_id
string <uuid> (Universally unique identitifier)

Filter by tree processor ID

product_definition_id
string <uuid> (Universally unique identitifier)

Filter by tree log production definition ID

measured_at
string (TimeInterval)

Filter by the measurement datetime interval

external_id
string

Filter by external identifier ID

external_id_type
string
Enum: "other" "rfid" "hammer" "barcode" "paint"

Filter by external identifier type

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create tree log

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
measured_at
required
string <date-time>
simulated
required
boolean

True if not an actually harvested tree log.

log_part
integer

Log's position within the standing tree, from bottom to top.

forced_cutting_reason
string
Enum: "automatic" "decay" "damage" "crook" "sweep" "grade_break" "pulpwood_grade" "top_break" "spinning" "other_manual"
length
number

Unit: meter (m).

small_end_diameter
integer

Unit: tenth of millimeter (mm/10).

middle_end_diameter
integer

Unit: tenth of millimeter (mm/10).

large_end_diameter
integer

Unit: tenth of millimeter (mm/10).

bottom_height
number

Unit: meter (m). Log bottom height in the stem.

top_height
number

Unit: meter (m). Log top height in the stem.

biomass
number

Unit: cubic meter (m3).

volume_ab
number

Unit: cubic meter (m3). Total volume above bark (e.g. Smaliana).

volume_bb
number

Unit: cubic meter (m3). Total volume below bark (e.g. Smaliana).

sweep
integer

Unit: tenth of millimeter (mm/10).

taper
integer

Unit: tenth of millimeter (mm/10).

required
Array of objects (ExternalIdentifier)
tree_processor_id
required
string <uuid> (Universally unique identitifier)
harvested_tree_id
string <uuid> (Universally unique identitifier)
inventory_tree_id
string <uuid> (Universally unique identitifier)
product_definition_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "simulated": true,
  • "log_part": 0,
  • "forced_cutting_reason": "automatic",
  • "length": 0,
  • "small_end_diameter": 0,
  • "middle_end_diameter": 0,
  • "large_end_diameter": 0,
  • "bottom_height": 0,
  • "top_height": 0,
  • "biomass": 0,
  • "volume_ab": 0,
  • "volume_bb": 0,
  • "sweep": 0,
  • "taper": 0,
  • "external_identifiers": [
    ],
  • "tree_processor_id": "5b1f1314-624e-4e0e-8d0a-7d2a36382530",
  • "harvested_tree_id": "e5e92a12-2704-43b5-bb27-c19911fc2548",
  • "inventory_tree_id": "83382e8f-3d54-4223-bf83-8d1a8b3f5f6c",
  • "product_definition_id": "ee3b7fed-4198-4ce5-b3a9-d0f9fced1bab"
}

Get tree log

Authorizations:
BearerLoginAuth
path Parameters
tree_log_id
required
string
Example: tree_log_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "simulated": true,
  • "log_part": 0,
  • "forced_cutting_reason": "automatic",
  • "length": 0,
  • "small_end_diameter": 0,
  • "middle_end_diameter": 0,
  • "large_end_diameter": 0,
  • "bottom_height": 0,
  • "top_height": 0,
  • "biomass": 0,
  • "volume_ab": 0,
  • "volume_bb": 0,
  • "sweep": 0,
  • "taper": 0,
  • "external_identifiers": [
    ],
  • "tree_processor": {
    },
  • "harvested_tree": {
    },
  • "inventory_tree": {
    },
  • "product_definition": {
    }
}

Update tree log

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_id
required
string
Example: tree_log_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
measured_at
required
string <date-time>
simulated
required
boolean

True if not an actually harvested tree log.

log_part
integer

Log's position within the standing tree, from bottom to top.

forced_cutting_reason
string
Enum: "automatic" "decay" "damage" "crook" "sweep" "grade_break" "pulpwood_grade" "top_break" "spinning" "other_manual"
length
number

Unit: meter (m).

small_end_diameter
integer

Unit: tenth of millimeter (mm/10).

middle_end_diameter
integer

Unit: tenth of millimeter (mm/10).

large_end_diameter
integer

Unit: tenth of millimeter (mm/10).

bottom_height
number

Unit: meter (m). Log bottom height in the stem.

top_height
number

Unit: meter (m). Log top height in the stem.

biomass
number

Unit: cubic meter (m3).

volume_ab
number

Unit: cubic meter (m3). Total volume above bark (e.g. Smaliana).

volume_bb
number

Unit: cubic meter (m3). Total volume below bark (e.g. Smaliana).

sweep
integer

Unit: tenth of millimeter (mm/10).

taper
integer

Unit: tenth of millimeter (mm/10).

required
Array of objects (ExternalIdentifier)
tree_processor_id
required
string <uuid> (Universally unique identitifier)
harvested_tree_id
string <uuid> (Universally unique identitifier)
inventory_tree_id
string <uuid> (Universally unique identitifier)
product_definition_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "simulated": true,
  • "log_part": 0,
  • "forced_cutting_reason": "automatic",
  • "length": 0,
  • "small_end_diameter": 0,
  • "middle_end_diameter": 0,
  • "large_end_diameter": 0,
  • "bottom_height": 0,
  • "top_height": 0,
  • "biomass": 0,
  • "volume_ab": 0,
  • "volume_bb": 0,
  • "sweep": 0,
  • "taper": 0,
  • "external_identifiers": [
    ],
  • "tree_processor_id": "5b1f1314-624e-4e0e-8d0a-7d2a36382530",
  • "harvested_tree_id": "e5e92a12-2704-43b5-bb27-c19911fc2548",
  • "inventory_tree_id": "83382e8f-3d54-4223-bf83-8d1a8b3f5f6c",
  • "product_definition_id": "ee3b7fed-4198-4ce5-b3a9-d0f9fced1bab"
}

Delete tree log

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_id
required
string
Example: tree_log_id

Responses

Tree Log Locations

Indicates the location of a tree log at a given moment as recorded by a given tree processor.

Immediate associations:

  • belongs to: Tree Log

List tree log locations

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

recorded_at
string (TimeInterval)

Filter by original record datetime interval

bbox
Array of numbers (BoundingBox)
Example: bbox=11.1,43.2,12.8,44.9

Filter by intersection of location and bounding box

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create tree log location

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
required
object (GeoJSONPoint)
recorded_at
required
string <date-time>
tree_log_id
required
string <uuid> (Universally unique identitifier)
tree_processor_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "location": {
    },
  • "recorded_at": "2019-08-24T14:15:22Z",
  • "tree_log_id": "db56064e-19b1-4da8-ac78-59ba604cf5df",
  • "tree_processor_id": "5b1f1314-624e-4e0e-8d0a-7d2a36382530"
}

Get tree log location

Authorizations:
BearerLoginAuth
path Parameters
tree_log_location_id
required
string
Example: tree_log_location_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "location": {
    },
  • "recorded_at": "2019-08-24T14:15:22Z",
  • "related_overview": {
    },
  • "tree_log": {
    },
  • "tree_processor": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update tree log location

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_location_id
required
string
Example: tree_log_location_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
required
object (GeoJSONPoint)
recorded_at
required
string <date-time>
tree_log_id
required
string <uuid> (Universally unique identitifier)
tree_processor_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "location": {
    },
  • "recorded_at": "2019-08-24T14:15:22Z",
  • "tree_log_id": "db56064e-19b1-4da8-ac78-59ba604cf5df",
  • "tree_processor_id": "5b1f1314-624e-4e0e-8d0a-7d2a36382530"
}

Delete tree log location

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_location_id
required
string
Example: tree_log_location_id

Responses

Sawmill Companies

Legal entities that manage sawing operations.

Immediate associations:

  • has many: Sawmill Sites

List sawmill companies

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

name
string

Search by name

created_at
string (TimeInterval)

Filter by creation datetime interval

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create sawmill company

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Get sawmill company

Authorizations:
BearerLoginAuth
path Parameters
sawmill_company_id
required
string
Example: sawmill_company_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update sawmill company

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawmill_company_id
required
string
Example: sawmill_company_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Delete sawmill company

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawmill_company_id
required
string
Example: sawmill_company_id

Responses

Sawmill Sites

Industrial facilities focused on sawing operations.

Immediate associations:

  • belongs to: Sawmill Company
  • has many: Sawlines
  • has many: Sawmill Batches

List sawmill sites

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

name
string

Search by name

created_at
string (TimeInterval)

Filter by creation datetime interval

company_id
string <uuid> (Universally unique identitifier)

Filter by sawmill company ID

bbox
Array of numbers (BoundingBox)
Example: bbox=11.1,43.2,12.8,44.9

Filter by intersection of location and bounding box

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create sawmill site

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
object (GeoJSONPoint)
country_iso
string

Uppercase country code (ISO 3166-1 alpha-2).

company_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "location": {
    },
  • "country_iso": "IT",
  • "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf"
}

Get sawmill site

Authorizations:
BearerLoginAuth
path Parameters
sawmill_site_id
required
string
Example: sawmill_site_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "location": {
    },
  • "country_iso": "IT",
  • "related_overview": {
    },
  • "company": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update sawmill site

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawmill_site_id
required
string
Example: sawmill_site_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
object (GeoJSONPoint)
country_iso
string

Uppercase country code (ISO 3166-1 alpha-2).

company_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "location": {
    },
  • "country_iso": "IT",
  • "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf"
}

Delete sawmill site

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawmill_site_id
required
string
Example: sawmill_site_id

Responses

Sawlines

At a sawline, tree logs are processed into lumber through a series of cutting and sorting operations.

Immediate associations:

  • belongs to: Sawmill Site

List sawlines

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

name
string

Search by name

type
string

Search by type

created_at
string (TimeInterval)

Filter by creation datetime interval

sawmill_site_id
string <uuid> (Universally unique identitifier)

Filter by sawmill site ID

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create sawline

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
type
required
string
sawmill_site_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "sawmill_site_id": "d61af51c-2e98-4797-912e-e9214d4c6327"
}

Get sawline

Authorizations:
BearerLoginAuth
path Parameters
sawline_id
required
string
Example: sawline_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "sawmill_site": {
    },
  • "related_overview": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update sawline

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawline_id
required
string
Example: sawline_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
type
required
string
sawmill_site_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "sawmill_site_id": "d61af51c-2e98-4797-912e-e9214d4c6327"
}

Delete sawline

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawline_id
required
string
Example: sawline_id

Responses

Sawline Attachments

Generic attachment files for a sawline.

Immediate associations:

  • belongs to: Sawline

List sawline attachments

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

sawline_id
string <uuid> (Universally unique identitifier)

Filter by sawline ID

name
string

Search by name

type
string

Filter by type

category
string
Enum: "office" "image" "geo_vector" "geo_raster" "data_exchange" "archive"

Filter by category

tag
string

Filter by tag

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "type" "name" "largest" "smallest"

Sort results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create sawline attachment

Authorizations:
BearerLoginAuth
Request Body schema: multipart/form-data
attachment:sawline_id
required
string <uuid>
attachment:name
string

If missing it will default to the filename without extension

attachment:tags
Array of strings
attachment:description
string
attachment:file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "category": "office",
  • "size": 0,
  • "url": "string",
  • "description": "string",
  • "tags": [
    ],
  • "related_overview": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Download attachment file

Authorizations:
BearerLoginAuthURLSignatureAuth
path Parameters
sawline_attachment_id
required
string
Example: sawline_attachment_id

Responses

Get sawline attachment

Authorizations:
BearerLoginAuth
path Parameters
sawline_attachment_id
required
string
Example: sawline_attachment_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "category": "office",
  • "size": 0,
  • "url": "string",
  • "description": "string",
  • "tags": [
    ],
  • "related_overview": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete sawline attachment

Bearer token with scope sawmill_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawline_attachment_id
required
string
Example: sawline_attachment_id

Responses

Update sawline attachment

Bearer token with scope sawmill_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawline_attachment_id
required
string
Example: sawline_attachment_id
Request Body schema: application/json
required
required
object
name
string
description
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "attachment": {
    }
}

Sawmill Batches

Sets of boards produced as a single group on a given sawmill site.

Immediate associations:

  • belongs to: Sawmill Site
  • has many: Boards

List sawmill batches

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

sawmill_site_id
string <uuid> (Universally unique identitifier)

Filter by sawmill site ID

external_id
string

Filter by external identifier ID

created_at
string (TimeInterval)

Filter by creation datetime interval

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create sawmill batch

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
external_id
string
sawmill_site_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "external_id": "string",
  • "sawmill_site_id": "d61af51c-2e98-4797-912e-e9214d4c6327"
}

Get sawmill batch

Authorizations:
BearerLoginAuth
path Parameters
sawmill_batch_id
required
string
Example: sawmill_batch_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "external_id": "string",
  • "related_overview": {
    },
  • "sawmill_site": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update sawmill batch

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawmill_batch_id
required
string
Example: sawmill_batch_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
external_id
string
sawmill_site_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "external_id": "string",
  • "sawmill_site_id": "d61af51c-2e98-4797-912e-e9214d4c6327"
}

Delete sawmill batch

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
sawmill_batch_id
required
string
Example: sawmill_batch_id

Responses

Tree Log Sawmill Measurements

Measurements of a given log as part of a sawmill batch.

Immediate associations:

  • belongs to: Tree Log [simulated=false]

List tree log sawmill measurements

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

sawmill_batch_id
string <uuid> (Universally unique identitifier)

Filter by sawmill batch ID

processed_at
string (TimeInterval)

Filter by processing datetime interval

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create tree log sawmill measurement

Bearer token with scope sawmill_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
tree_log_id
required
string <uuid> (Universally unique identitifier)
processed_at
required
string <date-time>
length
number

Unit: meter (m).

small_end_diameter
integer

Unit: tenth of millimeter (mm/10).

middle_end_diameter
integer

Unit: tenth of millimeter (mm/10).

large_end_diameter
integer

Unit: tenth of millimeter (mm/10).

volume_ab
number

Unit: cubic meter (m3). Total volume above bark (e.g. Smaliana).

volume_bb
number

Unit: cubic meter (m3). Total volume below bark (e.g. Smaliana).

sweep
integer

Unit: tenth of millimeter (mm/10).

taper
integer

Unit: tenth of millimeter (mm/10).

sawmill_batch_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "tree_log_id": "db56064e-19b1-4da8-ac78-59ba604cf5df",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "length": 0,
  • "small_end_diameter": 0,
  • "middle_end_diameter": 0,
  • "large_end_diameter": 0,
  • "volume_ab": 0,
  • "volume_bb": 0,
  • "sweep": 0,
  • "taper": 0,
  • "sawmill_batch_id": "8f6d0ea6-413b-49e5-a151-986619298529"
}

Get tree log sawmill measurement

Authorizations:
BearerLoginAuth
path Parameters
tree_log_id
required
string
Example: tree_log_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "tree_log_id": "db56064e-19b1-4da8-ac78-59ba604cf5df",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "length": 0,
  • "small_end_diameter": 0,
  • "middle_end_diameter": 0,
  • "large_end_diameter": 0,
  • "volume_ab": 0,
  • "volume_bb": 0,
  • "sweep": 0,
  • "taper": 0,
  • "related_overview": {
    },
  • "sawmill_batch": {
    }
}

Update tree log sawmill measurement

Bearer token with scope sawmill_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_sawmill_measurement_id
required
string
Example: tree_log_sawmill_measurement_id
Request Body schema: application/json
required
tree_log_id
required
string <uuid> (Universally unique identitifier)
processed_at
required
string <date-time>
length
number

Unit: meter (m).

small_end_diameter
integer

Unit: tenth of millimeter (mm/10).

middle_end_diameter
integer

Unit: tenth of millimeter (mm/10).

large_end_diameter
integer

Unit: tenth of millimeter (mm/10).

volume_ab
number

Unit: cubic meter (m3). Total volume above bark (e.g. Smaliana).

volume_bb
number

Unit: cubic meter (m3). Total volume below bark (e.g. Smaliana).

sweep
integer

Unit: tenth of millimeter (mm/10).

taper
integer

Unit: tenth of millimeter (mm/10).

sawmill_batch_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "tree_log_id": "db56064e-19b1-4da8-ac78-59ba604cf5df",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "length": 0,
  • "small_end_diameter": 0,
  • "middle_end_diameter": 0,
  • "large_end_diameter": 0,
  • "volume_ab": 0,
  • "volume_bb": 0,
  • "sweep": 0,
  • "taper": 0,
  • "sawmill_batch_id": "8f6d0ea6-413b-49e5-a151-986619298529"
}

Delete tree log sawmill measurement

Bearer token with scope sawmill_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_sawmill_measurement_id
required
string
Example: tree_log_sawmill_measurement_id

Responses

Board Classes

Specific wood quality classes associated with boards.

Immediate associations:

  • has many: Boards

List board classes

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

name
string

Search by name

group_name
string

Search by group name

created_at
string (TimeInterval)

Filter by creation datetime interval

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create board class

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
group_name
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "group_name": "string"
}

Get board class

Authorizations:
BearerLoginAuth
path Parameters
board_class_id
required
string
Example: board_class_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "group_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update board class

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
board_class_id
required
string
Example: board_class_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
group_name
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "group_name": "string"
}

Delete board class

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
board_class_id
required
string
Example: board_class_id

Responses

Boards

Lumber boards belonging to a specific class and sawmill batch.

Immediate associations:

  • belongs to: Sawmill Batch
  • belongs to: Board Class
  • belongs to: Tree Log
  • has many: Quality Indicator Items [qualifiable=board]

List boards

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

tree_log_id
string <uuid> (Universally unique identitifier)

Filter by tree log ID

sawmill_batch_id
string <uuid> (Universally unique identitifier)

Filter by sawmill batch ID

board_class_id
string <uuid> (Universally unique identitifier)

Filter by board class ID

external_id
string

Filter by external identifier ID

external_id_type
string
Enum: "other" "rfid" "hammer" "barcode" "paint"

Filter by external identifier type

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create board

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
measured_at
required
string <date-time>
thickness
required
integer

Unit: tenth of millimeter (mm/10).

width
required
integer

Unit: tenth of millimeter (mm/10).

length
required
integer

Unit: tenth of millimeter (mm/10).

required
Array of objects (ExternalIdentifier)
tree_log_id
required
string <uuid> (Universally unique identitifier)
sawmill_batch_id
required
string <uuid> (Universally unique identitifier)
board_class_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "thickness": 0,
  • "width": 0,
  • "length": 0,
  • "external_identifiers": [
    ],
  • "tree_log_id": "db56064e-19b1-4da8-ac78-59ba604cf5df",
  • "sawmill_batch_id": "8f6d0ea6-413b-49e5-a151-986619298529",
  • "board_class_id": "d0e333af-2977-4485-aecc-ffed922f3e62"
}

Get board

Authorizations:
BearerLoginAuth
path Parameters
board_id
required
string
Example: board_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "thickness": 0,
  • "width": 0,
  • "length": 0,
  • "external_identifiers": [
    ],
  • "tree_log": {
    },
  • "sawmill_batch": {
    },
  • "board_class": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update board

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
board_id
required
string
Example: board_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
measured_at
required
string <date-time>
thickness
required
integer

Unit: tenth of millimeter (mm/10).

width
required
integer

Unit: tenth of millimeter (mm/10).

length
required
integer

Unit: tenth of millimeter (mm/10).

required
Array of objects (ExternalIdentifier)
tree_log_id
required
string <uuid> (Universally unique identitifier)
sawmill_batch_id
required
string <uuid> (Universally unique identitifier)
board_class_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "measured_at": "2019-08-24T14:15:22Z",
  • "thickness": 0,
  • "width": 0,
  • "length": 0,
  • "external_identifiers": [
    ],
  • "tree_log_id": "db56064e-19b1-4da8-ac78-59ba604cf5df",
  • "sawmill_batch_id": "8f6d0ea6-413b-49e5-a151-986619298529",
  • "board_class_id": "d0e333af-2977-4485-aecc-ffed922f3e62"
}

Delete board

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
board_id
required
string
Example: board_id

Responses

Quality Indicators

Specification of a quality feature for trees, tree logs, or boards.

Immediate associations:

  • has many: Quality Indicator Items

List quality indicators

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

name
string

Search by name

kind
string
Enum: "tree" "tree_log" "board"

Filter by indicator kind

sort_by
string
Default: "newest"
Enum: "newest" "oldest" "name"

Sort results by creation date or name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create quality indicator

Bearer token with scope quality_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
name
required
string
description
required
string
kind
required
string
Enum: "tree" "tree_log" "board"
required
object

JSON Schema object

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "kind": "tree",
  • "value_schema": { }
}

Get quality indicator

Authorizations:
BearerLoginAuth
path Parameters
quality_indicator_id
required
string
Example: quality_indicator_id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "kind": "tree",
  • "value_schema": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete quality indicator

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
quality_indicator_id
required
string
Example: quality_indicator_id

Responses

Update quality indicator

Bearer token with scope quality_write required.

path Parameters
quality_indicator_id
required
string
Example: quality_indicator_id
Request Body schema: application/json
required
required
object
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "quality_indicator": {
    }
}

Quality Indicator Items

Instance values of a quality indicator for a specific entity item.

Immediate associations:

  • belongs to: Quality Indicator
  • belongs to: qualifiable { Harvested Tree | Inventory Tree | Tree Log | Board }

List quality indicator items

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

qualifiable_type
string
Enum: "inventory_tree" "harvested_tree" "tree_log" "board"

Filter by qualifiable type

harvested_tree_id
string <uuid> (Universally unique identitifier)

Filter by harvested tree ID

inventory_tree_id
string <uuid> (Universally unique identitifier)

Filter by inventory tree ID

tree_log_id
string <uuid> (Universally unique identitifier)

Filter by tree log ID

board_id
string <uuid> (Universally unique identitifier)

Filter by board ID

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create quality indicator item

Bearer token with scope quality_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
required
object
start_position
number
end_position
number
qualifiable_id
required
string <uuid> (Universally unique identitifier)
qualifiable_type
required
string
Enum: "inventory_tree" "harvested_tree" "tree_log" "board"
indicator_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "value": { },
  • "start_position": 0,
  • "end_position": 0,
  • "qualifiable_id": "66c02e49-115c-49c3-99ea-28fcdb62b978",
  • "qualifiable_type": "inventory_tree",
  • "indicator_id": "f81eef5f-65bd-4ca0-ad15-4c29e7ba67ee",
  • "qualifiable": {
    }
}

Get quality indicator item

Authorizations:
BearerLoginAuth
path Parameters
quality_indicator_item_id
required
string
Example: quality_indicator_item_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "value": { },
  • "start_position": 0,
  • "end_position": 0,
  • "qualifiable_type": "inventory_tree",
  • "related_overview": {
    },
  • "indicator": {
    },
  • "qualifiable": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update quality indicator item

Bearer token with scope quality_write required.

Authorizations:
BearerLoginAuth
path Parameters
quality_indicator_item_id
required
string
Example: quality_indicator_item_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
required
object
start_position
number
end_position
number
qualifiable_id
required
string <uuid> (Universally unique identitifier)
qualifiable_type
required
string
Enum: "inventory_tree" "harvested_tree" "tree_log" "board"
indicator_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "value": { },
  • "start_position": 0,
  • "end_position": 0,
  • "qualifiable_id": "66c02e49-115c-49c3-99ea-28fcdb62b978",
  • "qualifiable_type": "inventory_tree",
  • "indicator_id": "f81eef5f-65bd-4ca0-ad15-4c29e7ba67ee",
  • "qualifiable": {
    }
}

Delete quality indicator item

Bearer token with scope quality_write required.

Authorizations:
BearerLoginAuth
path Parameters
quality_indicator_item_id
required
string
Example: quality_indicator_item_id

Responses

Harvesting Reports

List harvesting reports

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

forest_reportable_type
string
Enum: "forest_operation" "sample_plot" "subcompartment"

Filter by forest reportable type

forest_operation_id
string <uuid> (Universally unique identitifier)

Filter by forest operation ID

subcompartment_id
string <uuid> (Universally unique identitifier)

Filter by subcompartment ID

sample_plot_id
string <uuid> (Universally unique identitifier)

Filter by sample plot ID

tree_species_id
string <uuid> (Universally unique identitifier)

Filter by tree species ID

origin_property_id
string <uuid> (Universally unique identitifier)

Filter by the ID of the forest property of origin

origin_property_owner_id
string <uuid> (Universally unique identitifier)

Filter by the owner ID of the forest property of origin

origin_property_country_iso
string

Filter by the country (ISO 3166-1 alpha-2) of the forest property of origin

tree_processor_id
string <uuid> (Universally unique identitifier)

Filter by tree processor ID

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create harvesting report

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
tree_species_id
string <uuid> (Universally unique identitifier)
forest_reportable_id
required
string <uuid> (Universally unique identitifier)
forest_reportable_type
required
string
Enum: "forest_operation" "sample_plot" "subcompartment"
stem_count
integer
mean_height
number

Unit: meter (m).

mean_dbh
number

Unit: centimeter (cm).

volume
number

Unit: cubic meter (m3).

biomass
number

Unit: tonne (t).

object
tree_processor_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "forest_reportable": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "forest_reportable_id": "57e232dd-6652-425b-b69c-d6ae4e38bbdf",
  • "forest_reportable_type": "forest_operation",
  • "stem_count": 0,
  • "mean_height": 0,
  • "mean_dbh": 0,
  • "volume": 0,
  • "biomass": 0,
  • "additional_info": { },
  • "tree_processor_id": "5b1f1314-624e-4e0e-8d0a-7d2a36382530"
}

Get harvesting report

Authorizations:
BearerLoginAuth
path Parameters
harvesting_report_id
required
string
Example: harvesting_report_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "tree_species": {
    },
  • "forest_reportable": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "forest_reportable_type": "forest_operation",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "stem_count": 0,
  • "mean_height": 0,
  • "mean_dbh": 0,
  • "volume": 0,
  • "biomass": 0,
  • "additional_info": { },
  • "related_overview": {
    },
  • "tree_processor": {
    }
}

Update harvesting report

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
harvesting_report_id
required
string
Example: harvesting_report_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
tree_species_id
string <uuid> (Universally unique identitifier)
forest_reportable_id
required
string <uuid> (Universally unique identitifier)
forest_reportable_type
required
string
Enum: "forest_operation" "sample_plot" "subcompartment"
stem_count
integer
mean_height
number

Unit: meter (m).

mean_dbh
number

Unit: centimeter (cm).

volume
number

Unit: cubic meter (m3).

biomass
number

Unit: tonne (t).

object
tree_processor_id
required
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "forest_reportable": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "forest_reportable_id": "57e232dd-6652-425b-b69c-d6ae4e38bbdf",
  • "forest_reportable_type": "forest_operation",
  • "stem_count": 0,
  • "mean_height": 0,
  • "mean_dbh": 0,
  • "volume": 0,
  • "biomass": 0,
  • "additional_info": { },
  • "tree_processor_id": "5b1f1314-624e-4e0e-8d0a-7d2a36382530"
}

Delete harvesting report

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
harvesting_report_id
required
string
Example: harvesting_report_id

Responses

Inventory Reports

List inventory reports

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

forest_reportable_type
string
Enum: "forest_operation" "sample_plot" "subcompartment"

Filter by forest reportable type

forest_operation_id
string <uuid> (Universally unique identitifier)

Filter by forest operation ID

subcompartment_id
string <uuid> (Universally unique identitifier)

Filter by subcompartment ID

sample_plot_id
string <uuid> (Universally unique identitifier)

Filter by sample plot ID

tree_species_id
string <uuid> (Universally unique identitifier)

Filter by tree species ID

origin_property_id
string <uuid> (Universally unique identitifier)

Filter by the ID of the forest property of origin

origin_property_owner_id
string <uuid> (Universally unique identitifier)

Filter by the owner ID of the forest property of origin

origin_property_country_iso
string

Filter by the country (ISO 3166-1 alpha-2) of the forest property of origin

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create inventory report

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
tree_species_id
string <uuid> (Universally unique identitifier)
forest_reportable_id
required
string <uuid> (Universally unique identitifier)
forest_reportable_type
required
string
Enum: "forest_operation" "sample_plot" "subcompartment"
age
number

Unit: year (a).

stem_count
integer
mean_height
number

Unit: meter (m).

mean_dbh
number

Unit: centimeter (cm).

volume
number

Unit: cubic meter (m3).

biomass
number

Unit: tonne (t).

object

Responses

Request samples

Content type
application/json
{
  • "forest_reportable": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "forest_reportable_id": "57e232dd-6652-425b-b69c-d6ae4e38bbdf",
  • "forest_reportable_type": "forest_operation",
  • "age": 0,
  • "stem_count": 0,
  • "mean_height": 0,
  • "mean_dbh": 0,
  • "volume": 0,
  • "biomass": 0,
  • "additional_info": { }
}

Get inventory report

Authorizations:
BearerLoginAuth
path Parameters
inventory_report_id
required
string
Example: inventory_report_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "tree_species": {
    },
  • "forest_reportable": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "forest_reportable_type": "forest_operation",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "age": 0,
  • "stem_count": 0,
  • "mean_height": 0,
  • "mean_dbh": 0,
  • "volume": 0,
  • "biomass": 0,
  • "additional_info": { },
  • "related_overview": {
    }
}

Update inventory report

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
inventory_report_id
required
string
Example: inventory_report_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
tree_species_id
string <uuid> (Universally unique identitifier)
forest_reportable_id
required
string <uuid> (Universally unique identitifier)
forest_reportable_type
required
string
Enum: "forest_operation" "sample_plot" "subcompartment"
age
number

Unit: year (a).

stem_count
integer
mean_height
number

Unit: meter (m).

mean_dbh
number

Unit: centimeter (cm).

volume
number

Unit: cubic meter (m3).

biomass
number

Unit: tonne (t).

object

Responses

Request samples

Content type
application/json
{
  • "forest_reportable": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "forest_reportable_id": "57e232dd-6652-425b-b69c-d6ae4e38bbdf",
  • "forest_reportable_type": "forest_operation",
  • "age": 0,
  • "stem_count": 0,
  • "mean_height": 0,
  • "mean_dbh": 0,
  • "volume": 0,
  • "biomass": 0,
  • "additional_info": { }
}

Delete inventory report

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
inventory_report_id
required
string
Example: inventory_report_id

Responses

Tree Log Reports

List tree log reports

Authorizations:
BearerLoginAuth
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 25

Maximum number of items per page, with an upper limit of 100

created_at
string (TimeInterval)

Filter by creation datetime interval

forest_reportable_type
string
Enum: "forest_operation" "sample_plot" "subcompartment"

Filter by forest reportable type

forest_operation_id
string <uuid> (Universally unique identitifier)

Filter by forest operation ID

subcompartment_id
string <uuid> (Universally unique identitifier)

Filter by subcompartment ID

sample_plot_id
string <uuid> (Universally unique identitifier)

Filter by sample plot ID

tree_species_id
string <uuid> (Universally unique identitifier)

Filter by tree species ID

origin_property_id
string <uuid> (Universally unique identitifier)

Filter by the ID of the forest property of origin

origin_property_owner_id
string <uuid> (Universally unique identitifier)

Filter by the owner ID of the forest property of origin

origin_property_country_iso
string

Filter by the country (ISO 3166-1 alpha-2) of the forest property of origin

sort_by
string
Default: "newest"
Enum: "newest" "oldest"

Sort results by creation date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create tree log report

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
tree_species_id
string <uuid> (Universally unique identitifier)
forest_reportable_id
required
string <uuid> (Universally unique identitifier)
forest_reportable_type
required
string
Enum: "forest_operation" "sample_plot" "subcompartment"
volume
number

Unit: cubic meter (m3).

mean_length
number

Unit: meter (m).

mean_sed
number

Unit: tenth of millimeter (mm/10).

summed_sed
number

Unit: tenth of millimeter (mm/10).

object
tree_log_count
required
integer
object
tree_processor_id
string <uuid> (Universally unique identitifier)
cutting_instruction_set_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "forest_reportable": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "forest_reportable_id": "57e232dd-6652-425b-b69c-d6ae4e38bbdf",
  • "forest_reportable_type": "forest_operation",
  • "volume": 0,
  • "mean_length": 0,
  • "mean_sed": 0,
  • "summed_sed": 0,
  • "sed_histogram": { },
  • "tree_log_count": 0,
  • "additional_info": { },
  • "tree_processor_id": "5b1f1314-624e-4e0e-8d0a-7d2a36382530",
  • "cutting_instruction_set_id": "908ca8e7-440d-47f2-ba0f-89cc63bd008e"
}

Get tree log report

Authorizations:
BearerLoginAuth
path Parameters
tree_log_report_id
required
string
Example: tree_log_report_id
query Parameters
expand_related
required
boolean

Include expanded related associations; otherwise, only a summary is provided in related_overview

Responses

Response samples

Content type
application/json
{
  • "tree_species": {
    },
  • "forest_reportable": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "forest_reportable_type": "forest_operation",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "volume": 0,
  • "mean_length": 0,
  • "mean_sed": 0,
  • "summed_sed": 0,
  • "sed_histogram": { },
  • "tree_log_count": 0,
  • "additional_info": { },
  • "related_overview": {
    },
  • "tree_processor": {
    },
  • "cutting_instruction_set": {
    }
}

Update tree log report

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_report_id
required
string
Example: tree_log_report_id
Request Body schema: application/json
required
id
required
string <uuid> (Universally unique identitifier)
tree_species_id
string <uuid> (Universally unique identitifier)
forest_reportable_id
required
string <uuid> (Universally unique identitifier)
forest_reportable_type
required
string
Enum: "forest_operation" "sample_plot" "subcompartment"
volume
number

Unit: cubic meter (m3).

mean_length
number

Unit: meter (m).

mean_sed
number

Unit: tenth of millimeter (mm/10).

summed_sed
number

Unit: tenth of millimeter (mm/10).

object
tree_log_count
required
integer
object
tree_processor_id
string <uuid> (Universally unique identitifier)
cutting_instruction_set_id
string <uuid> (Universally unique identitifier)

Responses

Request samples

Content type
application/json
{
  • "forest_reportable": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tree_species_id": "14e60a59-fa80-4ddf-9d9b-8dbb245693e8",
  • "forest_reportable_id": "57e232dd-6652-425b-b69c-d6ae4e38bbdf",
  • "forest_reportable_type": "forest_operation",
  • "volume": 0,
  • "mean_length": 0,
  • "mean_sed": 0,
  • "summed_sed": 0,
  • "sed_histogram": { },
  • "tree_log_count": 0,
  • "additional_info": { },
  • "tree_processor_id": "5b1f1314-624e-4e0e-8d0a-7d2a36382530",
  • "cutting_instruction_set_id": "908ca8e7-440d-47f2-ba0f-89cc63bd008e"
}

Delete tree log report

Bearer token with scope inventory_write required.

Authorizations:
BearerLoginAuth
path Parameters
tree_log_report_id
required
string
Example: tree_log_report_id

Responses