Request a boundary be normalized. Does not automatically create a reporting unit.

post/boundary

Request

Base URL
https://app.chloris.earth/api
Auth
HTTP bearer
TypeScript
https://skmtc.dev/chloris/apis/chloris-platform-api/docs/boundary/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

organizationIdstring

organization ID

uploadIdstring

Optional identifier for this upload, can be any alphanumeric (plus dash) string up to 64 characters. If not provided, a random UUID7 will be used.

uploadPathstring

Path to the boundary file upload, may be a http(s) or S3 path. If upload is a multi-file shapefile, only the .shp file is required.

excludeGeojsonPathstring

Path to a normalized geojson boundary that should be excluded from the first. Recommended when uploading a control boundary to prevent overlaps.

Example request

{
  "organizationId": "12341234-1234-1234-1234-123412341234",
  "uploadId": "abcd1234",
  "uploadPath": "https://example.com/path/to/geojson",
  "excludeGeojsonPath": "s3://path/to/geojson"
}

Response

Success

uploadIdstring

The upload ID

Example response

{
  "uploadId": "abcd1234"
}

Changes

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