The extraction template overlay

GET

/v1/extraction-templates

const url = 'http://localhost:8080/v1/extraction-templates';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/v1/extraction-templates

Returns the saved overlay ({ docTypes: [...] }, empty when none) and the document types the engine understands built-in. Overlay rules run before the built-ins, so a bank’s own layout of a known type; or a new family mapped to a taxonomy code; extracts without a code change. Administrators only.

Responses

200

application/json

The template studio’s read view: the saved overlay (empty object when none) and what the engine already knows built-in.

object

overlay

required

builtInDocTypes

required

Array<string>

Example^generated

{
  "overlay": "example",
  "builtInDocTypes": [
    "example"
  ]
}

The extraction template overlay

Responses

200

Examplegenerated

Example^generated