Job Registration

post

https://lensapi.burning-glass.com/v2.0/searchservice/job/create

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

jobId

string

required

length ≤ 100

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

binaryData

string

required

Base64 encoded binary job data. This parameter is required.

extension

string

Defaults to txt

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

vendor

string

length ≤ 50

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

locale

string

enum

required

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

Allowed:

instanceType

string

enum

required

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

Allowed:

registerParsedBinaryData

string

enum

Defaults to false

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

Allowed:

errorOnDuplicateorOverwrite

string

enum

Defaults to Error

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

Allowed:

registerWithCustomFilters

boolean

Defaults to false

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

customFilters

array of objects

A list of custom filters with name and value. Required when registerWithCustomFilters is true.

customFilters

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK