dump

v1

GET /api/v1/dump/document-config/

Changed on May 24, 2021

Dump document types, fields, field detectors and document filters to json.

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/dump/document-config/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

downloadboolean

Download as file

document_type_codesstring

Document Type codes separated by comma

Response

object[] required

OR

string binary required

Json file with dumped fixture

Changes

May 24, 20218167164be9cc Revision changes
- breaking
  response body list-of-types was widened by adding types array and string to media type application/json of response 200
- info
  added the new optional query request parameter document_type_codes
- info
  added the new optional query request parameter download
Dec 11, 20200957c4a7ae3d Revision changes
- breaking
  response body list-of-types was widened by adding types object to media type application/json of response 200
- warning
  deleted the query request parameter document_type_codes
- warning
  deleted the query request parameter download

Operation history