API

delete

Deletes an apikey for current user. Only available in SERVER mode.

Path parameters

userIdstringrequired

user identifier

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/key/{userId}'

204

204

No body

when key has been deleted

get

Get the private key for an existing user. Only available in SERVER mode.

Path parameters

userIdstringrequired

user identifier

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/key/{userId}'

200

200

{
  "hashedKey": "c3e7766f7605659f2b97f2a6f5bcf34611997fc31173931eefcea91df1b465ffe35c2b9b4b91e8bbe2eec3730ce2a74a"
}

returns the hashed key JSON

options

Preflight for key management

Path parameters

userIdstringrequired

user identifier

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/key/{userId}'

200

200

No body

returns OPTIONS, GET, PUT and DELETE

put

Creates a new private key and saves its SHA384 hash into database for current user. Only available in SERVER mode.

Path parameters

userIdstringrequired

user identifier

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/key/{userId}'

201

201

{
  "apiKey": "SrcasvUmaAD6NsZ3+VmUkFFWVfRggIRNmWR5aHx7Kfc="
}

returns the api key JSON

delete

Deletes batch searches and results for the current user.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/batch/search'

204

204

No body

no content: idempotent

get

Retrieves the list of batch searches

Query parameters

querystringoptional

'freetext' search filter. Empty string or '' to select all. Default is ''

fieldstringoptional

specifies field on query filter ('all','author'...). Default is 'all'

queriesstringoptional

list of selected queries in the batch search (to invert selection put 'queriesExcluded' parameter to true)

queriesExcludedstringoptional

Associated with 'queries', if true it excludes the listed queries from the results

contentTypesstringoptional

filters by contentTypes

projectstringoptional

filters by projects. Empty array corresponds to no projects

batchDatestringoptional

filters by date range timestamps with [dateStart, dateEnd]

statestringoptional

filters by task status (RUNNING, QUEUED, DONE, FAILED)

publishStatestringoptional

filters by published state (0: private to the user, 1: public on the platform)

withQueriesstringoptional

boolean, if true it includes list of queries

sizestringoptional

if not provided default is 100

fromstringoptional

if not provided it starts from 0

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/batch/search'

default

default

{
  "items": [],
  "pagination": {
    "count": 1,
    "from": 1,
    "size": 1,
    "total": 1
  }
}

default response

options

Preflight request

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/batch/search'

200

200

No body

returns 200 with DELETE

post

Retrieves the batch search list for the user issuing the request filter with the given criteria, and the total of batch searches matching the criteria.

If from/size are not given their default values are 0, meaning that all the results are returned. BatchDate must be a list of 2 items (the first one for the starting date and the second one for the ending date) If defined publishState is a string equals to "0" or "1"

Body

sizeinteger · int32optional

frominteger · int32optional

sortstringoptional

orderstring · enumoptional

Available options:

querystringoptional

fieldstringoptional

queriesstring[]optional

projectobject[]optional

batchDatestring[]optional

statestring[]optional

publishStatestringoptional

withQueriesbooleanoptional

queriesExcludedbooleanoptional

contentTypesstring[]optional

sortedbooleanoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/batch/search' \
  --header 'Content-Type: */*' \
  --data '{
    "size": 1,
    "from": 1,
    "sort": "text",
    "order": "ASC",
    "query": "text",
    "field": "text",
    "queries": [
      "text"
    ],
    "project": [],
    "batchDate": [
      "text"
    ],
    "state": [
      "text"
    ],
    "publishState": "text",
    "withQueries": true,
    "queriesExcluded": true,
    "contentTypes": [
      "text"
    ],
    "sorted": true
  }'

200

200

{
  "items": [],
  "pagination": {
    "count": 1,
    "from": 1,
    "size": 1,
    "total": 1
  }
}

the list of batch searches with the total batch searches for the query

get

Retrieves the results of a batch search as an attached CSV file.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/batch/search/result/csv/{batchid}'

200

200

No body

returns the results of the batch search as CSV attached file.

delete

Deletes a batch search and its results with the given id. It won't delete running batch searches, because results would be orphans.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/batch/search/{batchid}'

204

204

No body

Returns 204 (No Content) : idempotent

get

Retrieves the batch search with the given id. The query param "withQueries" accepts a boolean value.When "withQueries" is set to false, the list of queries is empty and nbQueries contains the number of queries.

Path parameters

batchIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/batch/search/{batchid}'

200

404

200

{
  "uuid": "text",
  "published": true,
  "name": "text",
  "description": "text",
  "user": null,
  "state": "QUEUED",
  "date": "2025-03-31T13:44:51.603Z",
  "nbQueries": 1,
  "nbResults": 1,
  "errorMessage": "text",
  "errorQuery": "text",
  "queries": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "fileTypes": [
    "text"
  ],
  "paths": [
    "text"
  ],
  "fuzziness": 1,
  "phraseMatches": true,
  "queryTemplate": {
    "query": "text"
  },
  "projects": [
    "text"
  ]
}

options

Preflight request

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/batch/search/{batchid}'

200

200

No body

returns 200 with DELETE

get

Retrieves the batch search queries with the given batch id and returns a list of strings UTF-8 encoded

Path parameters

batchIdstringrequired

identifier of the batch search

Query parameters

fromstringoptional

if not provided it starts from 0

sizestringoptional

if not provided all queries are returned from the "from" parameter

formatstringoptional

if set to csv, it answers with content-disposition attachment (file downloading)

searchstringoptional

if provided it will filter the queries accordingly

orderBystringoptional

field name to order by asc, "query_number" by default (if it does not exist it will return a 500 error)

maxResultstringoptional

number of maximum results for each returned query (-1 means no maxResults)

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/batch/search/{batchid}/queries'

200

200

No body

the batch search queries map [(query, nbResults), ...]

get

Retrieves the list of starred document for all projects for the current user.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/documents/starred'

default

default

[]

default response

get

Retrieves the list of users who recommended a document with the total count of recommended documents for the given project id

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/users/recommendations?project={project}'

default

default

{
  "aggregates": [],
  "totalCount": 1
}

default response

get

Gets all users who recommended a document with the count of all recommended documents for project and documents ids.

Query parameters

projectstringoptional

docIdsstringoptional

comma separated document ids

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/users/recommendationsby?project={project}&docIds={coma_separated_docIds}'

default

default

{
  "aggregates": [],
  "totalCount": 1
}

default response

get

Retrieves the list of tagged documents for a given project id filtered by a given string of coma-separated list of tags.

Path parameters

projectstringrequired

the project id

comaSeparatedTagsstringrequired

comma separated tags

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{projects}/documents/tagged/{coma_separated_tags}'

default

default

[
  "text"
]

default response

get

Retrieves the set of recommended documents for the given project id and a list of users

Path parameters

projectstringrequired

Query parameters

useridsstringoptional

comma separated users

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{project}/documents/recommendations?userids={coma_separated_users}'

default

default

[
  "text"
]

default response

get

Retrieves the list of starred documents for a given project.

Path parameters

projectstringrequired

the project id

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{project}/documents/starred'

default

default

[
  "text"
]

default response

get

Gets tags by document id

Path parameters

projectstringrequired

the project id

docIdstringrequired

document id

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{project}/documents/tags/{docId}'

default

default

[]

default response

options

Preflight request for document tagging

Path parameters

projectstringrequired

the project id

docIdstringrequired

document id

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/{project}/documents/tags/{docId}'

200

200

No body

returns 200 with PUT

options

Preflight request for document untagging

Path parameters

projectstringrequired

the project id

docIdstringrequired

document id

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/{project}/documents/untag/{docId}'

200

200

No body

returns 200 with PUT

get

Gets all user's document recommendations.

Query parameters

fromstringoptional

if not provided it starts from 0

sizestringoptional

if not provided, the 50 first record from the "from" parameter

projectstringoptional

if not provided, return every recommendations for every project

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/document-user-recommendation/'

200

400

200

{
  "error": true,
  "success": true
}

returns the user's document recommendations

options

Preflight options request

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/document-user-recommendation/'

200

200

No body

returns 200 with OPTIONS and GET

get

Gets the extension set in JSON. If a request parameter "filter" is provided, the regular expression will be applied to the list.

See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for pattern syntax.

Query parameters

filterstringoptional

regular expression to apply

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/extensions'

200

200

[]

returns the extensions set

options

Preflight request

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/extensions/install'

200

200

No body

returns OPTIONS and PUT

put

Download (if necessary) and install extension specified by its id or url.Request parameter id or url must be present.

Query parameters

idstringoptional

id of the extension

urlstringoptional

url of the extension

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/extensions/install'

200

400

404

200

No body

returns 200 if the extension is installed

options

Preflight request

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/extensions/uninstall'

200

200

No body

returns OPTIONS and DELETE

delete

Uninstall extension specified by its id.

Query parameters

extensionIdstringoptional

id of the extension to uninstall

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/extensions/uninstall?id={extensionId}'

204

204

No body

returns 204 if the extension is uninstalled (idempotent)

get

Get the FtM document from its project and id (content hash)

Path parameters

projectstringrequired

project identifier

docIdstringrequired

document identifier

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/ftm/{project}/{docId}'

200

404

200

{
  "name": "text",
  "parent": {
    "parent": {
      "parent": "[Circular Reference]",
      "title": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": "[Circular Reference]",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "title": "text",
    "fileName": "text",
    "language": "text",
    "encoding": "text",
    "date": "text",
    "extension": "text",
    "bodyText": "text",
    "generator": "text",
    "mimeType": "text",
    "author": "text",
    "contentHash": "text",
    "fileSize": 1,
    "processingStatus": "text",
    "translatedLanguage": "text",
    "translatedText": "text",
    "crawler": "text",
    "messageId": "text",
    "authoredAt": "text",
    "publishedAt": "text",
    "ancestors": {
      "parent": {
        "parent": "[Circular Reference]",
        "title": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": "[Circular Reference]",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "title": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": "[Circular Reference]",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "processingError": "text",
    "processingAgent": "text",
    "processedAt": "text",
    "name": "text",
    "address": "text",
    "country": "text",
    "description": "text",
    "alias": "text",
    "summary": "text",
    "sourceUrl": "text",
    "notes": "text",
    "publisher": "text",
    "previousName": "text",
    "weakAlias": "text",
    "publisherUrl": "text",
    "alephUrl": "text",
    "wikipediaUrl": "text",
    "wikidataId": "text",
    "keywords": "text",
    "topics": "text",
    "addressEntity": {
      "full": "text",
      "city": "text",
      "street": "text",
      "postOfficeBox": "text",
      "street2": "text",
      "postalCode": "text",
      "latitude": 1,
      "longitude": 1,
      "osmId": "text",
      "googlePlaceId": "text",
      "state": "text",
      "country": "text",
      "region": "text",
      "remarks": "text",
      "name": "text",
      "address": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text"
    },
    "program": "text",
    "proof": {
      "parent": "[Circular Reference]",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "title": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": "[Circular Reference]",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "indexText": "text",
    "createdAt": "text",
    "modifiedAt": "text",
    "retrievedAt": "text",
    "detectedLanguage": "text",
    "detectedCountry": "text",
    "namesMentioned": "text",
    "peopleMentioned": "text",
    "companiesMentioned": "text",
    "ibanMentioned": "text",
    "ipMentioned": "text",
    "locationMentioned": "text",
    "phoneMentioned": "text",
    "emailMentioned": "text"
  },
  "address": "text",
  "fileName": "text",
  "language": "text",
  "encoding": "text",
  "country": "text",
  "date": "text",
  "extension": "text",
  "description": "text",
  "bodyText": "text",
  "alias": "text",
  "summary": "text",
  "sourceUrl": "text",
  "generator": "text",
  "title": "text",
  "notes": "text",
  "mimeType": "text",
  "author": "text",
  "publisher": "text",
  "contentHash": "text",
  "fileSize": 1,
  "processingStatus": "text",
  "translatedLanguage": "text",
  "translatedText": "text",
  "crawler": "text",
  "messageId": "text",
  "authoredAt": "text",
  "publishedAt": "text",
  "ancestors": {
    "parent": {
      "parent": "[Circular Reference]",
      "title": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": "[Circular Reference]",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "title": "text",
    "fileName": "text",
    "language": "text",
    "encoding": "text",
    "date": "text",
    "extension": "text",
    "bodyText": "text",
    "generator": "text",
    "mimeType": "text",
    "author": "text",
    "contentHash": "text",
    "fileSize": 1,
    "processingStatus": "text",
    "translatedLanguage": "text",
    "translatedText": "text",
    "crawler": "text",
    "messageId": "text",
    "authoredAt": "text",
    "publishedAt": "text",
    "ancestors": {
      "parent": {
        "parent": "[Circular Reference]",
        "title": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": "[Circular Reference]",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "title": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": "[Circular Reference]",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "processingError": "text",
    "processingAgent": "text",
    "processedAt": "text",
    "name": "text",
    "address": "text",
    "country": "text",
    "description": "text",
    "alias": "text",
    "summary": "text",
    "sourceUrl": "text",
    "notes": "text",
    "publisher": "text",
    "previousName": "text",
    "weakAlias": "text",
    "publisherUrl": "text",
    "alephUrl": "text",
    "wikipediaUrl": "text",
    "wikidataId": "text",
    "keywords": "text",
    "topics": "text",
    "addressEntity": {
      "full": "text",
      "city": "text",
      "street": "text",
      "postOfficeBox": "text",
      "street2": "text",
      "postalCode": "text",
      "latitude": 1,
      "longitude": 1,
      "osmId": "text",
      "googlePlaceId": "text",
      "state": "text",
      "country": "text",
      "region": "text",
      "remarks": "text",
      "name": "text",
      "address": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text"
    },
    "program": "text",
    "proof": {
      "parent": "[Circular Reference]",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "title": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": "[Circular Reference]",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "indexText": "text",
    "createdAt": "text",
    "modifiedAt": "text",
    "retrievedAt": "text",
    "detectedLanguage": "text",
    "detectedCountry": "text",
    "namesMentioned": "text",
    "peopleMentioned": "text",
    "companiesMentioned": "text",
    "ibanMentioned": "text",
    "ipMentioned": "text",
    "locationMentioned": "text",
    "phoneMentioned": "text",
    "emailMentioned": "text"
  },
  "processingError": "text",
  "processingAgent": "text",
  "processedAt": "text",
  "previousName": "text",
  "weakAlias": "text",
  "publisherUrl": "text",
  "alephUrl": "text",
  "wikipediaUrl": "text",
  "wikidataId": "text",
  "keywords": "text",
  "topics": "text",
  "addressEntity": {
    "full": "text",
    "city": "text",
    "street": "text",
    "postOfficeBox": "text",
    "street2": "text",
    "postalCode": "text",
    "latitude": 1,
    "longitude": 1,
    "osmId": "text",
    "googlePlaceId": "text",
    "state": "text",
    "country": "text",
    "region": "text",
    "remarks": "text",
    "name": "text",
    "address": "text",
    "description": "text",
    "alias": "text",
    "summary": "text",
    "sourceUrl": "text",
    "notes": "text",
    "publisher": "text",
    "previousName": "text",
    "weakAlias": "text",
    "publisherUrl": "text",
    "alephUrl": "text",
    "wikipediaUrl": "text",
    "wikidataId": "text",
    "keywords": "text",
    "topics": "text",
    "addressEntity": {
      "full": "text",
      "city": "text",
      "street": "text",
      "postOfficeBox": "text",
      "street2": "text",
      "postalCode": "text",
      "latitude": 1,
      "longitude": 1,
      "osmId": "text",
      "googlePlaceId": "text",
      "state": "text",
      "country": "text",
      "region": "text",
      "remarks": "text",
      "name": "text",
      "address": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text"
    },
    "program": "text",
    "proof": {
      "parent": "[Circular Reference]",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "title": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": "[Circular Reference]",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": "[Circular Reference]",
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "indexText": "text",
    "createdAt": "text",
    "modifiedAt": "text",
    "retrievedAt": "text"
  },
  "program": "text",
  "proof": {
    "parent": {
      "parent": {
        "parent": "[Circular Reference]",
        "title": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": "[Circular Reference]",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "title": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": {
        "parent": {
          "parent": "[Circular Reference]",
          "title": "text",
          "fileName": "text",
          "language": "text",
          "encoding": "text",
          "date": "text",
          "extension": "text",
          "bodyText": "text",
          "generator": "text",
          "mimeType": "text",
          "author": "text",
          "contentHash": "text",
          "fileSize": 1,
          "processingStatus": "text",
          "translatedLanguage": "text",
          "translatedText": "text",
          "crawler": "text",
          "messageId": "text",
          "authoredAt": "text",
          "publishedAt": "text",
          "ancestors": "[Circular Reference]",
          "processingError": "text",
          "processingAgent": "text",
          "processedAt": "text",
          "name": "text",
          "address": "text",
          "country": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text",
          "detectedLanguage": "text",
          "detectedCountry": "text",
          "namesMentioned": "text",
          "peopleMentioned": "text",
          "companiesMentioned": "text",
          "ibanMentioned": "text",
          "ipMentioned": "text",
          "locationMentioned": "text",
          "phoneMentioned": "text",
          "emailMentioned": "text"
        },
        "title": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": "[Circular Reference]",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": {
        "full": "text",
        "city": "text",
        "street": "text",
        "postOfficeBox": "text",
        "street2": "text",
        "postalCode": "text",
        "latitude": 1,
        "longitude": 1,
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "name": "text",
        "address": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text"
      },
      "program": "text",
      "proof": {
        "parent": "[Circular Reference]",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "title": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": "[Circular Reference]",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "fileName": "text",
    "language": "text",
    "encoding": "text",
    "date": "text",
    "extension": "text",
    "bodyText": "text",
    "generator": "text",
    "title": "text",
    "mimeType": "text",
    "author": "text",
    "contentHash": "text",
    "fileSize": 1,
    "processingStatus": "text",
    "translatedLanguage": "text",
    "translatedText": "text",
    "crawler": "text",
    "messageId": "text",
    "authoredAt": "text",
    "publishedAt": "text",
    "ancestors": {
      "parent": {
        "parent": "[Circular Reference]",
        "title": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": "[Circular Reference]",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "title": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": {
        "parent": {
          "parent": "[Circular Reference]",
          "title": "text",
          "fileName": "text",
          "language": "text",
          "encoding": "text",
          "date": "text",
          "extension": "text",
          "bodyText": "text",
          "generator": "text",
          "mimeType": "text",
          "author": "text",
          "contentHash": "text",
          "fileSize": 1,
          "processingStatus": "text",
          "translatedLanguage": "text",
          "translatedText": "text",
          "crawler": "text",
          "messageId": "text",
          "authoredAt": "text",
          "publishedAt": "text",
          "ancestors": "[Circular Reference]",
          "processingError": "text",
          "processingAgent": "text",
          "processedAt": "text",
          "name": "text",
          "address": "text",
          "country": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text",
          "detectedLanguage": "text",
          "detectedCountry": "text",
          "namesMentioned": "text",
          "peopleMentioned": "text",
          "companiesMentioned": "text",
          "ibanMentioned": "text",
          "ipMentioned": "text",
          "locationMentioned": "text",
          "phoneMentioned": "text",
          "emailMentioned": "text"
        },
        "title": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": "[Circular Reference]",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": {
        "full": "text",
        "city": "text",
        "street": "text",
        "postOfficeBox": "text",
        "street2": "text",
        "postalCode": "text",
        "latitude": 1,
        "longitude": 1,
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "name": "text",
        "address": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text"
      },
      "program": "text",
      "proof": {
        "parent": "[Circular Reference]",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "title": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": "[Circular Reference]",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "processingError": "text",
    "processingAgent": "text",
    "processedAt": "text",
    "name": "text",
    "address": "text",
    "country": "text",
    "description": "text",
    "alias": "text",
    "summary": "text",
    "sourceUrl": "text",
    "notes": "text",
    "publisher": "text",
    "previousName": "text",
    "weakAlias": "text",
    "publisherUrl": "text",
    "alephUrl": "text",
    "wikipediaUrl": "text",
    "wikidataId": "text",
    "keywords": "text",
    "topics": "text",
    "addressEntity": {
      "full": "text",
      "city": "text",
      "street": "text",
      "postOfficeBox": "text",
      "street2": "text",
      "postalCode": "text",
      "latitude": 1,
      "longitude": 1,
      "osmId": "text",
      "googlePlaceId": "text",
      "state": "text",
      "country": "text",
      "region": "text",
      "remarks": "text",
      "name": "text",
      "address": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": {
        "full": "text",
        "city": "text",
        "street": "text",
        "postOfficeBox": "text",
        "street2": "text",
        "postalCode": "text",
        "latitude": 1,
        "longitude": 1,
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "name": "text",
        "address": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text"
      },
      "program": "text",
      "proof": {
        "parent": "[Circular Reference]",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "title": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": "[Circular Reference]",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": "[Circular Reference]",
        "program": "text",
        "proof": "[Circular Reference]",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text"
    },
    "program": "text",
    "proof": {
      "parent": {
        "parent": {
          "parent": "[Circular Reference]",
          "title": "text",
          "fileName": "text",
          "language": "text",
          "encoding": "text",
          "date": "text",
          "extension": "text",
          "bodyText": "text",
          "generator": "text",
          "mimeType": "text",
          "author": "text",
          "contentHash": "text",
          "fileSize": 1,
          "processingStatus": "text",
          "translatedLanguage": "text",
          "translatedText": "text",
          "crawler": "text",
          "messageId": "text",
          "authoredAt": "text",
          "publishedAt": "text",
          "ancestors": "[Circular Reference]",
          "processingError": "text",
          "processingAgent": "text",
          "processedAt": "text",
          "name": "text",
          "address": "text",
          "country": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text",
          "detectedLanguage": "text",
          "detectedCountry": "text",
          "namesMentioned": "text",
          "peopleMentioned": "text",
          "companiesMentioned": "text",
          "ibanMentioned": "text",
          "ipMentioned": "text",
          "locationMentioned": "text",
          "phoneMentioned": "text",
          "emailMentioned": "text"
        },
        "title": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": {
          "parent": {
            "parent": "[Circular Reference]",
            "title": "text",
            "fileName": "text",
            "language": "text",
            "encoding": "text",
            "date": "text",
            "extension": "text",
            "bodyText": "text",
            "generator": "text",
            "mimeType": "text",
            "author": "text",
            "contentHash": "text",
            "fileSize": 1,
            "processingStatus": "text",
            "translatedLanguage": "text",
            "translatedText": "text",
            "crawler": "text",
            "messageId": "text",
            "authoredAt": "text",
            "publishedAt": "text",
            "ancestors": "[Circular Reference]",
            "processingError": "text",
            "processingAgent": "text",
            "processedAt": "text",
            "name": "text",
            "address": "text",
            "country": "text",
            "description": "text",
            "alias": "text",
            "summary": "text",
            "sourceUrl": "text",
            "notes": "text",
            "publisher": "text",
            "previousName": "text",
            "weakAlias": "text",
            "publisherUrl": "text",
            "alephUrl": "text",
            "wikipediaUrl": "text",
            "wikidataId": "text",
            "keywords": "text",
            "topics": "text",
            "addressEntity": "[Circular Reference]",
            "program": "text",
            "proof": "[Circular Reference]",
            "indexText": "text",
            "createdAt": "text",
            "modifiedAt": "text",
            "retrievedAt": "text",
            "detectedLanguage": "text",
            "detectedCountry": "text",
            "namesMentioned": "text",
            "peopleMentioned": "text",
            "companiesMentioned": "text",
            "ibanMentioned": "text",
            "ipMentioned": "text",
            "locationMentioned": "text",
            "phoneMentioned": "text",
            "emailMentioned": "text"
          },
          "title": "text",
          "fileName": "text",
          "language": "text",
          "encoding": "text",
          "date": "text",
          "extension": "text",
          "bodyText": "text",
          "generator": "text",
          "mimeType": "text",
          "author": "text",
          "contentHash": "text",
          "fileSize": 1,
          "processingStatus": "text",
          "translatedLanguage": "text",
          "translatedText": "text",
          "crawler": "text",
          "messageId": "text",
          "authoredAt": "text",
          "publishedAt": "text",
          "ancestors": "[Circular Reference]",
          "processingError": "text",
          "processingAgent": "text",
          "processedAt": "text",
          "name": "text",
          "address": "text",
          "country": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text",
          "detectedLanguage": "text",
          "detectedCountry": "text",
          "namesMentioned": "text",
          "peopleMentioned": "text",
          "companiesMentioned": "text",
          "ibanMentioned": "text",
          "ipMentioned": "text",
          "locationMentioned": "text",
          "phoneMentioned": "text",
          "emailMentioned": "text"
        },
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": {
          "full": "text",
          "city": "text",
          "street": "text",
          "postOfficeBox": "text",
          "street2": "text",
          "postalCode": "text",
          "latitude": 1,
          "longitude": 1,
          "osmId": "text",
          "googlePlaceId": "text",
          "state": "text",
          "country": "text",
          "region": "text",
          "remarks": "text",
          "name": "text",
          "address": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text"
        },
        "program": "text",
        "proof": {
          "parent": "[Circular Reference]",
          "fileName": "text",
          "language": "text",
          "encoding": "text",
          "date": "text",
          "extension": "text",
          "bodyText": "text",
          "generator": "text",
          "title": "text",
          "mimeType": "text",
          "author": "text",
          "contentHash": "text",
          "fileSize": 1,
          "processingStatus": "text",
          "translatedLanguage": "text",
          "translatedText": "text",
          "crawler": "text",
          "messageId": "text",
          "authoredAt": "text",
          "publishedAt": "text",
          "ancestors": "[Circular Reference]",
          "processingError": "text",
          "processingAgent": "text",
          "processedAt": "text",
          "name": "text",
          "address": "text",
          "country": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text",
          "detectedLanguage": "text",
          "detectedCountry": "text",
          "namesMentioned": "text",
          "peopleMentioned": "text",
          "companiesMentioned": "text",
          "ibanMentioned": "text",
          "ipMentioned": "text",
          "locationMentioned": "text",
          "phoneMentioned": "text",
          "emailMentioned": "text"
        },
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "generator": "text",
      "title": "text",
      "mimeType": "text",
      "author": "text",
      "contentHash": "text",
      "fileSize": 1,
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": {
        "parent": {
          "parent": "[Circular Reference]",
          "title": "text",
          "fileName": "text",
          "language": "text",
          "encoding": "text",
          "date": "text",
          "extension": "text",
          "bodyText": "text",
          "generator": "text",
          "mimeType": "text",
          "author": "text",
          "contentHash": "text",
          "fileSize": 1,
          "processingStatus": "text",
          "translatedLanguage": "text",
          "translatedText": "text",
          "crawler": "text",
          "messageId": "text",
          "authoredAt": "text",
          "publishedAt": "text",
          "ancestors": "[Circular Reference]",
          "processingError": "text",
          "processingAgent": "text",
          "processedAt": "text",
          "name": "text",
          "address": "text",
          "country": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text",
          "detectedLanguage": "text",
          "detectedCountry": "text",
          "namesMentioned": "text",
          "peopleMentioned": "text",
          "companiesMentioned": "text",
          "ibanMentioned": "text",
          "ipMentioned": "text",
          "locationMentioned": "text",
          "phoneMentioned": "text",
          "emailMentioned": "text"
        },
        "title": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "generator": "text",
        "mimeType": "text",
        "author": "text",
        "contentHash": "text",
        "fileSize": 1,
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "ancestors": {
          "parent": {
            "parent": "[Circular Reference]",
            "title": "text",
            "fileName": "text",
            "language": "text",
            "encoding": "text",
            "date": "text",
            "extension": "text",
            "bodyText": "text",
            "generator": "text",
            "mimeType": "text",
            "author": "text",
            "contentHash": "text",
            "fileSize": 1,
            "processingStatus": "text",
            "translatedLanguage": "text",
            "translatedText": "text",
            "crawler": "text",
            "messageId": "text",
            "authoredAt": "text",
            "publishedAt": "text",
            "ancestors": "[Circular Reference]",
            "processingError": "text",
            "processingAgent": "text",
            "processedAt": "text",
            "name": "text",
            "address": "text",
            "country": "text",
            "description": "text",
            "alias": "text",
            "summary": "text",
            "sourceUrl": "text",
            "notes": "text",
            "publisher": "text",
            "previousName": "text",
            "weakAlias": "text",
            "publisherUrl": "text",
            "alephUrl": "text",
            "wikipediaUrl": "text",
            "wikidataId": "text",
            "keywords": "text",
            "topics": "text",
            "addressEntity": "[Circular Reference]",
            "program": "text",
            "proof": "[Circular Reference]",
            "indexText": "text",
            "createdAt": "text",
            "modifiedAt": "text",
            "retrievedAt": "text",
            "detectedLanguage": "text",
            "detectedCountry": "text",
            "namesMentioned": "text",
            "peopleMentioned": "text",
            "companiesMentioned": "text",
            "ibanMentioned": "text",
            "ipMentioned": "text",
            "locationMentioned": "text",
            "phoneMentioned": "text",
            "emailMentioned": "text"
          },
          "title": "text",
          "fileName": "text",
          "language": "text",
          "encoding": "text",
          "date": "text",
          "extension": "text",
          "bodyText": "text",
          "generator": "text",
          "mimeType": "text",
          "author": "text",
          "contentHash": "text",
          "fileSize": 1,
          "processingStatus": "text",
          "translatedLanguage": "text",
          "translatedText": "text",
          "crawler": "text",
          "messageId": "text",
          "authoredAt": "text",
          "publishedAt": "text",
          "ancestors": "[Circular Reference]",
          "processingError": "text",
          "processingAgent": "text",
          "processedAt": "text",
          "name": "text",
          "address": "text",
          "country": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text",
          "detectedLanguage": "text",
          "detectedCountry": "text",
          "namesMentioned": "text",
          "peopleMentioned": "text",
          "companiesMentioned": "text",
          "ibanMentioned": "text",
          "ipMentioned": "text",
          "locationMentioned": "text",
          "phoneMentioned": "text",
          "emailMentioned": "text"
        },
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": {
          "full": "text",
          "city": "text",
          "street": "text",
          "postOfficeBox": "text",
          "street2": "text",
          "postalCode": "text",
          "latitude": 1,
          "longitude": 1,
          "osmId": "text",
          "googlePlaceId": "text",
          "state": "text",
          "country": "text",
          "region": "text",
          "remarks": "text",
          "name": "text",
          "address": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text"
        },
        "program": "text",
        "proof": {
          "parent": "[Circular Reference]",
          "fileName": "text",
          "language": "text",
          "encoding": "text",
          "date": "text",
          "extension": "text",
          "bodyText": "text",
          "generator": "text",
          "title": "text",
          "mimeType": "text",
          "author": "text",
          "contentHash": "text",
          "fileSize": 1,
          "processingStatus": "text",
          "translatedLanguage": "text",
          "translatedText": "text",
          "crawler": "text",
          "messageId": "text",
          "authoredAt": "text",
          "publishedAt": "text",
          "ancestors": "[Circular Reference]",
          "processingError": "text",
          "processingAgent": "text",
          "processedAt": "text",
          "name": "text",
          "address": "text",
          "country": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text",
          "detectedLanguage": "text",
          "detectedCountry": "text",
          "namesMentioned": "text",
          "peopleMentioned": "text",
          "companiesMentioned": "text",
          "ibanMentioned": "text",
          "ipMentioned": "text",
          "locationMentioned": "text",
          "phoneMentioned": "text",
          "emailMentioned": "text"
        },
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "detectedLanguage": "text",
        "detectedCountry": "text",
        "namesMentioned": "text",
        "peopleMentioned": "text",
        "companiesMentioned": "text",
        "ibanMentioned": "text",
        "ipMentioned": "text",
        "locationMentioned": "text",
        "phoneMentioned": "text",
        "emailMentioned": "text"
      },
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "description": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "addressEntity": {
        "full": "text",
        "city": "text",
        "street": "text",
        "postOfficeBox": "text",
        "street2": "text",
        "postalCode": "text",
        "latitude": 1,
        "longitude": 1,
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "name": "text",
        "address": "text",
        "description": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "addressEntity": {
          "full": "text",
          "city": "text",
          "street": "text",
          "postOfficeBox": "text",
          "street2": "text",
          "postalCode": "text",
          "latitude": 1,
          "longitude": 1,
          "osmId": "text",
          "googlePlaceId": "text",
          "state": "text",
          "country": "text",
          "region": "text",
          "remarks": "text",
          "name": "text",
          "address": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text"
        },
        "program": "text",
        "proof": {
          "parent": "[Circular Reference]",
          "fileName": "text",
          "language": "text",
          "encoding": "text",
          "date": "text",
          "extension": "text",
          "bodyText": "text",
          "generator": "text",
          "title": "text",
          "mimeType": "text",
          "author": "text",
          "contentHash": "text",
          "fileSize": 1,
          "processingStatus": "text",
          "translatedLanguage": "text",
          "translatedText": "text",
          "crawler": "text",
          "messageId": "text",
          "authoredAt": "text",
          "publishedAt": "text",
          "ancestors": "[Circular Reference]",
          "processingError": "text",
          "processingAgent": "text",
          "processedAt": "text",
          "name": "text",
          "address": "text",
          "country": "text",
          "description": "text",
          "alias": "text",
          "summary": "text",
          "sourceUrl": "text",
          "notes": "text",
          "publisher": "text",
          "previousName": "text",
          "weakAlias": "text",
          "publisherUrl": "text",
          "alephUrl": "text",
          "wikipediaUrl": "text",
          "wikidataId": "text",
          "keywords": "text",
          "topics": "text",
          "addressEntity": "[Circular Reference]",
          "program": "text",
          "proof": "[Circular Reference]",
          "indexText": "text",
          "createdAt": "text",
          "modifiedAt": "text",
          "retrievedAt": "text",
          "detectedLanguage": "text",
          "detectedCountry": "text",
          "namesMentioned": "text",
          "peopleMentioned": "text",
          "companiesMentioned": "text",
          "ibanMentioned": "text",
          "ipMentioned": "text",
          "locationMentioned": "text",
          "phoneMentioned": "text",
          "emailMentioned": "text"
        },
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text"
      },
      "program": "text",
      "proof": "[Circular Reference]",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "detectedLanguage": "text",
      "detectedCountry": "text",
      "namesMentioned": "text",
      "peopleMentioned": "text",
      "companiesMentioned": "text",
      "ibanMentioned": "text",
      "ipMentioned": "text",
      "locationMentioned": "text",
      "phoneMentioned": "text",
      "emailMentioned": "text"
    },
    "indexText": "text",
    "createdAt": "text",
    "modifiedAt": "text",
    "retrievedAt": "text",
    "detectedLanguage": "text",
    "detectedCountry": "text",
    "namesMentioned": "text",
    "peopleMentioned": "text",
    "companiesMentioned": "text",
    "ibanMentioned": "text",
    "ipMentioned": "text",
    "locationMentioned": "text",
    "phoneMentioned": "text",
    "emailMentioned": "text"
  },
  "indexText": "text",
  "createdAt": "text",
  "modifiedAt": "text",
  "retrievedAt": "text",
  "detectedLanguage": "text",
  "detectedCountry": "text",
  "namesMentioned": "text",
  "peopleMentioned": "text",
  "companiesMentioned": "text",
  "ibanMentioned": "text",
  "ipMentioned": "text",
  "locationMentioned": "text",
  "phoneMentioned": "text",
  "emailMentioned": "text"
}

returns the JSON document

get

Search GET request to Elasticsearch. As it is a GET method, all paths are accepted.

if a body is provided, the body will be sent to ES as source=urlencoded(body)&source_content_type=application%2FjsonIn that case, request parameters are not taken into account.

Path parameters

pathstringrequired

elasticsearch path

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/index/search/{path}'

200

400

200

No body

returns 200

head

Head request useful for JavaScript API (for example to test if an index exists)

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request HEAD \
  --url '/api/index/search/{path}'

200

400

200

No body

returns 200

options

Preflight for index creation.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/index/{index}'

200

400

200

No body

returns 200 with PUT

put

Create the index for the current user if it doesn't exist.

Path parameters

indexstringrequired

index to create

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/index/{index}'

200

201

200

No body

returns 200 if the index already exists

options

Preflight request for hide endpoint

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/{project}/namedEntities/hide/{mentionNorm}'

200

200

No body

returns PUT

put

Hide all named entities with the given normalized mention

Path parameters

projectstringrequired

current project

mentionNormstringrequired

normalized mention

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{project}/namedEntities/hide/{mentionNorm}'

200

200

No body

returns 200 OK

post

When datashare is launched in NER mode (without index) it exposes a name finding HTTP API.

The text is sent with the HTTP body.

Path parameters

pipelinestringrequired

pipeline to use

Query parameters

textstringoptional

text to analyze in the request body

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/ner/findNames/{pipeline}'

200

200

[]

returns the list of NamedEntities annotations

get

Gets the list of registered pipelines.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/ner/pipelines'

200

200

[
  "TEST"
]

returns the pipeline set

get

Gets the list of notes for a project.

Path parameters

projectstringrequired

the project id

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{project}/notes'

403

403

No body

if the user is not granted for the project

get

Get the JSON or YAML OpenAPI v3 contract specification

Query parameters

formatstringoptional

format of openapi description. Possible values are:

• json (default)
• yaml

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/openapi?format={format}'

200

200

No body

returns the JSON or YAML file

get

Gets the plugins set in JSON.

If a request parameter "filter" is provided, the regular expression will be applied to the list.

See Pattern for pattern syntax.

Query parameters

filterstringoptional

regular expression to apply

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/plugins'

200

200

[]

returns the plugins set

options

Preflight request

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/plugins/install'

200

200

No body

returns OPTIONS and PUT

put

Download (if necessary) and install plugin specified by its id or url.Request parameter id or url must be present.

Query parameters

idstringoptional

id of the plugin

urlstringoptional

url of the plugin

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/plugins/install'

200

400

404

200

No body

returns 200 if the plugin is installed

options

Preflight request

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/plugins/uninstall'

200

200

No body

returns 200 with OPTIONS and DELETE

delete

Uninstall plugin specified by its id.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/plugins/uninstall?id={pluginId}'

204

204

No body

returns 204 if the plugin is uninstalled (idempotent)

delete

Deletes all user's projects from database and elasticsearch index.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/project/'

204

204

No body

if projects are deleted

get

Get all user's projects

Body

anyoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/project/' \
  --header 'Content-Type: application/json'

default

default

[]

default response

options

Preflight option request

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/project/'

200

200

No body

returns 200 with OPTIONS, POST, GET and DELETE

post

Creates a project

Body

namestringoptional

sourcePathobjectoptional

labelstringoptional

descriptionstringoptional

publisherNamestringoptional

maintainerNamestringoptional

logoUrlstringoptional

sourceUrlstringoptional

creationDatestring · date-timeoptional

updateDatestring · date-timeoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/project/' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "sourcePath": {
      "absolute": true,
      "parent": {
        "absolute": true,
        "fileSystem": {
          "open": true,
          "readOnly": true,
          "separator": "text",
          "rootDirectories": {},
          "fileStores": {},
          "userPrincipalLookupService": {}
        },
        "nameCount": 1
      },
      "root": {
        "absolute": true,
        "fileSystem": {
          "open": true,
          "readOnly": true,
          "separator": "text",
          "rootDirectories": {},
          "fileStores": {},
          "userPrincipalLookupService": {}
        },
        "nameCount": 1
      },
      "fileName": {
        "absolute": true,
        "fileSystem": {
          "open": true,
          "readOnly": true,
          "separator": "text",
          "rootDirectories": {},
          "fileStores": {},
          "userPrincipalLookupService": {}
        },
        "nameCount": 1
      },
      "fileSystem": {
        "open": true,
        "readOnly": true,
        "separator": "text",
        "rootDirectories": {},
        "fileStores": {},
        "userPrincipalLookupService": {}
      },
      "nameCount": 1
    },
    "label": "text",
    "description": "text",
    "publisherName": "text",
    "maintainerName": "text",
    "logoUrl": "text",
    "sourceUrl": "text",
    "creationDate": "2025-03-31T13:44:51.603Z",
    "updateDate": "2025-03-31T13:44:51.603Z"
  }'

201

400

409

500

201

No body

if project and index have been created

get

Returns 200 if the project is allowed with this network route : in Datashare database there is the project table that can specify an IP mask that is allowed per project. If the client IP is not in the range, then the file download will be forbidden. In that project table there is a field called allow_from_mask that can have a mask with IP and star wildcard.

Ex : 192.168.*.* will match all subnetwork 192.168.0.0 IP's and only users with an IP in.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/project/isDownloadAllowed/{id}'

200

403

200

No body

if project download is allowed for this project and IP

delete

Deletes the project from database and elasticsearch index.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/project/{id}'

204

401

204

No body

if project is deleted

get

Gets the project information for the given id

Query parameters

idstringoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/project/{id}'

404

404

No body

if the project is not found in database

options

Preflight project resource option request

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/project/{id}'

200

200

No body

returns 200 with OPTIONS, PUT and DELETE

put

Updates a project

Body

namestringoptional

sourcePathobjectoptional

labelstringoptional

descriptionstringoptional

publisherNamestringoptional

maintainerNamestringoptional

logoUrlstringoptional

sourceUrlstringoptional

creationDatestring · date-timeoptional

updateDatestring · date-timeoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/project/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "sourcePath": {
      "absolute": true,
      "parent": {
        "absolute": true,
        "fileSystem": {
          "open": true,
          "readOnly": true,
          "separator": "text",
          "rootDirectories": {},
          "fileStores": {},
          "userPrincipalLookupService": {}
        },
        "nameCount": 1
      },
      "root": {
        "absolute": true,
        "fileSystem": {
          "open": true,
          "readOnly": true,
          "separator": "text",
          "rootDirectories": {},
          "fileStores": {},
          "userPrincipalLookupService": {}
        },
        "nameCount": 1
      },
      "fileName": {
        "absolute": true,
        "fileSystem": {
          "open": true,
          "readOnly": true,
          "separator": "text",
          "rootDirectories": {},
          "fileStores": {},
          "userPrincipalLookupService": {}
        },
        "nameCount": 1
      },
      "fileSystem": {
        "open": true,
        "readOnly": true,
        "separator": "text",
        "rootDirectories": {},
        "fileStores": {},
        "userPrincipalLookupService": {}
      },
      "nameCount": 1
    },
    "label": "text",
    "description": "text",
    "publisherName": "text",
    "maintainerName": "text",
    "logoUrl": "text",
    "sourceUrl": "text",
    "creationDate": "2025-03-31T13:44:51.603Z",
    "updateDate": "2025-03-31T13:44:51.603Z"
  }'

200

404

500

200

No body

if project has been updated

get

Gets the public (i.e. without user's information) datashare settings parameters.

These parameters are used for the client app for the init process.

The endpoint is removing all fields that contain Address or Secret or Url or Key

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/settings'

200

200

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

returns the list of public settings

get

Gets the versions (front/back/docker) of datashare.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/version'

200

200

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

returns the list of versions of datashare

get

Retrieve the status of databus connection, database connection and index.

Query parameters

format=openmetricsstringoptional

if provided in the URL it will return the status in openmetrics format

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/status'

200

503

504

200

{
  "error": true,
  "success": true
}

returns the status of datashare elements

get

Gets all the user tasks.

Filters can be added with name=value. For example if name=foo is given in the request url query, the tasks containing the term "foo" are going to be returned. It can contain also dotted keys for nested properties matching.

For example if args.dataDir=bar is provided, tasks with an argument "dataDir" containing "bar" are going to be selected.

Pagination/order parameters can be added:

• sort: task field for sorting
• order: order (desc/asc)
• from: offset of the slice
• size: number of tasks in the slice

Query parameters

namestringoptional

as an example: pattern contained in the task name

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/task/all'

200

200

[]

returns the list of tasks

options

Preflight request for batch download.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/task/batchDownload'

200

200

No body

returns 200 with OPTIONS and POST

post

Download files from a search query.

Expected parameters are:

• project: string
• query: string or elasticsearch JSON query

If the query is a string it is taken as an ES query string, else it is a raw JSON query (without the query part), see org.elasticsearch.index.query.WrapperQueryBuilder that is used to wrap the query.

Body

optionsobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/task/batchDownload' \
  --header 'Content-Type: */*' \
  --data '{
    "options": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }'

200

200

{
  "taskId": "text"
}

returns 200 and the json task id

options

Preflight request

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/task/batchSearch/copy/{sourcebatchid}'

default

default

{
  "error": true,
  "success": true
}

returns POST

post

Creates a new batch search based on a previous one given its id, and enqueue it for running

Path parameters

sourcebatchidstringrequired

source batch id

Body

anyoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/task/batchSearch/copy/{sourcebatchid}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "my new batch",
    "description": "desc"
  }'

200

404

200

text

returns the id of the created batch search

post

Creates a new batch search. This is a multipart form with 9 fields:

name, description, csvFile, published, fileTypes, paths, fuzziness, phrase_matches, query_template.

Queries with less than two characters are filtered.

To make a request manually, you can create a file like:

--BOUNDARY
Content-Disposition: form-data; name="name"

my batch search
--BOUNDARY
Content-Disposition: form-data; name="description"

search description
--BOUNDARY
Content-Disposition: form-data; name="csvFile"; filename="search.csv"
Content-Type: text/csv

Obama
skype
test
query three
--BOUNDARY--
Content-Disposition: form-data; name="published"

true
--BOUNDARY--

Then curl with

curl -i -XPOST localhost:8080/api/batch/search/prj1,prj2 -H 'Content-Type: multipart/form-data; boundary=BOUNDARY' --data-binary @/home/dev/multipart.txt

you'll maybe have to replace \n with \r\n with sed -i 's/$/^M/g' ~/multipart.txt

Path parameters

stringrequired

Coma-separated list of projects

Example: {"value":"prj1,prj2"}

Body

namestringoptional

descriptionstringoptional

csvFilestringoptional

publishedbooleanoptional

fileTypesanyoptional

tagsanyoptional

pathsanyoptional

fuzzinessinteger · int32optional

phrase_matchesbooleanoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/task/batchSearch/{coma_separated_projects}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=text' \
  --form 'description=text' \
  --form 'csvFile=text' \
  --form 'published=true' \
  --form 'fileTypes=null' \
  --form 'tags=null' \
  --form 'paths=null' \
  --form 'fuzziness=1' \
  --form 'phrase_matches=true'

400

413

400

No body

if either name or CSV file is missing

post

Indexes files from the queue.

Body

optionsobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/task/batchUpdate/index' \
  --header 'Content-Type: */*' \
  --data '{
    "options": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }'

200

500

200

{
  "taskId": "text"
}

returns 200 and the json task id

post

Indexes files in a directory (with docker, it is the mounted directory that is scanned).

Body

optionsobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/task/batchUpdate/index/file' \
  --header 'Content-Type: */*' \
  --data '{
    "options": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }'

200

200

{
  "error": true,
  "success": true
}

returns 200 and the list of tasks created

post

Cleans all DONE tasks.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/task/clean'

200

200

[]

returns 200 and the list of removed tasks

delete

Cleans a specific task.

Path parameters

taskNamestringrequired

name of the task to delete

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/task/clean/{taskName}'

200

403

200

No body

returns 200 if the task is removed

options

Preflight request for task cleaning.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/task/clean/{taskName}'

200

200

No body

returns OPTIONS and DELETE

put

Cancels the task with the given name.

Path parameters

taskNamestringrequired

name of the task to cancel

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/task/stop/{taskId}'

200

200

true

returns 200 with the cancellation status (true/false)

options

Preflight request to stop tasks.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/task/stop/{taskName}'

200

200

No body

returns 200 with OPTIONS and PUT

options

Preflight request to stop all tasks.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/task/stopAll'

200

200

No body

returns 200 with OPTIONS and PUT

put

Cancels the running tasks. It returns a map with task name/stop statuses.

If the status is false, it means that some threads have not been stopped.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/task/stopAll'

200

200

{
  "ANY_ADDITIONAL_PROPERTY": true
}

returns 200 and the tasks stop result map

get

Gets one task with its id.

Path parameters

idstringrequired

task id

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/task/{id}'

200

200

{
  "id": "text",
  "name": "text",
  "state": "CREATED",
  "progress": 1,
  "createdAt": "2025-03-31T13:44:51.603Z",
  "retriesLeft": 1,
  "completedAt": "2025-03-31T13:44:51.603Z",
  "args": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "result": {
    "value": {}
  },
  "error": {
    "name": "text",
    "message": "text",
    "cause": "text",
    "stacktrace": [],
    "@type": "text"
  },
  "latch": {
    "taskState": "CREATED"
  }
}

returns the task from its id

put

Create a task with JSON body

Path parameters

idstringrequired

task id

Body

idstringoptional

namestringoptional

statestring · enumoptional

Available options:

progressnumber · doubleoptional

createdAtstring · date-timeoptional

retriesLeftinteger · int32optional

completedAtstring · date-timeoptional

argsobjectoptional

resultobjectoptional

errorobjectoptional

latchobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/task/{id}' \
  --header 'Content-Type: */*' \
  --data '{
    "id": "text",
    "name": "text",
    "state": "CREATED",
    "progress": 1,
    "createdAt": "2025-03-31T13:44:51.603Z",
    "retriesLeft": 1,
    "completedAt": "2025-03-31T13:44:51.603Z",
    "args": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "result": {
      "value": {}
    },
    "error": {
      "name": "text",
      "message": "text",
      "cause": "text",
      "stacktrace": [],
      "@type": "text"
    },
    "latch": {
      "taskState": "CREATED"
    }
  }'

200

201

400

200

No body

the task was already existing

get

Gets task result with its id

Path parameters

idstringrequired

task id

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/task/{id}/result'

200

204

403

404

200

No body

returns 200 and the result

get

Lists all files and directory for the given path. This endpoint returns a JSON using the same specification than the tree command on UNIX. It is roughly the equivalent of:

tree -L 1 -spJ --noreport /home/datashare/data

Path parameters

dirPathstringrequired

directory path in the tree

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/tree/{dirPath}'

200

200

{
  "contents": [],
  "type": "directory",
  "prot": "text",
  "name": "text",
  "size": 1
}

returns the list of files and directory

get

Gets the user's session information.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/users/me'

200

200

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

returns the user map

options

Preflight request for history

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/users/me/history'

200

200

No body

returns 200 with OPTIONS, GET, PUT and DELETE

put

Add or update an event to user's history. The event's type, the project ids and the uri are passed in the request body.

To update the event's name, the eventId is required to retrieve the corresponding event. The project list related to the event is stored in database but is never queried (no filters on project).

Query parameters

queryobjectoptional

user history query to save

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/users/me/history'

200

200

No body

returns 200 when event is added or updated.

options

Preflight request for history

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request OPTIONS \
  --url '/api/users/me/history/event'

200

200

No body

returns OPTIONS and DELETE

delete

Delete user event by id.

Query parameters

eventIdstringoptional

user history event id to delete

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/users/me/history/event?id={eventId}'

204

204

No body

Returns 204 (No Content) : idempotent

delete

Delete user history by type.

Query parameters

typestringoptional

type of user history event

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/users/me/history?type={type}'

204

204

{
  "error": true,
  "success": true
}

Returns 204 (No Content) : idempotent