v1

latestOpenAPI 3.1.02026-07-242892032.8 MB

Endpoints

Job Registration

Stores a job in the search repository using a unique job ID.

post/searchservice/job/create

Request body

jobIdstring required

Unique job registration document id (max length : 100). This parameter is required.

binaryDatastring required

Base64 encoded binary job data. This parameter is required.

extensionstring

The document extension (txt, doc, docx, rtf, etc...). The default extension would be 'txt'.

vendorstring

Vendor name (max length : 50). If not specified, default vendor would be used.

locale'en_us' required

Locale of the instance (en_us). This parameter is required.

instanceType'LENSSEARCH' | 'SPECTRUM' required

Instance type to be used to search (LENSSEARCH or SPECTRUM). This parameter is required.

registerParsedBinaryData'true' | 'false'

A flag to indicate register parsed job. Default is false. This parameter is optional.

errorOnDuplicateorOverwrite'Error' | 'Overwrite'

Enum value to overwrite existing job with the specified Id (Error or Overwrite).

registerWithCustomFiltersboolean

A flag to indicate register job with custom filters (true or false). Default would be false.

Example request

{
  "jobId": "Jobtxttxt",
  "binaryData": "IA0KICAgDQogIA0KIENvbW11bmljYXRpb24gU....",
  "extension": "txt",
  "vendor": "testposting",
  "locale": "en_us",
  "instanceType": "SPECTRUM",
  "registerParsedBinaryData": "false",
  "errorOnDuplicateorOverwrite": "Error"
}

Response

statusboolean

Indicates whether the request was successful.

statusCodestring

Status code of the response.

requestIdstring uuid

Unique identifier for the request.

timeStampstring date-time

Timestamp of the response.

Example response

{
  "status": true,
  "statusCode": "OK",
  "requestId": "c1b4b27d-0abc-402e-853e-3671ef522160",
  "timeStamp": "2023-08-02 11:48:08.514",
  "responseData": {
    "type": "posting",
    "id": "Jobtxttxt",
    "vendor": "testposting",
    "locale": "en_us",
    "instanceType": "SPECTRUM",
    "maxDocumentCount": 1000,
    "registeredDocumentCount": 6
  }
}