Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
extract
v1

Percent Usage List

GET params:

  • document_id: int
  • unit_type: str
  • amount_search: float
get/api/v1/extract/percent-usage/

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

amountnumber nullable
unit_typestring required
totalnumber nullable
countinteger
pkinteger
text_unit__pkstring
text_unit__unit_typestring
text_unit__location_startstring
text_unit__location_endstring
text_unit__document__pkstring
text_unit__document__namestring
text_unit__document__descriptionstring
text_unit__document__document_typestring

Example response

[
  {
    "amount": 0.8008281904610115,
    "text_unit__document__description": "text_unit__document__description",
    "text_unit__location_end": "text_unit__location_end",
    "text_unit__document__pk": "text_unit__document__pk",
    "count": -1517921766,
    "unit_type": "unit_type",
    "text_unit__unit_type": "text_unit__unit_type",
    "text_unit__document__name": "text_unit__document__name",
    "text_unit__document__document_type": "text_unit__document__document_type",
    "total": 6.027456183070403,
    "text_unit__pk": "text_unit__pk",
    "pk": 5,
    "text_unit__location_start": "text_unit__location_start"
  }
]