Endpoint Examples

/job/delete

Removes a registered job from the search repository using its ID.

DEL /searchservice/job/delete/{jobId}

Headers

NameTypeDescription
acceptstring, enumGenerated from available response content types.
Allowed: application/json (default) and application/xml

Path Parameters

NameTypeDescription
jobIdstringThe ID of the job to delete.

Query Parameters

NameTypeDescription
vendorstringVendor name (max length : 50).If vendor name provided then document will be unregistered in specific vendor
This parameter is optional.
localeenumLocale of the instance (en_us).
This parameter is required.
instanceTypeenumInstance type to be used to search (LENSSEARCH or SPECTRUM).
This parameter is required.

Code Examples

curl --request DELETE \
  --url "https://lensapi.burning-glass.com/v2.0/searchservice/job/delete/1?locale=en_us&instanceType=spectrum&vendor=sampledemovendor" \
  --header "Authorization: <OAUTH_AUTHENTICATION_HEADER>" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json"
curl --request DELETE \
  --url "https://lensapi.burning-glass.com/v2.0/searchservice/job/delete/1?locale=en_us&instanceType=spectrum&vendor=sampledemovendor" \
  --header "Authorization: <OAUTH_AUTHENTICATION_HEADER>" \
  --header "Accept: application/xml" \
  --header "Content-Type: application/xml"

Response Examples

{
  "status": true,
  "statusCode": "OK",
  "requestId": "fa27ffbe-2133-4f97-a0f6-50095f94154b",
  "responseData": {
    "type": "job",
    "id": "3",
    "vendor": "sampledemovendor",
    "locale": "en_us",
    "instanceType": "Spectrum",
    "maxDocumentCount": 1000,
    "registeredDocumentCount": 7
  },
  "timeStamp": "2015-11-25 19:15:05.782"
}
<UnregisterJobResponse>
    <Status>true</Status>
    <StatusCode>OK</StatusCode>
    <RequestId>c1135447-3f01-44c7-b335-09d0884c9438</RequestId>
    <ResponseData>
        <Type>job</Type>
        <Id>2</Id>
        <Vendor>sampledemovendor</Vendor>
        <Locale>en_us</Locale>
        <InstanceType>Spectrum</InstanceType>
        <MaxDocumentCount>1000</MaxDocumentCount>
        <RegisteredDocumentCount>8</RegisteredDocumentCount>
    </ResponseData>
    <TimeStamp>2015-11-25 18:45:52.882</TimeStamp>
</UnregisterJobResponse>