v1

latestOpenAPI 3.0.02026-07-132849114.2 KB

Fields

Retrieve a specific Field by ID

Retrieve a given Field by ID.

get/v4/fields/{fieldId}

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"
  }
}