Working with Growth Scales π
Overview
The Growth Scales domain provides a standardized system for managing crop phenological development stages. Growth scales define the progression of plant development from emergence through vegetative growth to reproductive maturity, enabling consistent tracking and communication of crop development stages across agricultural operations.
Cardinality summary
- Growth Scale β 0..1 Organization (custom vs canon scales)
- Growth Scale β 1..* Growth Stages (phenological stages)
- Growth Scale β 0..* Localized Crops (crop-location associations)
Growth Scale
βββ Organization 0..1 - Custom or Global
βββ Localized Crops 0..*
βββ Growth Stages 1..*
Key Concepts
| Concept | Description |
|---|---|
| Growth Scale | Standardized system for tracking crop phenological development stages |
| Growth Stage | Individual developmental phase within a growth scale (e.g., "Tillering", "Flowering") |
| Stage Type | Category of development: emergence (1), vegetative (2), or reproductive (3) |
| Stage Order | Sequential numbering of stages within a growth scale |
| Type Order | Standardized ordering: emergence=1, vegetative=2, reproductive=3 |
API Documentation
For complete API reference including request/response schemas, authentication, and interactive testing, visit:
π Growth Scales API Documentation - Interactive API documentation with request/response examples
Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /v2/catalog/growth-scales | Create a new growth scale |
| GET | /v2/catalog/growth-scales/{id} | Get growth scale by ID |
| PUT | /v2/catalog/growth-scales/{id} | Update growth scale information |
| DELETE | /v2/catalog/growth-scales/{id} | Delete a growth scale |
| GET | /v2/catalog/growth-scales | List growth scales with filtering and pagination (by org) |
| GET | /v2/catalog/growth-scales/no-org | List growth scales without org filter |
| GET | /v2/catalog/growth-scales/localized-crop | Get growth scales by localized crop |
| POST | /v2/catalog/growth-scales/{id}/localized-crops | Associate growth scale with localized crops |
| GET | /v2/catalog/growth-scales/{id}/localized-crops | Get all localized crops for a growth scale |
| POST | /v2/catalog/growth-scales/{growthScaleId}/growth-stage/{growthStageId}/image | Upload image to growth stage |
Business Rules
Localized Crop Association
Growth scales can be associated with localized crops (crop-location combinations):
Association Rules:
- A growth scale can be associated with multiple localized crops
- Each association is specific to an organization, crop, and location
Stage Type and Order Validation
Growth stages must follow strict type and order rules to ensure standardized progression:
Type Order Consistency:
emergencestages must havetype_order = 1vegetativestages must havetype_order = 2reproductivestages must havetype_order = 3- Throws an error if type and type_order don't match
Sequential Order Requirement:
Stage order values must be sequential integers without gaps
Growth Scale Organization Scope
Growth scales can be either global, available to all organizations, or custom, meaning they are specific to a single organization.
Error Codes
Growth Scale Errors
| Code | Message | HTTP Status | When Triggered |
|---|---|---|---|
| EGSC001 | Growth Scale does not exist | 404 NOT_FOUND | Requested growth scale ID not found during GET, UPDATE, or DELETE operations |
| EGSC002 | Duplication error message (varies) | 400 BAD_REQUEST | Attempting to create duplicate growth scale (message varies by context) |
Growth Stage Errors
| Code | Message | HTTP Status | When Triggered |
|---|---|---|---|
| EGST001 | The order of growth stages must be sequential | 400 BAD_REQUEST | Growth stage order values are not sequential integers during CREATE or UPDATE |
| EGST002 | Emergence, Vegetative and Reproductive should have the following type_order 1, 2, 3 | 400 BAD_REQUEST | Stage type and type_order don't match expected mapping during CREATE or UPDATE |
| EGST003 | Growth Stage does not exist | 404 NOT_FOUND | Requested growth stage ID not found during GET, UPDATE, or image upload operations |
Typical Workflows
Basic Growth Scale Management
- Create Growth Scale - Set up new phenological development system with sequential stages
- Update Growth Scale - Modify scale name, organization scope, or stage definitions
- Retrieve Growth Scale - Get scale details with optional localized crop information
- List Growth Scales - Query scales by organization, crop, or location filters
- Delete Growth Scale - Soft delete scales no longer in use
Crop-Location Associations
- Associate Scales - Link growth scales to specific crop-location combinations
- Query by Location - Retrieve growth scales for a specific country and crop
- Localized Information - Include localized crop info in growth scale responses
- Multi-Location Support - Manage different scales for the same crop across locations
Next Steps
After creating your growth scales, you can: