API docs by Redocly

Perfect Flight - API Reference (1.0.0)

Download OpenAPI specification:Download

Perfect Flight: developer@perfectflightapp.com URL: https://www.perfectflight.com.br/en/contact

farm

create a new farm

create a new farm

Authorizations:
auth
header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Request Body schema: application/json
required
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).

Responses

Request samples

Content type
application/json
{
  • "name": "My Farm",
  • "namespace": "Farms",
  • "parentFarmId": "bfc780ae-3873-4caf-92d3-9b7ae4ea2a57"
}

Response samples

Content type
application/json
{
  • "id": "20f94ebe-361b-44e6-9729-57d744d04b27",
  • "name": "My Farm",
  • "namespace": "Farms",
  • "createdAt": "2024-05-27T22:52:44.903Z"
}

search all farms

search all farms

Authorizations:
auth
query Parameters
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

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

search farm by id

search farm by id

Authorizations:
auth
path Parameters
farmId
required
string <uuid>
Example: c17ebf24-e2bd-4c83-88fc-f2c8b0e43883

unique farm identification

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "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

search all fields by farm id

Authorizations:
auth
path Parameters
farmId
required
string <uuid>

unique farm identification

query Parameters
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

Responses

field

search all fields

search all fields

Authorizations:
auth
query Parameters
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

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

search field by id

search field by id

Authorizations:
auth
path Parameters
fieldId
required
string <uuid>
Example: ecafbb6f-c7b4-43d6-bf54-5f7dd98d8377

unique field identification

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "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"
}

application

search all applications

search all applications

Authorizations:
auth
query Parameters
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"
Example: crop=cotton

season crop

pilotId
string <uuid>
Example: pilotId=64ca523b-5d08-4016-a174-e87b74118742

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

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

search application by id

search application by id

Authorizations:
auth
path Parameters
applicationId
required
string <uuid>
Example: fa2a8bbd-5f1d-4012-a022-12a28f676057

unique application identification

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "id": "fa2a8bbd-5f1d-4012-a022-12a28f676057",
  • "season": {
    },
  • "status": "complete",
  • "analysisMethod": "COMPLETE_TARGET",
  • "applicationType": "aerial",
  • "deletedReason": "wrong_application_data",
  • "fields": [
    ],
  • "schedules": [
    ],
  • "logs": [
    ],
  • "products": [
    ],
  • "serviceOrder": {
    },
  • "averageSuccessScore": 98.45,
  • "averageFailureScore": 98.45,
  • "averageUniformityScore": 98.45,
  • "averageWasteScore": 98.45,
  • "averageRateFlow": 98.45,
  • "plannedAverageRateFlow": 98.45,
  • "flowRateDataByGroup": [
    ],
  • "averageSpeed": 98.45,
  • "averageHeight": 98.45,
  • "plannedAverageHeight": 98.45,
  • "heightDataByGroup": [
    ],
  • "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,
  • "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"
}

season

search all seasons

search all seasons

Authorizations:
auth
query Parameters
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

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

search season by id

search season by id

Authorizations:
auth
path Parameters
seasonId
required
string <uuid>
Example: 3ffa8c69-cc87-46b6-b824-e62feb97f237

unique season identification

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
{
  • "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"
}

aircraft

search all aircrafts

search all aircrafts

Authorizations:
auth
query Parameters
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

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
[
  • {
    }
]

pilot

search all pilots

search all pilots

Authorizations:
auth
query Parameters
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

header Parameters
x-pf-correlation-id
string <uuid> (CorrelationHeader)
Example: d5de0545-a36b-4c9d-b0cd-4e6e8a523bf1

correlation identifier between request and response

Responses

Response samples

Content type
application/json
[
  • {
    }
]