Takeoffs

Accept, reject or override an item (extraction stays immutable)

patch/takeoffs/{takeoff_id}/items/{item_id}

Request

  • Base URL: https://api.aginera.ai/partner/v1
  • URL: https://api.aginera.ai/partner/v1/takeoffs/{takeoff_id}/items/{item_id}
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.aginera.ai/oauth/authorize, token URL https://auth.aginera.ai/oauth/token; client credentials, token URL https://login.microsoftonline.com/65f567a9-6e6a-4f81-863c-aea4ece1f8eb/oauth2/v2.0/token, scopes: takeoffs:review)

Path parameters

takeoff_idstring required
Example:tko_4kR9sT2vWx7yZa1bCd3eFg
item_idstring required
Example:itm_4kR9sT2vWx7yZa1bCd3eFg

Request body

review_status'accepted' | 'rejected' | 'modified'
quantity_overridenumber nullable
notestring

Response

OK

idstring required
takeoff_idstring required
group_idstring nullable
descriptionstring required
trade'electrical' | 'mechanical' | 'plumbing' | 'fire_protection' | 'structural' | 'architectural' | 'civil' | 'process' | 'other' required
categorystring required
item_typestring required
measure_type'count' | 'length' | 'area' | 'volume' | 'weight' | 'time' required
extracted_quantitynumber required
quantity_overridenumber nullable required
effective_quantitynumber required
unitstring required

Canonical unit code from /reference/units (extensible; not a closed enum). Examples EA, LF, FT, IN, SF, SY, CF, CY, LB, TON, HR, GAL, M, MM, M2, M3, KG, T, L, LS.

tagstring nullable required
attributesobject required
page_numberinteger required
confidence'high' | 'medium' | 'low' required
review_status'extracted' | 'accepted' | 'rejected' | 'modified' required
source'plan' | 'schedule' | 'legend' | 'manual' required
notestring nullable required

Example response

{
  "id": "itm_4kR9sT2vWx7yZa1bCd3eFg",
  "takeoff_id": "tko_4kR9sT2vWx7yZa1bCd3eFg",
  "unit": "LF",
  "geometry": {
    "scale": {
      "unit": "LF"
    }
  }
}

Changes

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