Pest and Disease Scouting Data¶
The following data structures are published by the Pest and Disease Scouting module module. If you want to learn how to retrieve entities published by other modules refer to the our guide "Consuming Data Shared By Other Modules".
Entity Incident¶
(Please describe the purpose of this entity from a business perspective)
/api/v1.0/{orgId}/ModuleDependencies/{moduleId}
/api/v1.0/{orgId}/ModuleDependentEntities/{moduleId}/{entityId}
orgIdrepresents the organization you want data from; in most cases it's the current organizationmoduleIdrepresents the ID of the module requesting the data; in most cases it's your module IDentityIdrepresents the ID of theIncidententity you want to retrieve (see response ofModuleDependencies)
import { Group } from "@element-public/react-group";
import { TypoBody } from "@element-public/react-typography";
import { useEntity } from "@hortiview/modulebase";
export const IncidentComponent = () => {
const { data: incidents } = useEntity("ModuleDepended", "Incident");
return (
<Group>
{incidents.map((incident) => (
<TypoBody>{incident.createdOn}</TypoBody>
))}
</Group>
);
};
JSON Format¶
{
"farm": "1c016474-af10-43a1-a345-f62df1f2495a",
"greenhouse": "31b16e9a-cdda-4e82-b29a-05f3d98b6394",
"block": "e36104ce-c1da-4b9b-97e4-c5aeccfbdc24",
"target": "pests",
"targetKind": null,
"scouter": null,
"notes": null,
"isDismissed": false,
"scheduledOn": null,
"pictures": [],
"followUpReport": null,
"id": 14,
"createdOn": "2025-09-10T13:03:44.716",
"organizationId": "e27ead73-36f1-4bb5-929a-b3799337565d",
"userId": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"bconId": null
}
Properties¶
| Property | Type | Description |
|---|---|---|
farm | UUID | The ID of the farm location the incident has been observed on |
greenhouse | UUID | The ID of the block the incident has been observed in |
block | UUID | The ID of the block the incident has been observed on |
target | String | ... |
targetKind | UUID | ... |
scouter | UUID | ID of the user who observed the incident |
notes | String | Additional information about the incident |
isDismissed | Boolean | ... |
scheduledOn | String, ISO 8601 | ... |
pictures | Array of Objects | Pictures documenting the incident |
followUpReport | UUID | ... |
id | UUID | ID of the incident |
createdOn | String, ISO 8601 | Date and time the incident has been recorded |
organizationId | UUID | ID of the organization the incident has been observed in |
userId | UUID | ID of the user who created the incident |
bconId | UUID | Currently not used (this might not need to be exposed?) |
Entity ScoutingAssignment¶
(Please describe the purpose of this entity from a business perspective)
/api/v1.0/{orgId}/ModuleDependencies/{moduleId}
/api/v1.0/{orgId}/ModuleDependentEntities/{moduleId}/{entityId}
orgIdrepresents the organization you want data from; in most cases it's the current organizationmoduleIdrepresents the ID of the module requesting the data; in most cases it's your module IDentityIdrepresents the ID of theScoutingAssignmententity you want to retrieve (see response ofModuleDependencies)
import { Group } from "@element-public/react-group";
import { TypoBody } from "@element-public/react-typography";
import { useEntity } from "@hortiview/modulebase";
export const ScoutingAssignmentComponent = () => {
const { data: scoutingAssignments } = useEntity("ModuleDepended", "ScoutingAssignment");
return (
<Group>
{scoutingAssignments.map((scoutingAssignment) => (
<TypoBody>{scoutingAssignment.scheduledOn}</TypoBody>
))}
</Group>
);
};
JSON Format¶
{
"scheduledOn": "2025-09-10T00:00:00",
"scouter": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"farm": "1c016474-af10-43a1-a345-f62df1f2495a",
"greenhouse": "31b16e9a-cdda-4e82-b29a-05f3d98b6394",
"bundle": "43a5b634-2eb0-44c0-a928-51846075f503",
"isDismissed": false,
"report": null,
"scouterUserId": 1,
"scouterUser": {
"isScouter": true,
"assignments": [
null,
{
"scheduledOn": "2025-09-11T00:00:00",
"scouter": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"farm": "1c016474-af10-43a1-a345-f62df1f2495a",
"greenhouse": "31b16e9a-cdda-4e82-b29a-05f3d98b6394",
"bundle": "43a5b634-2eb0-44c0-a928-51846075f503",
"isDismissed": false,
"report": null,
"scouterUserId": 1,
"scouterUser": null,
"id": 28,
"createdOn": "2025-09-10T13:04:16.7428551",
"organizationId": "e27ead73-36f1-4bb5-929a-b3799337565d",
"userId": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"bconId": null
}
],
"id": 1,
"createdOn": "2024-12-19T07:21:03.9925419",
"organizationId": "e27ead73-36f1-4bb5-929a-b3799337565d",
"userId": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"bconId": null
},
"id": 27,
"createdOn": "2025-09-10T13:04:16.7428458",
"organizationId": "e27ead73-36f1-4bb5-929a-b3799337565d",
"userId": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"bconId": null
}
Properties¶
| Property | Type | Description |
|---|---|---|
farm | UUID | The ID of the farm location the incident has been observed on |
greenhouse | UUID | The ID of the block the incident has been observed in |
block | UUID | The ID of the block the incident has been observed on |
target | String | ... |
targetKind | UUID | ... |
scouter | UUID | ID of the user who observed the incident |
notes | String | Additional information about the incident |
isDismissed | Boolean | ... |
scheduledOn | String, ISO 8601 | ... |
pictures | Array of Objects | Pictures documenting the incident |
followUpReport | UUID | ... |
id | UUID | ID of the incident |
createdOn | String, ISO 8601 | Date and time the incident has been recorded |
organizationId | UUID | ID of the organization the incident has been observed in |
userId | UUID | ID of the user who created the incident |
bconId | UUID | Currently not used (this might not need to be exposed?) |
Entity ScoutingReport¶
(Please describe the purpose of this entity from a business perspective)
/api/v1.0/{orgId}/ModuleDependencies/{moduleId}
/api/v1.0/{orgId}/ModuleDependentEntities/{moduleId}/{entityId}
orgIdrepresents the organization you want data from; in most cases it's the current organizationmoduleIdrepresents the ID of the module requesting the data; in most cases it's your module IDentityIdrepresents the ID of theIncidententity you want to retrieve (see response ofModuleDependencies)
import { Group } from "@element-public/react-group";
import { TypoBody } from "@element-public/react-typography";
import { useEntity } from "@hortiview/modulebase";
export const IncidentComponent = () => {
const { data: incidents } = useEntity("ModuleDepended", "Incident");
return (
<Group>
{incidents.map((incident) => (
<TypoBody>{incident.createdOn}</TypoBody>
))}
</Group>
);
};
JSON Format¶
{
"farm": "1c016474-af10-43a1-a345-f62df1f2495a",
"greenhouse": "31b16e9a-cdda-4e82-b29a-05f3d98b6394",
"target": "pests",
"targetKind": "Aphid",
"otherTargetKind": null,
"pestStage": "egg",
"isIncidence": true,
"percentInfectedGreenhouse": 0,
"isRegisterIncidenceByBlock": true,
"incidences": [
{
"block": "52dca83c-1201-4f09-9921-c6dc34da8a8f",
"percentInfectedBlock": 23,
"id": 6,
"createdOn": "2025-09-10T13:01:29.9687107",
"organizationId": "e27ead73-36f1-4bb5-929a-b3799337565d",
"userId": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"bconId": null
}
],
"isSeverity": true,
"severities": [
{
"block": "52dca83c-1201-4f09-9921-c6dc34da8a8f",
"severity": 7,
"severityCropParameter": "root",
"row": 5,
"metersInsideRow": 6,
"id": 18,
"createdOn": "2025-09-10T13:01:29.9749553",
"organizationId": "e27ead73-36f1-4bb5-929a-b3799337565d",
"userId": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"bconId": null
}
],
"isCounting": true,
"countings": [
{
"block": "52dca83c-1201-4f09-9921-c6dc34da8a8f",
"count": 6,
"countCropParameter": "waterTrap",
"row": 3,
"metersInsideRow": 4,
"id": 14,
"createdOn": "2025-09-10T13:01:29.9776129",
"organizationId": "e27ead73-36f1-4bb5-929a-b3799337565d",
"userId": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"bconId": null
}
],
"pictures": [
{
"blobName": "cropsgrowinginthailandjpg",
"type": "image/jpeg",
"id": 6,
"createdOn": "2025-09-10T13:01:30.7541382",
"organizationId": "e27ead73-36f1-4bb5-929a-b3799337565d",
"userId": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"bconId": null
}
],
"followUpToId": null,
"followUpTo": null,
"assignmentId": null,
"assignment": null,
"id": 81,
"createdOn": "2025-09-10T13:00:45.139",
"organizationId": "e27ead73-36f1-4bb5-929a-b3799337565d",
"userId": "967f2559-f4e7-4a2f-9e55-8178eb6101bd",
"bconId": null
}
Properties¶
| Property | Type | Description |
|---|---|---|
farm | UUID | The ID of the farm location the incident has been observed on |
greenhouse | UUID | The ID of the block the incident has been observed in |
block | UUID | The ID of the block the incident has been observed on |
target | String | ... |
targetKind | UUID | ... |
scouter | UUID | ID of the user who observed the incident |
notes | String | Additional information about the incident |
isDismissed | Boolean | ... |
scheduledOn | String, ISO 8601 | ... |
pictures | Array of Objects | Pictures documenting the incident |
followUpReport | UUID | ... |
id | UUID | ID of the incident |
createdOn | String, ISO 8601 | Date and time the incident has been recorded |
organizationId | UUID | ID of the organization the incident has been observed in |
userId | UUID | ID of the user who created the incident |
bconId | UUID | Currently not used (this might not need to be exposed?) |