API

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

DELETE/api/key/:userId

Path parameters

userId*string

user identifier

Response

204

when key has been deleted

Request

JavaScriptCurlPython

const response = await fetch('/api/key/:userId', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

GET/api/key/:userId

Path parameters

userId*string

user identifier

Response

200

returns the hashed key JSON

Body

*/*

any

Request

JavaScriptCurlPython

const response = await fetch('/api/key/:userId', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Preflight for key management

OPTIONS/api/key/:userId

Path parameters

userId*string

user identifier

Response

200

returns OPTIONS, GET, PUT and DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/key/:userId', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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

PUT/api/key/:userId

Path parameters

userId*string

user identifier

Response

201

returns the api key JSON

Body

*/*

any

Request

JavaScriptCurlPython

const response = await fetch('/api/key/:userId', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Deletes batch searches and results for the current user.

DELETE/api/batch/search

Response

204

no content: idempotent

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieves the list of batch searches

GET/api/batch/search

Query parameters

Response

default

default response

Body

*/*

itemsarray of BatchSearchRecord (object)

paginationPagination (any)

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

{
  "items": [
    {
      "uuid": "text",
      "published": false,
      "projects": [
        {
          "name": "text",
          "id": "text"
        }
      ],
      "name": "text",
      "description": "text",
      "state": "QUEUED",
      "date": "2024-11-15T10:18:10.509Z",
      "errorMessage": "text",
      "errorQuery": "text"
    }
  ]
}

Preflight request

OPTIONS/api/batch/search

Response

200

returns 200 with DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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"

POST/api/batch/search

Body

*/*

the json webQuery request body

sizeinteger (int32)

frominteger (int32)

sortstring

orderstring

querystring

fieldstring

queriesarray of string

projectarray of ProjectProxy (object)

batchDatearray of string

statearray of string

publishStatestring

withQueriesboolean

queriesExcludedboolean

contentTypesarray of string

sortedboolean

Response

200

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

Body

*/*

itemsarray of BatchSearchRecord (object)

paginationPagination (any)

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "uuid": "text",
      "published": false,
      "projects": [
        {
          "name": "text",
          "id": "text"
        }
      ],
      "name": "text",
      "description": "text",
      "state": "QUEUED",
      "date": "2024-11-15T10:18:10.509Z",
      "errorMessage": "text",
      "errorQuery": "text"
    }
  ]
}

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

DELETE/api/batch/search/:batchid

Response

204

Returns 204 (No Content) : idempotent

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search/:batchid', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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.

GET/api/batch/search/:batchid

Path parameters

batchId*string

Response

200404

Body

application/json

uuidstring

publishedboolean

projectsarray of ProjectProxy (object)

namestring

descriptionstring

userUser (any)

stateenum

QUEUEDRUNNINGSUCCESSFAILURE

datestring (date-time)

nbQueriesinteger (int32)

nbResultsinteger (int32)

errorMessagestring

errorQuerystring

queriesobject

fileTypesarray of string

pathsarray of string

fuzzinessinteger (int32)

phraseMatchesboolean

queryTemplateSearchQuery (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search/:batchid', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "uuid": "text",
  "published": false,
  "projects": [
    {
      "name": "text",
      "id": "text"
    }
  ],
  "name": "text",
  "description": "text",
  "state": "QUEUED",
  "date": "2024-11-15T10:18:10.509Z",
  "errorMessage": "text",
  "errorQuery": "text",
  "fileTypes": [
    "text"
  ],
  "paths": [
    "text"
  ],
  "phraseMatches": false,
  "queryTemplate": {
    "query": "text"
  }
}

Preflight request

OPTIONS/api/batch/search/:batchid

Response

200

returns 200 with DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search/:batchid', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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

GET/api/batch/search/:batchid/queries

Path parameters

batchId*string

identifier of the batch search

Query parameters

Response

200

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

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search/:batchid/queries', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Creates a new batch search. This is a multipart form with 9 fields:name, description, csvFile, published, fileTypes, paths, fuzziness, phrase_matches, query_templateQueries 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 --BOUNDARYContent-Disposition: form-data; name="description"search description --BOUNDARYContent-Disposition: form-data; name="csvFile"; filename="search.csv"Content-Type: text/csvObamaskypetestquery three--BOUNDARY--Content-Disposition: form-data; name="published"true--BOUNDARY--Then curl withcurl -i -XPOST localhost:8080/api/batch/search/prj1,prj2 -H 'Content-Type: multipart/form-data; boundary=BOUNDARY' --data-binary @/home/dev/multipart.txtyou'll maybe have to replace \n with \n\r with sed -i 's/$/^M/g' ~/multipart.txt

POST/api/batch/search/:coma_separated_projects

Path parameters

*string

Coma-separated list of projects

Body

multipart/form-data

multipart form

namestring

descriptionstring

csvFilestring

publishedboolean

fileTypesany

tagsany

pathsany

fuzzinessinteger (int32)

phrase_matchesboolean

Response

400413

if either name or CSV file is missing

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search/:coma_separated_projects', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Preflight request

OPTIONS/api/batch/search/copy/:sourcebatchid

Response

default

returns POST

Body

*/*

errorboolean

successboolean

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search/copy/:sourcebatchid', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Response

default

{
  "error": false,
  "success": false
}

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

POST/api/batch/search/copy/:sourcebatchid

Path parameters

sourcebatchid*string

source batch id

Body

application/json

batch parameters

any

Response

200404

returns the id of the created batch search

Body

*/*

string

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search/copy/:sourcebatchid', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "my new batch",
      "description": "<p>desc</p>",
      "__$markdownParsed": true
    }),
});
const data = await response.json();

Response

200

text

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

GET/api/batch/search/result/csv/:batchid

Response

200

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

Request

JavaScriptCurlPython

const response = await fetch('/api/batch/search/result/csv/:batchid', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

GET/api/:project/documents/recommendations?userids=:coma_separated_users

Path parameters

project*string

Query parameters

Response

default

default response

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/api/:project/documents/recommendations?userids=:coma_separated_users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

[
  "text"
]

Retrieves the list of starred documents for a given project.

GET/api/:project/documents/starred

Path parameters

project*string

the project id

Response

default

default response

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/api/:project/documents/starred', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

[
  "text"
]

Gets tags by document id

GET/api/:project/documents/tags/:docId

Path parameters

project*string

the project id

docId*string

document id

Response

default

default response

Body

*/*

labelstring

creationDatestring (date-time)

userUser (any)

Request

JavaScriptCurlPython

const response = await fetch('/api/:project/documents/tags/:docId', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

[
  {
    "label": "text",
    "creationDate": "2024-11-15T10:18:10.509Z"
  }
]

Preflight request for document tagging

OPTIONS/api/:project/documents/tags/:docId

Path parameters

project*string

the project id

docId*string

document id

Response

200

returns 200 with PUT

Request

JavaScriptCurlPython

const response = await fetch('/api/:project/documents/tags/:docId', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Preflight request for document untagging

OPTIONS/api/:project/documents/untag/:docId

Path parameters

project*string

the project id

docId*string

document id

Response

200

returns 200 with PUT

Request

JavaScriptCurlPython

const response = await fetch('/api/:project/documents/untag/:docId', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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

GET/api/:projects/documents/tagged/:coma_separated_tags

Path parameters

project*string

the project id

comaSeparatedTags*string

comma separated tags

Response

default

default response

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/api/:projects/documents/tagged/:coma_separated_tags', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

[
  "text"
]

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

GET/api/documents/starred

Response

default

default response

Body

*/*

contentHashstring

fileSizeinteger (int32)

processingStatusstring

translatedLanguagestring

translatedTextstring

crawlerstring

messageIdstring

authoredAtstring

publishedAtstring

ancestorsFolder (object)

processingErrorstring

processingAgentstring

processedAtstring

generatorstring

parentFolder (object)

fileNamestring

languagestring

encodingstring

datestring

extensionstring

bodyTextstring

mimeTypestring

titlestring

authorstring

previousNamestring

weakAliasstring

publisherUrlstring (url)

alephUrlstring (url)

wikipediaUrlstring (url)

wikidataIdstring

keywordsstring

topicsstring

addressEntityAddress (object)

programstring

proofDocument (object)

indexTextstring

createdAtstring

modifiedAtstring

retrievedAtstring

namestring

addressstring

countrystring

aliasstring

summarystring

sourceUrlstring (url)

notesstring

publisherstring

descriptionstring

detectedLanguagestring

detectedCountrystring

namesMentionedstring

peopleMentionedstring

companiesMentionedstring

ibanMentionedstring

ipMentionedstring

locationMentionedstring

phoneMentionedstring

emailMentionedstring

Request

JavaScriptCurlPython

const response = await fetch('/api/documents/starred', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

[
  {
    "contentHash": "text",
    "processingStatus": "text",
    "translatedLanguage": "text",
    "translatedText": "text",
    "crawler": "text",
    "messageId": "text",
    "authoredAt": "text",
    "publishedAt": "text",
    "ancestors": {
      "title": "text",
      "contentHash": "text",
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "generator": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "mimeType": "text",
      "author": "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",
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "text"
      },
      "program": "text",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "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",
    "generator": "text",
    "parent": {
      "title": "text",
      "contentHash": "text",
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "generator": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "mimeType": "text",
      "author": "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",
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "text"
      },
      "program": "text",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "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",
    "mimeType": "text",
    "title": "text",
    "author": "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",
      "osmId": "text",
      "googlePlaceId": "text",
      "state": "text",
      "country": "text",
      "region": "text",
      "remarks": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "program": "text",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "name": "text",
      "address": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "text"
    },
    "program": "text",
    "indexText": "text",
    "createdAt": "text",
    "modifiedAt": "text",
    "retrievedAt": "text",
    "name": "text",
    "address": "text",
    "country": "text",
    "alias": "text",
    "summary": "text",
    "sourceUrl": "text",
    "notes": "text",
    "publisher": "text",
    "description": "text",
    "detectedLanguage": "text",
    "detectedCountry": "text",
    "namesMentioned": "text",
    "peopleMentioned": "text",
    "companiesMentioned": "text",
    "ibanMentioned": "text",
    "ipMentioned": "text",
    "locationMentioned": "text",
    "phoneMentioned": "text",
    "emailMentioned": "text"
  }
]

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

GET/api/users/recommendations?project=:project

Response

default

default response

Body

*/*

aggregatesarray of AggregateUser (object)

totalCountinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/api/users/recommendations?project=:project', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

{
  "aggregates": [
    {}
  ]
}

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

GET/api/users/recommendationsby?project=:project&docIds=:coma_separated_docIds

Query parameters

Response

default

default response

Body

*/*

aggregatesarray of AggregateUser (object)

totalCountinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/api/users/recommendationsby?project=:project&docIds=:coma_separated_docIds', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

{
  "aggregates": [
    {}
  ]
}

Gets all user's document recommendations.

GET/api/document-user-recommendation/

Query parameters

Response

200400

returns the user's document recommendations

Body

*/*

errorboolean

successboolean

Request

JavaScriptCurlPython

const response = await fetch('/api/document-user-recommendation/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "error": false,
  "success": false
}

Preflight options request

OPTIONS/api/document-user-recommendation/

Response

200

returns 200 with OPTIONS and GET

Request

JavaScriptCurlPython

const response = await fetch('/api/document-user-recommendation/', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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.

GET/api/extensions

Query parameters

Response

200

returns the extensions set

Body

*/*

deliverableInstalledboolean

deliverableFromRegistryInstalledboolean

installedboolean

namestring

idstring

typeenum

NLPWEBPLUGINUNKNOWN

versionstring

descriptionstring

Request

JavaScriptCurlPython

const response = await fetch('/api/extensions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "deliverableInstalled": false,
    "deliverableFromRegistryInstalled": false,
    "installed": false,
    "name": "text",
    "id": "text",
    "type": "NLP",
    "version": "text",
    "description": "text"
  }
]

Preflight request

OPTIONS/api/extensions/install

Response

200

returns OPTIONS and PUT

Request

JavaScriptCurlPython

const response = await fetch('/api/extensions/install', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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

PUT/api/extensions/install

Query parameters

Response

200400404

returns 200 if the extension is installed

Request

JavaScriptCurlPython

const response = await fetch('/api/extensions/install', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Preflight request

OPTIONS/api/extensions/uninstall

Response

200

returns OPTIONS and DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/extensions/uninstall', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Uninstall extension specified by its id.

DELETE/api/extensions/uninstall?id=:extensionId

Query parameters

Response

204

returns 204 if the extension is uninstalled (idempotent)

Request

JavaScriptCurlPython

const response = await fetch('/api/extensions/uninstall?id=:extensionId', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

GET/api/ftm/:project/:docId

Path parameters

project*string

project identifier

docId*string

document identifier

Response

200

returns the JSON document

Body

*/*

contentHashstring

fileSizeinteger (int32)

processingStatusstring

translatedLanguagestring

translatedTextstring

crawlerstring

messageIdstring

authoredAtstring

publishedAtstring

ancestorsFolder (object)

processingErrorstring

processingAgentstring

processedAtstring

previousNamestring

weakAliasstring

publisherUrlstring (url)

alephUrlstring (url)

wikipediaUrlstring (url)

wikidataIdstring

keywordsstring

topicsstring

addressEntityAddress (object)

programstring

proofDocument (object)

indexTextstring

createdAtstring

modifiedAtstring

retrievedAtstring

detectedLanguagestring

detectedCountrystring

namesMentionedstring

peopleMentionedstring

companiesMentionedstring

ibanMentionedstring

ipMentionedstring

locationMentionedstring

phoneMentionedstring

emailMentionedstring

generatorstring

namestring

parentFolder (object)

addressstring

fileNamestring

languagestring

encodingstring

countrystring

datestring

extensionstring

bodyTextstring

aliasstring

summarystring

sourceUrlstring (url)

notesstring

mimeTypestring

titlestring

publisherstring

authorstring

descriptionstring

Request

JavaScriptCurlPython

const response = await fetch('/api/ftm/:project/:docId', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "contentHash": "text",
  "processingStatus": "text",
  "translatedLanguage": "text",
  "translatedText": "text",
  "crawler": "text",
  "messageId": "text",
  "authoredAt": "text",
  "publishedAt": "text",
  "ancestors": {
    "title": "text",
    "contentHash": "text",
    "processingStatus": "text",
    "translatedLanguage": "text",
    "translatedText": "text",
    "crawler": "text",
    "messageId": "text",
    "authoredAt": "text",
    "publishedAt": "text",
    "processingError": "text",
    "processingAgent": "text",
    "processedAt": "text",
    "generator": "text",
    "fileName": "text",
    "language": "text",
    "encoding": "text",
    "date": "text",
    "extension": "text",
    "bodyText": "text",
    "mimeType": "text",
    "author": "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",
      "osmId": "text",
      "googlePlaceId": "text",
      "state": "text",
      "country": "text",
      "region": "text",
      "remarks": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "program": "text",
      "proof": {
        "contentHash": "text",
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "generator": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "mimeType": "text",
        "title": "text",
        "author": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "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",
      "name": "text",
      "address": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "text"
    },
    "program": "text",
    "proof": {
      "contentHash": "text",
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "generator": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "mimeType": "text",
      "title": "text",
      "author": "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",
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "text"
      },
      "program": "text",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "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",
    "name": "text",
    "address": "text",
    "country": "text",
    "alias": "text",
    "summary": "text",
    "sourceUrl": "text",
    "notes": "text",
    "publisher": "text",
    "description": "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",
    "osmId": "text",
    "googlePlaceId": "text",
    "state": "text",
    "country": "text",
    "region": "text",
    "remarks": "text",
    "previousName": "text",
    "weakAlias": "text",
    "publisherUrl": "text",
    "alephUrl": "text",
    "wikipediaUrl": "text",
    "wikidataId": "text",
    "keywords": "text",
    "topics": "text",
    "program": "text",
    "proof": {
      "contentHash": "text",
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "ancestors": {
        "title": "text",
        "contentHash": "text",
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "generator": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "mimeType": "text",
        "author": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "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",
      "generator": "text",
      "parent": {
        "title": "text",
        "contentHash": "text",
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "generator": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "mimeType": "text",
        "author": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "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",
      "mimeType": "text",
      "title": "text",
      "author": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "program": "text",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "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",
    "name": "text",
    "address": "text",
    "alias": "text",
    "summary": "text",
    "sourceUrl": "text",
    "notes": "text",
    "publisher": "text",
    "description": "text"
  },
  "program": "text",
  "proof": {
    "contentHash": "text",
    "processingStatus": "text",
    "translatedLanguage": "text",
    "translatedText": "text",
    "crawler": "text",
    "messageId": "text",
    "authoredAt": "text",
    "publishedAt": "text",
    "ancestors": {
      "title": "text",
      "contentHash": "text",
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "generator": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "mimeType": "text",
      "author": "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",
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "text"
      },
      "program": "text",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "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",
    "generator": "text",
    "parent": {
      "title": "text",
      "contentHash": "text",
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "generator": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "mimeType": "text",
      "author": "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",
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "text"
      },
      "program": "text",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "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",
    "mimeType": "text",
    "title": "text",
    "author": "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",
      "osmId": "text",
      "googlePlaceId": "text",
      "state": "text",
      "country": "text",
      "region": "text",
      "remarks": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "program": "text",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "name": "text",
      "address": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "text"
    },
    "program": "text",
    "indexText": "text",
    "createdAt": "text",
    "modifiedAt": "text",
    "retrievedAt": "text",
    "name": "text",
    "address": "text",
    "country": "text",
    "alias": "text",
    "summary": "text",
    "sourceUrl": "text",
    "notes": "text",
    "publisher": "text",
    "description": "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",
  "generator": "text",
  "name": "text",
  "parent": {
    "title": "text",
    "contentHash": "text",
    "processingStatus": "text",
    "translatedLanguage": "text",
    "translatedText": "text",
    "crawler": "text",
    "messageId": "text",
    "authoredAt": "text",
    "publishedAt": "text",
    "processingError": "text",
    "processingAgent": "text",
    "processedAt": "text",
    "generator": "text",
    "fileName": "text",
    "language": "text",
    "encoding": "text",
    "date": "text",
    "extension": "text",
    "bodyText": "text",
    "mimeType": "text",
    "author": "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",
      "osmId": "text",
      "googlePlaceId": "text",
      "state": "text",
      "country": "text",
      "region": "text",
      "remarks": "text",
      "previousName": "text",
      "weakAlias": "text",
      "publisherUrl": "text",
      "alephUrl": "text",
      "wikipediaUrl": "text",
      "wikidataId": "text",
      "keywords": "text",
      "topics": "text",
      "program": "text",
      "proof": {
        "contentHash": "text",
        "processingStatus": "text",
        "translatedLanguage": "text",
        "translatedText": "text",
        "crawler": "text",
        "messageId": "text",
        "authoredAt": "text",
        "publishedAt": "text",
        "processingError": "text",
        "processingAgent": "text",
        "processedAt": "text",
        "generator": "text",
        "fileName": "text",
        "language": "text",
        "encoding": "text",
        "date": "text",
        "extension": "text",
        "bodyText": "text",
        "mimeType": "text",
        "title": "text",
        "author": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "country": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "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",
      "name": "text",
      "address": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "text"
    },
    "program": "text",
    "proof": {
      "contentHash": "text",
      "processingStatus": "text",
      "translatedLanguage": "text",
      "translatedText": "text",
      "crawler": "text",
      "messageId": "text",
      "authoredAt": "text",
      "publishedAt": "text",
      "processingError": "text",
      "processingAgent": "text",
      "processedAt": "text",
      "generator": "text",
      "fileName": "text",
      "language": "text",
      "encoding": "text",
      "date": "text",
      "extension": "text",
      "bodyText": "text",
      "mimeType": "text",
      "title": "text",
      "author": "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",
        "osmId": "text",
        "googlePlaceId": "text",
        "state": "text",
        "country": "text",
        "region": "text",
        "remarks": "text",
        "previousName": "text",
        "weakAlias": "text",
        "publisherUrl": "text",
        "alephUrl": "text",
        "wikipediaUrl": "text",
        "wikidataId": "text",
        "keywords": "text",
        "topics": "text",
        "program": "text",
        "indexText": "text",
        "createdAt": "text",
        "modifiedAt": "text",
        "retrievedAt": "text",
        "name": "text",
        "address": "text",
        "alias": "text",
        "summary": "text",
        "sourceUrl": "text",
        "notes": "text",
        "publisher": "text",
        "description": "text"
      },
      "program": "text",
      "indexText": "text",
      "createdAt": "text",
      "modifiedAt": "text",
      "retrievedAt": "text",
      "name": "text",
      "address": "text",
      "country": "text",
      "alias": "text",
      "summary": "text",
      "sourceUrl": "text",
      "notes": "text",
      "publisher": "text",
      "description": "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",
    "name": "text",
    "address": "text",
    "country": "text",
    "alias": "text",
    "summary": "text",
    "sourceUrl": "text",
    "notes": "text",
    "publisher": "text",
    "description": "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",
  "bodyText": "text",
  "alias": "text",
  "summary": "text",
  "sourceUrl": "text",
  "notes": "text",
  "mimeType": "text",
  "title": "text",
  "publisher": "text",
  "author": "text",
  "description": "text"
}

Preflight for index creation.

OPTIONS/api/index/:index

Response

200400

returns 200 with PUT

Request

JavaScriptCurlPython

const response = await fetch('/api/index/:index', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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

PUT/api/index/:index

Path parameters

index*string

index to create

Response

200201

returns 200 if the index already exists

Request

JavaScriptCurlPython

const response = await fetch('/api/index/:index', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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.

GET/api/index/search/:path:

Path parameters

path*string

elasticsearch path

Response

200400

returns 200

Request

JavaScriptCurlPython

const response = await fetch('/api/index/search/:path:', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

HEAD/api/index/search/:path:

Response

200400

returns 200

Request

JavaScriptCurlPython

const response = await fetch('/api/index/search/:path:', {
    method: 'HEAD',
    headers: {},
});
const data = await response.json();

Preflight request for hide endpoint

OPTIONS/api/:project/namedEntities/hide/:mentionNorm

Response

200

returns PUT

Request

JavaScriptCurlPython

const response = await fetch('/api/:project/namedEntities/hide/:mentionNorm', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Hide all named entities with the given normalized mention

PUT/api/:project/namedEntities/hide/:mentionNorm

Path parameters

project*string

current project

mentionNorm*string

normalized mention

Response

200

returns 200 OK

Request

JavaScriptCurlPython

const response = await fetch('/api/:project/namedEntities/hide/:mentionNorm', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

When datashare is launched in NER mode (without index) it exposes a name finding HTTP API.The text is sent with the HTTP body.

POST/api/ner/findNames/:pipeline

Path parameters

pipeline*string

pipeline to use

Query parameters

Response

200

returns the list of NamedEntities annotations

Body

*/*

categoryenum

PERSONORGANIZATIONLOCATIONEMAILDATEMONEYNUMBERNONEUNKNOWN

mentionstring

offsetsarray of integer (int64)

documentIdstring

rootDocumentstring

extractorenum

TESTCORENLPGATENLPIXAPIPEMITIEOPENNLPEMAILSPACY

extractorLanguageenum

ABKHAZIANAFARAFRIKAANSAKANALBANIANAMHARICARABICARAGONESEARMENIANASSAMESEAVARICAVESTANAYMARAAZERBAIJANIBAMBARABASHKIRBASQUEBELARUSIANBENGALIBIHARIBISLAMABOSNIANBRETONBULGARIANBURMESECATALANCHAMORROCHECHENCHICHEWACHINESECHUVASHCORNISHCORSICANCREECROATIANCZECHDANISHMALDIVIANDUTCHDZONGKHAENGLISHESPERANTOESTONIANEWEFAROESEFIJIANFINNISHFRENCHFULAHGALICIANGEORGIANGERMANGREEKGUARANIGUJARATIHAITIANHAUSAHEBREWHEREROHINDIHIRIMOTUHUNGARIANINTERLINGUAINDONESIANINTERLIGUEIRISHIGBOINUPIAQIDOICELANDICITALIANINUKTITUTJAPANESEJAVANESEGREENLANDICKANNADAKANURIKASHMIRIKAZAKHCENTRALKHMERKIKUYUKINYARWANDAKIRGHIZKOMIKONGOKOREANKURDISHKUANYAMALATINLUXEMBOURGISHGANDALIMBURGANLINGALALAOLITHUANIANLUBAKATANGALATVIANMANXMACEDONIANMALAGASYMALAYMALAYALAMMALTESEMAORIMARATHIMARSHALLESEMONGOLIANNAURUNAVAJONORTHNDEBELENEPALINDONGANORWEGIANBOKMALNORWEGIANNYNORSKNORWEGIANSICHUANYISOUTHNDEBELEOCCITANOJIBWAOLDSLAVONICOROMOORIYAOSSETIANPANJABIPALIPERSIANPOLISHPASHTOPORTUGUESEQUECHUAROMANSHROMANIANRUNDIMOLDAVIANMOLDOVANRUSSIANSANSKRITSARDINIANSINDHINORTHERNSAMISAMOANSANGOSERBIANGAELICSHONASINHALESESLOVAKSLOVENIANSOMALISOUTHERNSOTHOSPANISHSUNDANESESWAHILISWATISWEDISHTAMILTELUGUTAJIKTHAITIGRINYATIBETANTURKMENTAGALOGTSWANATONGATURKISHTSONGATATARTWITAHITIANUIGHURUKRAINIANURDUUZBEKVENDAVIETNAMESEVOLAPUKWALLOONWELSHWOLOFWESTERNFRISIANXHOSAYIDDISHYORUBAZHUANGZULUUNKNOWN

isHiddenboolean

partsOfSpeechstring

metadataobject

mentionNormTextLengthinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/api/ner/findNames/:pipeline', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "category": "PERSON",
    "mention": "text",
    "offsets": [],
    "documentId": "text",
    "rootDocument": "text",
    "extractor": "TEST",
    "extractorLanguage": "ABKHAZIAN",
    "isHidden": false,
    "partsOfSpeech": "text"
  }
]

Gets the list of registered pipelines.

GET/api/ner/pipelines

Response

200

returns the pipeline set

Body

*/*

itemsenum

TESTCORENLPGATENLPIXAPIPEMITIEOPENNLPEMAILSPACY

Request

JavaScriptCurlPython

const response = await fetch('/api/ner/pipelines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  "TEST"
]

Gets the list of notes for a project.

GET/api/:project/notes

Path parameters

project*string

the project id

Response

403

if the user is not granted for the project

Request

JavaScriptCurlPython

const response = await fetch('/api/:project/notes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get the JSON OpenAPI v3 contract specification

GET/api/openapi

Response

200

returns the JSON file

Request

JavaScriptCurlPython

const response = await fetch('/api/openapi', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Gets the plugins 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.

GET/api/plugins

Query parameters

Response

200

returns the plugins set

Body

*/*

deliverableInstalledboolean

deliverableFromRegistryInstalledboolean

installedboolean

namestring

idstring

typeenum

NLPWEBPLUGINUNKNOWN

versionstring

descriptionstring

Request

JavaScriptCurlPython

const response = await fetch('/api/plugins', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "deliverableInstalled": false,
    "deliverableFromRegistryInstalled": false,
    "installed": false,
    "name": "text",
    "id": "text",
    "type": "NLP",
    "version": "text",
    "description": "text"
  }
]

Preflight request

OPTIONS/api/plugins/install

Response

200

returns OPTIONS and PUT

Request

JavaScriptCurlPython

const response = await fetch('/api/plugins/install', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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

PUT/api/plugins/install

Query parameters

Response

200400404

returns 200 if the plugin is installed

Request

JavaScriptCurlPython

const response = await fetch('/api/plugins/install', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Preflight request

OPTIONS/api/plugins/uninstall

Response

200

returns 200 with OPTIONS and DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/plugins/uninstall', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Uninstall plugin specified by its id.

DELETE/api/plugins/uninstall?id=:pluginId

Response

204

returns 204 if the plugin is uninstalled (idempotent)

Request

JavaScriptCurlPython

const response = await fetch('/api/plugins/uninstall?id=:pluginId', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

DELETE/api/project/

Response

204

if projects are deleted

Request

JavaScriptCurlPython

const response = await fetch('/api/project/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get all user's projects

GET/api/project/

Body

application/json

any

Response

default

default response

Body

*/*

namestring

sourcePathobject

labelstring

descriptionstring

publisherNamestring

maintainerNamestring

logoUrlstring

sourceUrlstring

creationDatestring (date-time)

updateDatestring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/project/', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

default

[
  {
    "name": "text",
    "sourcePath": {
      "absolute": false,
      "parent": {
        "absolute": false,
        "fileSystem": {
          "open": false,
          "readOnly": false,
          "separator": "text"
        }
      },
      "root": {
        "absolute": false,
        "fileSystem": {
          "open": false,
          "readOnly": false,
          "separator": "text"
        }
      },
      "fileName": {
        "absolute": false,
        "fileSystem": {
          "open": false,
          "readOnly": false,
          "separator": "text"
        }
      },
      "fileSystem": {
        "open": false,
        "readOnly": false,
        "separator": "text"
      }
    },
    "label": "text",
    "description": "text",
    "publisherName": "text",
    "maintainerName": "text",
    "logoUrl": "text",
    "sourceUrl": "text",
    "creationDate": "2024-11-15T10:18:10.509Z",
    "updateDate": "2024-11-15T10:18:10.509Z"
  }
]

Preflight option request

OPTIONS/api/project/

Response

200

returns 200 with OPTIONS, POST, GET and DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/project/', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Creates a project

POST/api/project/

Body

application/json

any

Response

201400409500

if project and index have been created

Request

JavaScriptCurlPython

const response = await fetch('/api/project/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Deletes the project from database and elasticsearch index.

DELETE/api/project/:id

Response

204401

if project is deleted

Request

JavaScriptCurlPython

const response = await fetch('/api/project/:id', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Gets the project information for the given id

GET/api/project/:id

Query parameters

Response

404

if the project is not found in database

Request

JavaScriptCurlPython

const response = await fetch('/api/project/:id', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Preflight option request

OPTIONS/api/project/:id

Response

200

returns 200 with OPTIONS and DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/project/:id', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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.

GET/api/project/isDownloadAllowed/:id

Response

200403

if project download is allowed for this project and IP

Request

JavaScriptCurlPython

const response = await fetch('/api/project/isDownloadAllowed/:id', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

GET/settings

Response

200

returns the list of public settings

Body

*/*

Other propertiesany

Request

JavaScriptCurlPython

const response = await fetch('/settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

GET/version

Response

200

returns the list of versions of datashare

Body

*/*

Other propertiesstring

Request

JavaScriptCurlPython

const response = await fetch('/version', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

GET/api/status

Query parameters

Response

200503504

returns the status of datashare elements

Body

*/*

errorboolean

successboolean

Request

JavaScriptCurlPython

const response = await fetch('/api/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200503504

{
  "error": false,
  "success": false
}

Gets one task with its id.

GET/api/task/:id

Path parameters

id*string

task id

Response

200

returns the task from its id

Body

*/*

idstring

namestring

stateenum

CREATEDQUEUEDRUNNINGCANCELLEDERRORDONE

progressnumber (double)

resultobject

argsobject

createdAtstring (date-time)

errorTaskError (object)

latchStateLatch (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/task/:id', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "state": "CREATED",
  "progress": 0,
  "createdAt": "2024-11-15T10:18:10.509Z",
  "error": {
    "name": "text",
    "message": "text",
    "cause": "text",
    "stacktrace": [
      {
        "file": "text",
        "name": "text"
      }
    ],
    "@type": "text"
  },
  "latch": {
    "taskState": "CREATED"
  }
}

Create a task with JSON body

PUT/api/task/:id

Path parameters

id*string

task id

Body

*/*

the task creation body

idstring

namestring

stateenum

CREATEDQUEUEDRUNNINGCANCELLEDERRORDONE

progressnumber (double)

resultobject

argsobject

createdAtstring (date-time)

errorTaskError (object)

latchStateLatch (object)

Response

200201400

the task was already existing

Request

JavaScriptCurlPython

const response = await fetch('/api/task/:id', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "taskId": "text"
}

Gets task result with its id

GET/api/task/:id/result

Path parameters

id*string

task id

Response

200204403404

returns 200 and the result

Request

JavaScriptCurlPython

const response = await fetch('/api/task/:id/result', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Gets all the user tasks.A filter can be added with a pattern contained in the task name.

GET/api/task/all

Query parameters

Response

200

returns the list of tasks

Body

*/*

idstring

namestring

stateenum

CREATEDQUEUEDRUNNINGCANCELLEDERRORDONE

progressnumber (double)

resultobject

argsobject

createdAtstring (date-time)

errorTaskError (object)

latchStateLatch (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/task/all', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "name": "text",
    "state": "CREATED",
    "progress": 0,
    "createdAt": "2024-11-15T10:18:10.509Z",
    "error": {
      "name": "text",
      "message": "text",
      "cause": "text",
      "stacktrace": [
        {
          "file": "text",
          "name": "text"
        }
      ],
      "@type": "text"
    },
    "latch": {
      "taskState": "CREATED"
    }
  }
]

Preflight request for batch download.

OPTIONS/api/task/batchDownload

Response

200

returns 200 with OPTIONS and POST

Request

JavaScriptCurlPython

const response = await fetch('/api/task/batchDownload', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Download files from a search query.Expected parameters are :- project: string- query: string or elasticsearch JSON queryIf 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

POST/api/task/batchDownload

Body

*/*

the json used to wrap the query

optionsobject

Response

200

returns 200 and the json task id

Body

*/*

taskIdstring

Request

JavaScriptCurlPython

const response = await fetch('/api/task/batchDownload', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "taskId": "text"
}

Indexes files from the queue.

POST/api/task/batchUpdate/index

Body

*/*

wrapper for options json

optionsobject

Response

200500

returns 200 and the json task id

Body

*/*

taskIdstring

Request

JavaScriptCurlPython

const response = await fetch('/api/task/batchUpdate/index', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200500

{
  "taskId": "text"
}

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

POST/api/task/batchUpdate/index/file

Body

*/*

wrapper for options json

optionsobject

Response

200

returns 200 and the list of tasks created

Body

*/*

errorboolean

successboolean

Request

JavaScriptCurlPython

const response = await fetch('/api/task/batchUpdate/index/file', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "error": false,
  "success": false
}

Cleans all DONE tasks.

POST/api/task/clean

Response

200

returns 200 and the list of removed tasks

Body

*/*

idstring

namestring

stateenum

CREATEDQUEUEDRUNNINGCANCELLEDERRORDONE

progressnumber (double)

resultobject

argsobject

createdAtstring (date-time)

errorTaskError (object)

latchStateLatch (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/task/clean', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "name": "text",
    "state": "CREATED",
    "progress": 0,
    "createdAt": "2024-11-15T10:18:10.509Z",
    "error": {
      "name": "text",
      "message": "text",
      "cause": "text",
      "stacktrace": [
        {
          "file": "text",
          "name": "text"
        }
      ],
      "@type": "text"
    },
    "latch": {
      "taskState": "CREATED"
    }
  }
]

Cleans a specific task.

DELETE/api/task/clean/:taskName:

Path parameters

taskName*string

name of the task to delete

Response

200403

returns 200 if the task is removed

Request

JavaScriptCurlPython

const response = await fetch('/api/task/clean/:taskName:', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Preflight request for task cleaning.

OPTIONS/api/task/clean/:taskName:

Response

200

returns OPTIONS and DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/task/clean/:taskName:', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Cancels the task with the given name.

PUT/api/task/stop/:taskId:

Path parameters

taskName*string

name of the task to cancel

Response

200

returns 200 with the cancellation status (true/false)

Body

*/*

boolean

Request

JavaScriptCurlPython

const response = await fetch('/api/task/stop/:taskId:', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200

false

Preflight request to stop tasks.

OPTIONS/api/task/stop/:taskName:

Response

200

returns 200 with OPTIONS and PUT

Request

JavaScriptCurlPython

const response = await fetch('/api/task/stop/:taskName:', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Preflight request to stop all tasks.

OPTIONS/api/task/stopAll

Response

200

returns 200 with OPTIONS and PUT

Request

JavaScriptCurlPython

const response = await fetch('/api/task/stopAll', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Cancels the running tasks. It returns a map with task name/stop statuses.If the status is false, it means that the thread has not been stopped.

PUT/api/task/stopAll

Response

200

returns 200 and the tasks stop result map

Body

*/*

Other propertiesboolean

Request

JavaScriptCurlPython

const response = await fetch('/api/task/stopAll', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

GET/api/tree/:dirPath:

Path parameters

dirPath*string

directory path in the tree

Response

200

returns the list of files and directory

Body

*/*

contentsarray of AbstractFileReport (object)

protstring

typeenum

directoryfile

namestring

sizeinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('/api/tree/:dirPath:', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Gets the user's session information.

GET/api/users/me

Response

200

returns the user map

Body

*/*

Other propertiesany

Request

JavaScriptCurlPython

const response = await fetch('/api/users/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Preflight request for history

OPTIONS/api/users/me/history

Response

200

returns 200 with OPTIONS, GET, PUT and DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/users/me/history', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

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)

PUT/api/users/me/history

Query parameters

Response

200

returns 200 when event is added or updated.

Request

JavaScriptCurlPython

const response = await fetch('/api/users/me/history', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Preflight request for history

OPTIONS/api/users/me/history/event

Response

200

returns OPTIONS and DELETE

Request

JavaScriptCurlPython

const response = await fetch('/api/users/me/history/event', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Delete user event by id.

DELETE/api/users/me/history/event?id=:eventId

Query parameters

Response

204

Returns 204 (No Content) : idempotent

Request

JavaScriptCurlPython

const response = await fetch('/api/users/me/history/event?id=:eventId', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Delete user history by type.

DELETE/api/users/me/history?type=:type

Query parameters

Response

204

Returns 204 (No Content) : idempotent

Body

*/*

errorboolean

successboolean

Request

JavaScriptCurlPython

const response = await fetch('/api/users/me/history?type=:type', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

204

{
  "error": false,
  "success": false
}