Carbon

Balloon

The balloon resource.

Basehttps://rest.carbon.ms/balloon
GET/balloon

List balloons

Retrieve a paginated list of balloons. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/balloon
curl --request GET \
  --url 'https://rest.carbon.ms/balloon?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "inspectionDocumentId": "xyz789",
    "inspectionFeatureId": "xyz789",
    "pageNumber": 0,
    "regionX": 0,
    "regionY": 0,
    "regionWidth": 0
  }
]
GET/balloon

Retrieve a balloon

Fetch a single balloon by filtering on `id`.

Query parameters

idstring

Match on the balloon's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/balloon
curl --request GET \
  --url 'https://rest.carbon.ms/balloon?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "inspectionDocumentId": "xyz789",
  "inspectionFeatureId": "xyz789",
  "pageNumber": 0,
  "regionX": 0,
  "regionY": 0,
  "regionWidth": 0
}
POST/balloon

Create a balloon

Create a new balloon.

Body parameters

inspectionDocumentIdstringrequired
inspectionFeatureIdstringrequired
pageNumbernumberrequired
regionXnumberrequired
regionYnumberrequired
regionWidthnumberrequired
regionHeightnumberrequired
xCoordinatenumberrequired
yCoordinatenumberrequired
POSThttps://rest.carbon.ms/balloon
curl --request POST \
  --url https://rest.carbon.ms/balloon \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inspectionDocumentId":"xyz789","inspectionFeatureId":"xyz789","pageNumber":0,"regionX":0,"regionY":0,"regionWidth":0,"regionHeight":0,"xCoordinate":0,"yCoordinate":0}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "inspectionDocumentId": "xyz789",
  "inspectionFeatureId": "xyz789",
  "pageNumber": 0,
  "regionX": 0,
  "regionY": 0,
  "regionWidth": 0
}
PATCH/balloon

Update a balloon

Update an existing balloon, matched on `id`.

Body parameters

inspectionDocumentIdstringrequired
inspectionFeatureIdstringrequired
pageNumbernumberrequired
regionXnumberrequired
regionYnumberrequired
regionWidthnumberrequired
regionHeightnumberrequired
xCoordinatenumberrequired
yCoordinatenumberrequired
PATCHhttps://rest.carbon.ms/balloon
curl --request PATCH \
  --url 'https://rest.carbon.ms/balloon?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inspectionDocumentId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "inspectionDocumentId": "xyz789",
  "inspectionFeatureId": "xyz789",
  "pageNumber": 0,
  "regionX": 0,
  "regionY": 0,
  "regionWidth": 0
}
DELETE/balloon

Delete a balloon

Delete a balloon, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the balloon to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/balloon
curl --request DELETE \
  --url 'https://rest.carbon.ms/balloon?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content