document

GET /api/v1/document/document-field-values/{id}/

Document Field Value Details

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/document/document-field-values/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

A unique integer value identifying this field value.

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

pkinteger

project_idinteger

projectstring

document_idstring

document_namestring

document_statusstring

field_idstring

field_namestring

valueobject nullable

python_valuestring

location_textstring

modified_by_usernamestring

modified_by_idstring

modified_datestring date-time

Example response

{
  "field_id": "field_id",
  "project": "project",
  "modified_by_id": "modified_by_id",
  "document_id": "document_id",
  "modified_date": "2000-01-23T04:56:07.000+00:00",
  "field_name": "field_name",
  "python_value": "python_value",
  "document_name": "document_name",
  "modified_by_username": "modified_by_username",
  "project_id": 6,
  "document_status": "document_status",
  "pk": 0,
  "value": "{}",
  "location_text": "location_text"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.