v1

latestOpenAPI 3.1.02026-07-242892032.8 MB

Endpoints

Job Search

Searches stored jobs using various filters and matching criteria.

post/searchservice/jobsearch

Request body

Example request

{
  "searchCriteria": {
    "job": {
      "binaryData": "IA0KICAgDQogIA0KIENv...",
      "extension": "txt"
    },
    "additionalFilters": {
      "maximumDocumentCount": 30
    },
    "instanceType": "SPECTRUM",
    "locale": "en_us",
    "vendor": "testposting"
  }
}

Response

statusboolean

Indicates if the request was successful

statusCodestring

Status code of the response

requestIdstring uuid

Unique ID to track the request

timeStampstring date-time

Timestamp of the response

Example response

{
  "status": true,
  "statusCode": "OK",
  "requestId": "f7b6a4a5-b505-437e-8f98-c0159fcbf264",
  "timeStamp": "2023-08-02 11:51:41.744",
  "responseData": {
    "vendorName": "testposting",
    "locale": "en_us",
    "instanceType": "SPECTRUM",
    "resultsCount": 0,
    "offset": 1,
    "maxDocumentCount": 30,
    "minimumScore": 0,
    "orderBy": "score",
    "sortDirection": "DESC",
    "totalFound": 0
  }
}