Get apiv1extractcopyright usage — contraxsuite-api

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB

extract

GET params:

document_id: int
text_unit_id: int
copyright: str
copyright_contains: str

get/api/v1/extract/copyright-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

copyright_strstring required

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

[
  {
    "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": -1803530559,
    "text_unit__pk": "text_unit__pk",
    "pk": 6,
    "copyright_str": "copyright_str",
    "text_unit__unit_type": "text_unit__unit_type",
    "text_unit__location_start": "text_unit__location_start",
    "text_unit__document__name": "text_unit__document__name",
    "text_unit__document__document_type": "text_unit__document__document_type"
  }
]