v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
analyze
v1

get Similarity Run object

get/api/v1/analyze/similarity-runs/{id}/

Path parameters

idstring required

A unique integer value identifying this similarity run.

Query parameters

unit_sourcestring

document / text_unit

project_idinteger

Project ID

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

idinteger
project_idstring
feature_sourcestring nullable
unit_sourcestring nullable
unit_typestring nullable
unit_idinteger nullable
items_countinteger required
created_byinteger nullable
created_datestring date-time

Example response

{
  "items_count": 1,
  "project_id": "project_id",
  "feature_source": "feature_source",
  "unit_source": "unit_source",
  "id": 0,
  "created_date": "2000-01-23T04:56:07.000+00:00",
  "unit_type": "unit_type",
  "unit_id": 441289069,
  "created_by": 5
}