Fields

Retrieve a specific Field by ID

Retrieve a given Field by ID.

get/v4/fields/{fieldId}

Request

Base URL
https://platform.climate.com
Auth
- API key in header X-Api-Key
- or OAuth 2
  Authorization codehttps://climate.com/static/app-login/
  Token URLhttps://api.climate.com/api/oauth/token
  Scopesplatform, fields:read
TypeScript
https://skmtc.dev/fieldview/apis/climate-fieldview-platform-apis/docs/v4/fields/:fieldId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

fieldIdstring uuid required

Unique identifier of the Field.

Response

Returns the requested Field.

idstring uuid required

Unique identifier for a Field.

namestring required

Name of the Field.

boundaryIdstring uuid required

Unique identifier for the current Field's Boundary.

resourceOwnerIdstring uuid required

Unique identifier of the resource owner that owns the Field.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Back Forty",
  "boundaryId": "00000000-0000-0000-0000-000000000000",
  "resourceOwnerId": "00000000-0000-0000-0000-000000000000",
  "parent": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "farm"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.