Download OpenAPI specification:
create a new farm
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
name required | string farm name |
namespace required | string group to which the farm belongs |
parentFarmId | string <uuid> identification of the parent farm. enter this attribute when you want to associate a farm with an existing one (as if it were a tree structure). |
{- "name": "My Farm",
- "namespace": "Farms",
- "parentFarmId": "bfc780ae-3873-4caf-92d3-9b7ae4ea2a57"
}
{- "id": "20f94ebe-361b-44e6-9729-57d744d04b27",
- "name": "My Farm",
- "namespace": "Farms",
- "createdAt": "2024-05-27T22:52:44.903Z"
}
search all farms
withDeleted | boolean (WithDeletedQueryParameter) Default: false Example: withDeleted=true include deleted farms |
namespace | string or null Example: namespace=Farms farm namespace |
name | string or null Example: name=My Farm farm name |
parentFarmId | string or null <uuid> Example: parentFarmId=09650ecf-a354-4d6b-9092-6c0f8d037a92 parent farm id |
page | integer <int32> (PageQueryParameter) Default: 1 Example: page=2 current page number |
pageSize | integer <int32> (PageSizeQueryParameter) Default: 10 Example: pageSize=20 number of farms per page |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
[- {
- "id": "20f94ebe-361b-44e6-9729-57d744d04b27",
- "name": "My Farm",
- "namespace": "Farms",
- "area": 155.43,
- "count": 29,
- "boundaries": "MULTIPOLYGON (((-63.7279364 -8.8349494,-63.7264692 -8.8379071,-63.7252954 -8.8373272,-63.7272909 -8.8346015,-63.7279364 -8.8349494)),((-63.7265866 -8.8333836,-63.7268213 -8.8324557,-63.7245324 -8.8322238,-63.7246498 -8.8331516,-63.7265866 -8.8333836)))",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
]
search farm by id
farmId required | string <uuid> Example: c17ebf24-e2bd-4c83-88fc-f2c8b0e43883 unique farm identification |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
{- "id": "20f94ebe-361b-44e6-9729-57d744d04b27",
- "name": "My Farm",
- "namespace": "Farms",
- "area": 155.43,
- "count": 29,
- "boundaries": "MULTIPOLYGON (((-63.7279364 -8.8349494,-63.7264692 -8.8379071,-63.7252954 -8.8373272,-63.7272909 -8.8346015,-63.7279364 -8.8349494)),((-63.7265866 -8.8333836,-63.7268213 -8.8324557,-63.7245324 -8.8322238,-63.7246498 -8.8331516,-63.7265866 -8.8333836)))",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
search all fields by farm id
farmId required | string <uuid> unique farm identification |
withDeleted | boolean (WithDeletedQueryParameter) Default: false Example: withDeleted=true include deleted fields |
page | integer <int32> (PageQueryParameter) Default: 1 Example: page=2 current page number |
pageSize | integer <int32> (PageSizeQueryParameter) Default: 10 Example: pageSize=20 number of applications per page |
[- {
- "id": "b48207a5-9408-4b92-b15f-6954b225c0b6",
- "name": "Field 01",
- "area": 33.43,
- "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
]
search all fields
withDeleted | boolean (WithDeletedQueryParameter) Default: false Example: withDeleted=true include deleted fields |
page | integer <int32> (PageQueryParameter) Default: 1 Example: page=2 current page number |
pageSize | integer <int32> (PageSizeQueryParameter) Default: 10 Example: pageSize=20 number of applications per page |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
[- {
- "id": "b48207a5-9408-4b92-b15f-6954b225c0b6",
- "name": "Field 01",
- "area": 33.43,
- "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
]
create a new field
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
name required | string field name |
boundaries required | string <wkt> object in wkt format that represents the georeferencing of the field |
farmId required | string <uuid> unique farm identification to which the field will be associated |
{- "name": "Field 01",
- "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
- "farmId": "20f94ebe-361b-44e6-9729-57d744d04b27"
}
{- "id": "b48207a5-9408-4b92-b15f-6954b225c0b6",
- "name": "Field 01",
- "area": 33.43,
- "farmId": "20f94ebe-361b-44e6-9729-57d744d04b27",
- "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z"
}
search field by id
fieldId required | string <uuid> Example: ecafbb6f-c7b4-43d6-bf54-5f7dd98d8377 unique field identification |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
{- "id": "b48207a5-9408-4b92-b15f-6954b225c0b6",
- "name": "Field 01",
- "area": 33.43,
- "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
search all applications
withDeleted | boolean (WithDeletedQueryParameter) Default: false Example: withDeleted=true include deleted applications |
serviceOrderId | string <uuid> Example: serviceOrderId=46e842b6-f4e8-4503-9c3e-bfdc34604849 unique service order identification |
seasonId | string <uuid> Example: seasonId=21c85837-cf04-49a6-9a9e-2661060ef502 unique season identification |
page | integer <int32> (PageQueryParameter) Default: 1 Example: page=2 current page number |
pageSize | integer <int32> (PageSizeQueryParameter) Default: 10 Example: pageSize=20 number of applications per page |
crop | string (CropEnum) Enum: "unknown" "cotton" "corn" "avocado" "bean" "brachiaria" "cereals" "citrus" "cocoa" "coconut" "coffee" "eucalyptus" "grape" "oat" "orange" "peanut" "pineapple" "potato" "rice" "soybean" "sugarcane" "sunflower" "wheat" "sunn_hemp" "pearl_millet" "sorghum" "stylosanthes" "cover" "millet" "banana" "tobacco" "sesame" "seed_corn" Example: crop=cotton season crop |
pilotId | string <uuid> (PilotId) Example: pilotId=d902bd61-6b7f-451e-970c-4576d1fbb238 unique pilot identification |
aerialCompanyId | string <uuid> Example: aerialCompanyId=075773c3-0f4b-4ac0-b74b-6e777ec0a4bd unique aerial company identification |
farmId | string <uuid> Example: farmId=075773c3-0f4b-4ac0-b74b-6e777ec0a4bd unique farm identification |
applicationDateType | string (ApplicationDateTypeEnum) Enum: "application_date" "analysis_date" Example: applicationDateType=application_date application date type |
applicationType | string (ApplicationTypeEnum) Enum: "aerial" "terrestrial" Example: applicationType=aerial application type |
startedIn | string <date-time> Example: startedIn=2024-06-01T22:52:44.903Z application start date |
finishedIn | string <date-time> Example: finishedIn=2024-06-31T22:52:44.903Z application end date |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
[- {
- "id": "fa2a8bbd-5f1d-4012-a022-12a28f676057",
- "season": {
- "id": "fe1e9d3c-18fa-4e31-86c1-38c33be1856c",
- "startedIn": "2024-05-27T22:52:44.903Z",
- "finishedIn": "2024-05-27T22:52:44.903Z",
- "crop": "cotton",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "status": "complete",
- "analysisMethod": "COMPLETE_TARGET",
- "applicationType": "aerial",
- "deletedReason": "wrong_application_data",
- "fields": [
- {
- "id": "52a22d4e-69bf-4b6a-9f7f-247ada19104c",
- "boundaries": "POLYGON ((-64.8000009 -6.7046461,-55.2000008 -10.0284011,-63.3600009 -15.6419963,-64.8000009 -6.7046461))",
- "area": 33.43,
- "totalTargetFieldArea": 234.43,
- "totalInternalAppliedArea": 234.43,
- "totalNotAppliedArea": 234.43,
- "totalInternalAppliedOverlapArea": 234.43,
- "totalAppliedOverdoseArea": 234.43,
- "averageUniformityScore": 234.43,
- "averageFailureScore": 234.43,
- "averageSuccessScore": 234.43,
- "field": {
- "id": "b48207a5-9408-4b92-b15f-6954b225c0b6",
- "name": "Field 01",
- "area": 33.43,
- "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
], - "schedules": [
- {
- "id": "ce75ce52-5064-485a-87a5-aa0f1ebe0c03",
- "status": "executed",
- "pilot": {
- "id": "d902bd61-6b7f-451e-970c-4576d1fbb238",
- "name": "John Due",
- "licenseId": "459439473",
- "aerialCompany": {
- "id": "134457d7-58d3-4247-9f67-3fa82b3a0535",
- "name": "Flight Company",
- "documentNumber": "00.000.000/0000-00",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "aircraft": {
- "id": "54e5221c-8a04-4f86-a558-d85b9210f0c9",
- "enrollmentId": "PT-FFG",
- "model": {
- "id": "07d9a0aa-eb71-451d-af05-de2a06d3d888",
- "name": "AT-401",
- "manufacturer": {
- "id": "ca824435-6ecc-4fcc-9ca1-53801a58790f",
- "name": "Air Tractor",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "aerialCompany": {
- "id": "134457d7-58d3-4247-9f67-3fa82b3a0535",
- "name": "Flight Company",
- "documentNumber": "00.000.000/0000-00",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "startedIn": "2024-05-27T22:52:44.903Z",
- "finishedIn": "2024-05-27T23:32:22.100Z",
- "runwayDistance": 10.4,
- "swathWidth": 28,
- "comments": "my application schedule comments",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
], - "logs": [
- {
- "id": "d8632348-fb7a-4133-a133-8076445bdade",
- "filename": "03062024.log",
- "status": "processed",
- "format": "satloc",
- "metadata": { },
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
], - "products": [
- {
- "id": "bac848b2-5137-4228-a61b-0d6a8e84b0a1",
- "dosage": 1.25,
- "amount": {
- "currency": "BRL",
- "value": 332.43
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
], - "serviceOrder": {
- "id": "4b6d7415-a029-457a-9901-cc66f76aded4",
- "slug": "OS-1234",
- "status": "complete",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "averageSuccessScore": 98.45,
- "averageFailureScore": 98.45,
- "averageUniformityScore": 98.45,
- "averageWasteScore": 98.45,
- "averageRateFlow": 98.45,
- "plannedAverageRateFlow": 98.45,
- "flowRateDataByGroup": [
- {
- "flowRateGroup": "1",
- "groupArea": 98.45,
- "groupPercentual": 98.45,
- "groupColor": "#FEF60D",
- "initialGroupRate": 98.45,
- "finalGroupRate": 98.45
}
], - "averageSpeed": 98.45,
- "averageHeight": 98.45,
- "plannedAverageHeight": 98.45,
- "heightDataByGroup": [
- {
- "heightGroup": "1",
- "groupArea": 98.45,
- "groupPercentual": 98.45,
- "groupColor": "#FEF60D",
- "initialGroupHeight": 98.45,
- "finalGroupHeight": 98.45
}
], - "totalInternalAppliedOverlapArea": 98.45,
- "totalExternalAppliedOverlapArea": 98.45,
- "totalInternalAppliedArea": 98.45,
- "totalExternalAppliedArea": 98.45,
- "totalAppliedOverlapArea": 98.45,
- "totalTargetFieldArea": 98.45,
- "totalNotAppliedArea": 98.45,
- "totalDistanceTraveled": 98.45,
- "totalAppliedArea": 98.45,
- "totalCroppedNotAppliedArea": 98.45,
- "totalAppliedOverdoseArea": 98.45,
- "totalCostByArea": 98.45,
- "totalCostByAppliedArea": 98.45,
- "totalCostByTargetFieldArea": 98.45,
- "totalCostByExternalAppliedArea": 98.45,
- "totalCostByInternalAppliedArea": 98.45,
- "totalCostByInternalAppliedOverlapArea": 98.45,
- "totalCostByExternalAppliedOverlapArea": 98.45,
- "displacementMargin": 147.67,
- "averageSampleRate": 2.58,
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
]
search application by id
applicationId required | string <uuid> Example: fa2a8bbd-5f1d-4012-a022-12a28f676057 unique application identification |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
{- "id": "fa2a8bbd-5f1d-4012-a022-12a28f676057",
- "season": {
- "id": "fe1e9d3c-18fa-4e31-86c1-38c33be1856c",
- "startedIn": "2024-05-27T22:52:44.903Z",
- "finishedIn": "2024-05-27T22:52:44.903Z",
- "crop": "cotton",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "status": "complete",
- "analysisMethod": "COMPLETE_TARGET",
- "applicationType": "aerial",
- "deletedReason": "wrong_application_data",
- "fields": [
- {
- "id": "52a22d4e-69bf-4b6a-9f7f-247ada19104c",
- "boundaries": "POLYGON ((-64.8000009 -6.7046461,-55.2000008 -10.0284011,-63.3600009 -15.6419963,-64.8000009 -6.7046461))",
- "area": 33.43,
- "totalTargetFieldArea": 234.43,
- "totalInternalAppliedArea": 234.43,
- "totalNotAppliedArea": 234.43,
- "totalInternalAppliedOverlapArea": 234.43,
- "totalAppliedOverdoseArea": 234.43,
- "averageUniformityScore": 234.43,
- "averageFailureScore": 234.43,
- "averageSuccessScore": 234.43,
- "field": {
- "id": "b48207a5-9408-4b92-b15f-6954b225c0b6",
- "name": "Field 01",
- "area": 33.43,
- "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
], - "schedules": [
- {
- "id": "ce75ce52-5064-485a-87a5-aa0f1ebe0c03",
- "status": "executed",
- "pilot": {
- "id": "d902bd61-6b7f-451e-970c-4576d1fbb238",
- "name": "John Due",
- "licenseId": "459439473",
- "aerialCompany": {
- "id": "134457d7-58d3-4247-9f67-3fa82b3a0535",
- "name": "Flight Company",
- "documentNumber": "00.000.000/0000-00",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "aircraft": {
- "id": "54e5221c-8a04-4f86-a558-d85b9210f0c9",
- "enrollmentId": "PT-FFG",
- "model": {
- "id": "07d9a0aa-eb71-451d-af05-de2a06d3d888",
- "name": "AT-401",
- "manufacturer": {
- "id": "ca824435-6ecc-4fcc-9ca1-53801a58790f",
- "name": "Air Tractor",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "aerialCompany": {
- "id": "134457d7-58d3-4247-9f67-3fa82b3a0535",
- "name": "Flight Company",
- "documentNumber": "00.000.000/0000-00",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "startedIn": "2024-05-27T22:52:44.903Z",
- "finishedIn": "2024-05-27T23:32:22.100Z",
- "runwayDistance": 10.4,
- "swathWidth": 28,
- "comments": "my application schedule comments",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
], - "logs": [
- {
- "id": "d8632348-fb7a-4133-a133-8076445bdade",
- "filename": "03062024.log",
- "status": "processed",
- "format": "satloc",
- "metadata": { },
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
], - "products": [
- {
- "id": "bac848b2-5137-4228-a61b-0d6a8e84b0a1",
- "dosage": 1.25,
- "amount": {
- "currency": "BRL",
- "value": 332.43
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
], - "serviceOrder": {
- "id": "4b6d7415-a029-457a-9901-cc66f76aded4",
- "slug": "OS-1234",
- "status": "complete",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "averageSuccessScore": 98.45,
- "averageFailureScore": 98.45,
- "averageUniformityScore": 98.45,
- "averageWasteScore": 98.45,
- "averageRateFlow": 98.45,
- "plannedAverageRateFlow": 98.45,
- "flowRateDataByGroup": [
- {
- "flowRateGroup": "1",
- "groupArea": 98.45,
- "groupPercentual": 98.45,
- "groupColor": "#FEF60D",
- "initialGroupRate": 98.45,
- "finalGroupRate": 98.45
}
], - "averageSpeed": 98.45,
- "averageHeight": 98.45,
- "plannedAverageHeight": 98.45,
- "heightDataByGroup": [
- {
- "heightGroup": "1",
- "groupArea": 98.45,
- "groupPercentual": 98.45,
- "groupColor": "#FEF60D",
- "initialGroupHeight": 98.45,
- "finalGroupHeight": 98.45
}
], - "totalInternalAppliedOverlapArea": 98.45,
- "totalExternalAppliedOverlapArea": 98.45,
- "totalInternalAppliedArea": 98.45,
- "totalExternalAppliedArea": 98.45,
- "totalAppliedOverlapArea": 98.45,
- "totalTargetFieldArea": 98.45,
- "totalNotAppliedArea": 98.45,
- "totalDistanceTraveled": 98.45,
- "totalAppliedArea": 98.45,
- "totalCroppedNotAppliedArea": 98.45,
- "totalAppliedOverdoseArea": 98.45,
- "totalCostByArea": 98.45,
- "totalCostByAppliedArea": 98.45,
- "totalCostByTargetFieldArea": 98.45,
- "totalCostByExternalAppliedArea": 98.45,
- "totalCostByInternalAppliedArea": 98.45,
- "totalCostByInternalAppliedOverlapArea": 98.45,
- "totalCostByExternalAppliedOverlapArea": 98.45,
- "displacementMargin": 147.67,
- "averageSampleRate": 2.58,
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
create a new product
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
alias required | string product alias |
manufacturerName | string or null Default: "Unknown" name of the manufacturer of the product |
productId | string or null <uuid> unique identifier of the suggested product, this field must be filled in when the new product registration is associated with a suggested product. |
code | integer or null custom product code |
classType | string (ProductClassTypeEnum) Default: "unknown" Enum: "unknown" "ripener" "adjuvant" "insecticide" "acaricide" "fungicide" "nematicide" "herbicide" "bactericide" "biological" "adulticide" "foliar_nutrition" "larvicide" "fertilizer" "phytohormone" "ant_killer" "seeding" "microbiological" "plant_activator" "termiticide" "pheromone" "plant_growth_regulator" "molluscicide" "seed_protectant" "biological_control_agent" "acaricide_bactericide_fungicide" "acaricide_ant_killer_insecticide" "acaricide_fungicide" "acaricide_fungicide_insecticide" "acaricide_insecticide" "acaricide_insecticide_nematicide" "acaricide_microbiological" "acaricide_microbiological_insecticide_microbiological" "bactericide_fungicide" "bactericide_microbiological_fungicide_microbiological" "termiticide_ant_killer_insecticide" "termiticide_insecticide" "pheromone_insecticide" "ant_killer_fungicide_herbicide_insecticide_nematicide" "ant_killer_fungicide_herbicide_nematicide" "ant_killer_insecticide" "fungicide_nematicide" "fungicide_nematicide_microbiological" "fungicide_herbicide_nematicide" "fungicide_insecticide" "fungicide_insecticide_nematicide" "fungicide_microbiological" "fungicide_microbiological_nematicide_microbiological" "herbicide_plant_growth_regulator" "insecticide_plant_growth_regulator" "fumigant_insecticide" "insecticide_microbiological" "insecticide_nematicide" "nematicide_microbiological" product class type |
measurementUnit required | string (MeasurementUnitEnum) Enum: "l" "ha" "ac" "m" "kg" "km" "°" "°c" "°f" "mm" "%" measurement unit |
object (AmountDto) |
{- "alias": "My Product Example",
- "manufacturerName": "Manufacturer Example",
- "productId": "efae9cea-767f-4d28-a4e6-891ee7b0e998",
- "code": 946749,
- "classType": "fungicide",
- "measurementUnit": "l",
- "amount": {
- "currency": "BRL",
- "value": 332.43
}
}
{- "id": "efae9cea-767f-4d28-a4e6-891ee7b0e998",
- "amount": {
- "currency": "BRL",
- "value": 332.43
}, - "code": 946749,
- "alias": "My Product Example",
- "manufacturerName": "Manufacturer Example",
- "classType": "fungicide",
- "measurementUnit": "l",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z"
}
search all products
withDeleted | boolean (WithDeletedQueryParameter) Default: false Example: withDeleted=true include deleted products |
manufacturerName | string Example: manufacturerName=Manufacturer Example product manufacturer name |
alias | string Example: alias=My Custom Product product alias |
code | integer or null Example: code=2932493 custom product code |
classType | string (ProductClassTypeEnum) Default: "unknown" Enum: "unknown" "ripener" "adjuvant" "insecticide" "acaricide" "fungicide" "nematicide" "herbicide" "bactericide" "biological" "adulticide" "foliar_nutrition" "larvicide" "fertilizer" "phytohormone" "ant_killer" "seeding" "microbiological" "plant_activator" "termiticide" "pheromone" "plant_growth_regulator" "molluscicide" "seed_protectant" "biological_control_agent" "acaricide_bactericide_fungicide" "acaricide_ant_killer_insecticide" "acaricide_fungicide" "acaricide_fungicide_insecticide" "acaricide_insecticide" "acaricide_insecticide_nematicide" "acaricide_microbiological" "acaricide_microbiological_insecticide_microbiological" "bactericide_fungicide" "bactericide_microbiological_fungicide_microbiological" "termiticide_ant_killer_insecticide" "termiticide_insecticide" "pheromone_insecticide" "ant_killer_fungicide_herbicide_insecticide_nematicide" "ant_killer_fungicide_herbicide_nematicide" "ant_killer_insecticide" "fungicide_nematicide" "fungicide_nematicide_microbiological" "fungicide_herbicide_nematicide" "fungicide_insecticide" "fungicide_insecticide_nematicide" "fungicide_microbiological" "fungicide_microbiological_nematicide_microbiological" "herbicide_plant_growth_regulator" "insecticide_plant_growth_regulator" "fumigant_insecticide" "insecticide_microbiological" "insecticide_nematicide" "nematicide_microbiological" Example: classType=fungicide product class type |
page | integer <int32> (PageQueryParameter) Default: 1 Example: page=2 current page number |
pageSize | integer <int32> (PageSizeQueryParameter) Default: 10 Example: pageSize=20 number of products per page |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
[- {
- "id": "efae9cea-767f-4d28-a4e6-891ee7b0e998",
- "amount": {
- "currency": "BRL",
- "value": 332.43
}, - "code": 946749,
- "alias": "Product Alias Example",
- "manufacturerName": "Manufacturer Example",
- "classType": "fungicide",
- "measurementUnit": "l",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
]
create a new season
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
startedIn required | string <date-time> timestamp in RFC 3339 format (UTC) in which the season was started |
finishedIn required | string <date-time> timestamp in RFC 3339 format (UTC) in which the season was finished |
crop required | string (CropEnum) Enum: "unknown" "cotton" "corn" "avocado" "bean" "brachiaria" "cereals" "citrus" "cocoa" "coconut" "coffee" "eucalyptus" "grape" "oat" "orange" "peanut" "pineapple" "potato" "rice" "soybean" "sugarcane" "sunflower" "wheat" "sunn_hemp" "pearl_millet" "sorghum" "stylosanthes" "cover" "millet" "banana" "tobacco" "sesame" "seed_corn" crop type |
{- "startedIn": "2024-05-27T22:52:44.903Z",
- "finishedIn": "2024-05-27T22:52:44.903Z",
- "crop": "cotton"
}
{- "id": "fe1e9d3c-18fa-4e31-86c1-38c33be1856c",
- "startedIn": "2024-05-27T22:52:44.903Z",
- "finishedIn": "2024-05-27T22:52:44.903Z",
- "crop": "cotton",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z"
}
search all seasons
withDeleted | boolean (WithDeletedQueryParameter) Default: false Example: withDeleted=true include deleted seasons |
page | integer <int32> (PageQueryParameter) Default: 1 Example: page=2 current page number |
pageSize | integer <int32> (PageSizeQueryParameter) Default: 10 Example: pageSize=20 number of seasons per page |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
[- {
- "id": "fe1e9d3c-18fa-4e31-86c1-38c33be1856c",
- "startedIn": "2024-05-27T22:52:44.903Z",
- "finishedIn": "2024-05-27T22:52:44.903Z",
- "crop": "cotton",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
]
search season by id
seasonId required | string <uuid> Example: 3ffa8c69-cc87-46b6-b824-e62feb97f237 unique season identification |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
{- "id": "fe1e9d3c-18fa-4e31-86c1-38c33be1856c",
- "startedIn": "2024-05-27T22:52:44.903Z",
- "finishedIn": "2024-05-27T22:52:44.903Z",
- "crop": "cotton",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
search all aircrafts
withDeleted | boolean (WithDeletedQueryParameter) Default: false Example: withDeleted=true include deleted aircrafts |
page | integer <int32> (PageQueryParameter) Default: 1 Example: page=2 current page number |
pageSize | integer <int32> (PageSizeQueryParameter) Default: 10 Example: pageSize=20 number of aircrafts per page |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
[- {
- "id": "54e5221c-8a04-4f86-a558-d85b9210f0c9",
- "enrollmentId": "PT-FFG",
- "model": {
- "id": "07d9a0aa-eb71-451d-af05-de2a06d3d888",
- "name": "AT-401",
- "manufacturer": {
- "id": "ca824435-6ecc-4fcc-9ca1-53801a58790f",
- "name": "Air Tractor",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "aerialCompany": {
- "id": "134457d7-58d3-4247-9f67-3fa82b3a0535",
- "name": "Flight Company",
- "documentNumber": "00.000.000/0000-00",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
]
search all pilots
withDeleted | boolean (WithDeletedQueryParameter) Default: false Example: withDeleted=true include deleted pilots |
page | integer <int32> (PageQueryParameter) Default: 1 Example: page=2 current page number |
pageSize | integer <int32> (PageSizeQueryParameter) Default: 10 Example: pageSize=20 number of pilots per page |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
[- {
- "id": "d902bd61-6b7f-451e-970c-4576d1fbb238",
- "name": "John Due",
- "licenseId": "459439473",
- "aerialCompany": {
- "id": "134457d7-58d3-4247-9f67-3fa82b3a0535",
- "name": "Flight Company",
- "documentNumber": "00.000.000/0000-00",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}, - "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
]
search all suggested products
name | string or null Example: name=Suggested Product Example suggested product name |
classType | string (ProductClassTypeEnum) Default: "unknown" Enum: "unknown" "ripener" "adjuvant" "insecticide" "acaricide" "fungicide" "nematicide" "herbicide" "bactericide" "biological" "adulticide" "foliar_nutrition" "larvicide" "fertilizer" "phytohormone" "ant_killer" "seeding" "microbiological" "plant_activator" "termiticide" "pheromone" "plant_growth_regulator" "molluscicide" "seed_protectant" "biological_control_agent" "acaricide_bactericide_fungicide" "acaricide_ant_killer_insecticide" "acaricide_fungicide" "acaricide_fungicide_insecticide" "acaricide_insecticide" "acaricide_insecticide_nematicide" "acaricide_microbiological" "acaricide_microbiological_insecticide_microbiological" "bactericide_fungicide" "bactericide_microbiological_fungicide_microbiological" "termiticide_ant_killer_insecticide" "termiticide_insecticide" "pheromone_insecticide" "ant_killer_fungicide_herbicide_insecticide_nematicide" "ant_killer_fungicide_herbicide_nematicide" "ant_killer_insecticide" "fungicide_nematicide" "fungicide_nematicide_microbiological" "fungicide_herbicide_nematicide" "fungicide_insecticide" "fungicide_insecticide_nematicide" "fungicide_microbiological" "fungicide_microbiological_nematicide_microbiological" "herbicide_plant_growth_regulator" "insecticide_plant_growth_regulator" "fumigant_insecticide" "insecticide_microbiological" "insecticide_nematicide" "nematicide_microbiological" Example: classType=fungicide suggested product class type |
withDeleted | boolean (WithDeletedQueryParameter) Default: false Example: withDeleted=true include deleted suggested products |
page | integer <int32> (PageQueryParameter) Default: 1 Example: page=2 current page number |
pageSize | integer <int32> (PageSizeQueryParameter) Default: 10 Example: pageSize=20 number of suggested products per page |
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
[- {
- "id": "efae9cea-767f-4d28-a4e6-891ee7b0e998",
- "name": "Suggested Product Example",
- "manufacturerName": "Manufacturer Example",
- "classType": "fungicide",
- "serviceType": "pesticide_application",
- "measurementUnit": "l",
- "createdAt": "2024-05-27T22:52:44.903Z",
- "updatedAt": "2024-05-27T22:55:44.903Z",
- "deletedAt": "2024-05-27T22:59:44.903Z"
}
]
create a new pre flight
x-pf-correlation-id | string <uuid> (CorrelationHeader) Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1 correlation identifier between request and response |
slug | string or null Default: "OS-XXXXXXXXXX" service order identification |
observation | string or null pre flight observation |
preFlightSeasonId | string <uuid> unique pre flight season identification |
preFlightPilot | Array of strings <uuid> (PilotId) >= 0 items unique [ items <uuid > ] pilots of pre flight |
preFlightAircraft | Array of strings <uuid> (AircraftId) >= 0 items unique [ items <uuid > ] aircrafts of pre flight |
preFlightTractor | Array of strings <uuid> (TractorId) >= 0 items unique [ items <uuid > ] tractors of pre flight |
Array of objects (CreatePreFlightFieldDto) >= 0 items unique fields of pre flight | |
Array of objects (CreatePreFlightProductDto) >= 0 items unique products of pre flight | |
Array of objects (CreatePreFlightRestrictionFieldDto) >= 0 items unique restriction fields of pre flight |
{- "slug": "OS-1234567899",
- "observation": "my pre flight comments",
- "preFlightSeasonId": "134457d7-58d3-4247-9f67-3fa82b3a0535",
- "preFlightPilot": [
- "d902bd61-6b7f-451e-970c-4576d1fbb238"
], - "preFlightAircraft": [
- "54e5221c-8a04-4f86-a558-d85b9210f0c9"
], - "preFlightTractor": [
- "771bc011-22b9-439a-b0b4-0e7ffe3cc93e"
], - "preFlightField": [
- {
- "fieldId": "917bfcf8-8dbb-4e68-b4a5-f1e960669b14",
- "boundaries": "POLYGON ((-56.1736668 -15.5591935,-56.1731188 -15.5592036,-56.1731971 -15.5595204,-56.1737295 -15.5594852,-56.1736668 -15.5591935))"
}
], - "preFlightProduct": [
- {
- "customerProductId": "d902bd61-6b7f-451e-970c-4576d1fbb238",
- "dosage": 3.54
}
], - "preFlightRestrictionField": [
- {
- "restrictionFieldId": "d902bd61-6b7f-451e-970c-4576d1fbb238",
- "warningDistance": 32.54
}
]
}
{- "slug": "OS-1234567899"
}