v1

latestOpenAPI 3.0.02026-07-132849114.2 KB

Layers

Retrieve individual scouting observation

Retrieve an individual scouting observation by id. Ids are retrieved via the /layers/scoutingObservations route.

get/v4/layers/scoutingObservations/{scoutingObservationId}

Path parameters

scoutingObservationIdstring uuid required

Unique identifier of the Scouting Observation.

Response

Returns the requested scouting observation.

idstring uuid required

The id of a scouting observation.

titlestring required

The title or summary of the scouting observation. 40 Characters long, no emojis, and leading and trailing whitespace will be trimmed.

notestring required

The text of the scouting observation. Maximum of 4000 characters.

startTimestring date-time required

The start time of the scouting observation. Time in ISO 8601 format with UTC timezone, 3 fractional seconds (https://tools.ietf.org/html/rfc3339).

endTimestring date-time required

The start time of the scouting observation. Time in ISO 8601 format with UTC timezone, 3 fractional seconds (https://tools.ietf.org/html/rfc3339).

updatedAtstring date-time required

The time the scouting observation or any of its attachments was last updated.Time in ISO 8601 format with UTC timezone, 3 fractional seconds. (https://tools.ietf.org/html/rfc3339).

fieldIdsstring[] required

Array of field ids associated with this observation.

timespan'PERMANENT' | 'SEASONAL' required

Permanent or seasonal

locationDisplayColor'#307af7' | '#38d753' | '#b037e4' | '#ef3e3e' | '#f7ec41' | '#ff8439' | '#808080' required

Color of scouting pin assigned in the Climate FieldView app. Limited in the Ux to a set of RGB values.

#307af7
#38d753
#b037e4
#ef3e3e
#f7ec41
#ff8439
#808080

status'ACTIVE' | 'DELETED' required

The status of the scouting observation For example : ACTIVE, DELETED

Example response

{
  "location": {
    "type": "Point",
    "coordinates": [
      0,
      0
    ]
  }
}