Endpoint Examples

/job/getdocids

Retrieves registered job document IDs from a vendor.

`GET` /searchservice/job/getdocids

Headers

Name	Type	Description
`accept`	string, enum	Generated from available response content types. Allowed: `application/json` (default) and `application/xml`

Query Parameters

Name	Type	Description
`lastDocId`	string	To get the next set of document ids, the lastDocId parameter is used. Supply the last doc id from the previous result to get doc ids after it. This parameter is optional.
`vendor`	string	Name of the vendor. If vendor name is provided then document ids will be fetched from specific vendor else it is taken from default vendor. This parameter is optional.
`locale`	enum	Locale of the instance (en_us). This parameter is required.
`instanceType`	enum	Instance type to be used to search (LENSSEARCH or SPECTRUM). This parameter is required.
`count`	string	The maximum number of document ids to be returned in the response. The default count is 10000. This parameter is optional.

Code Examples

curl --request GET \
  --url "https://lensapi.burning-glass.com/v2.0/searchservice/job/getdocids?instanceType=spectrum&locale=en_us&count=100&vendor=sampledemovendor&lastDocId=347953" \
  --header "Authorization: <OAUTH_AUTHENTICATION_HEADER>" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json"

curl --request GET \
  --url "https://lensapi.burning-glass.com/v2.0/searchservice/job/getdocids?instanceType=spectrum&locale=en_us&count=100&vendor=sampledemovendor&lastDocId=347953" \
  --header "Authorization: <OAUTH_AUTHENTICATION_HEADER>" \
  --header "Accept: application/xml" \
  --header "Content-Type: application/xml"

Response Examples

{
  "status": true,
  "statusCode": "OK",
  "requestId": "97b93744-de91-4318-a8ef-9e5378858be2",
  "timeStamp": "2021-12-16 00:50:13.726",
  "responseData": {
    "vendorName": "jobsrus",
    "locale": "en_us",
    "instanceType": "SPECTRUM",
    "resultsCount": 50,
    "lastdocid": "1000026",
    "getdocids": {
      "id": [
        "004763fa-b293-488a-b005-470a8667663b",
        "01ad6eda-ea72-4c22-91cb-7319a92090bb",
        "024d129d-ba80-4c18-bf21-1367bd1bd257",
        "02b50b67-1033-4de7-9c1b-faca989ca256",
        "0597637c-51d8-4734-8fbf-4a95c2f3eaa7",
        "06c29a6c-2e6a-45f8-8aed-b4cc03d35e54",
        "079a4bbb-a69f-4f54-9cd4-46c3048e3baa",
        "0957e0ce-248a-482f-a011-c59dc2fd328f",
        "096773ca-b146-4385-af6c-1b60626d3a9e",
        "09c7152a-abae-4198-acb2-3f01ce9b4d69",
        "0b03036c-b5d4-4b55-bf54-74d06a126c51",
        "0b7b1fc6-6d9e-48a0-8ff4-14c6ed6f325b",
        "0ba3b25f-2285-4c1f-b398-d8eb1df2945a",
        "0c1f4be4-7de3-4205-b95a-cda490fcf1e8",
        "0cf48bd3-e338-4169-9bb0-056b880f9f77",
        "0d20e6c5-dbf5-4a85-8c2c-5bf23309cb5f",
        "0d93762e-00c4-4d16-bf22-c45ad42cdf97",
        "0e56f9fd-12c4-4e42-b865-1a77485b756a",
        "0ef321d1-9cb7-459c-b3f2-811715721d90",
        "0f113288-07d8-4413-98f1-0ecc51caa04b",
        "0f14f621-a3c3-43e6-9fe9-00bf05f8c4d9",
        "0f1a9885-183b-4e96-bc6d-9b05e6e3e90a",
        "0f25732c-9ecf-4da2-a636-ce9424e7c7f6",
        "0fefa9b5-32ff-43d2-a208-b2439c74ba80",
        "1000001",
        "1000002",
        "1000003",
        "1000004",
        "1000005",
        "1000006",
        "1000007",
        "1000008",
        "1000009",
        "1000010",
        "1000011",
        "1000012",
        "1000013",
        "1000014",
        "1000015",
        "1000016",
        "1000017",
        "1000018",
        "1000019",
        "1000020",
        "1000021",
        "1000022",
        "1000023",
        "1000024",
        "1000025",
        "1000026"
      ]
    },
    "totalFound": 9078
  }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetJobDocIdsResponse>
    <Status>true</Status>
    <StatusCode>OK</StatusCode>
    <RequestId>b15c5e20-8fe8-4bfc-a346-1ef8b01a38ec</RequestId>
    <ResponseData>
        <VendorName>jobsrus</VendorName>
        <Locale>en_us</Locale>
        <InstanceType>SPECTRUM</InstanceType>
        <ResultsCount>50</ResultsCount>
        <Lastdocid>1000026</Lastdocid>
        <Getdocids>
            <id>004763fa-b293-488a-b005-470a8667663b</id>
            <id>01ad6eda-ea72-4c22-91cb-7319a92090bb</id>
            <id>024d129d-ba80-4c18-bf21-1367bd1bd257</id>
            <id>02b50b67-1033-4de7-9c1b-faca989ca256</id>
            <id>0597637c-51d8-4734-8fbf-4a95c2f3eaa7</id>
            <id>06c29a6c-2e6a-45f8-8aed-b4cc03d35e54</id>
            <id>079a4bbb-a69f-4f54-9cd4-46c3048e3baa</id>
            <id>0957e0ce-248a-482f-a011-c59dc2fd328f</id>
            <id>096773ca-b146-4385-af6c-1b60626d3a9e</id>
            <id>09c7152a-abae-4198-acb2-3f01ce9b4d69</id>
            <id>0b03036c-b5d4-4b55-bf54-74d06a126c51</id>
            <id>0b7b1fc6-6d9e-48a0-8ff4-14c6ed6f325b</id>
            <id>0ba3b25f-2285-4c1f-b398-d8eb1df2945a</id>
            <id>0c1f4be4-7de3-4205-b95a-cda490fcf1e8</id>
            <id>0cf48bd3-e338-4169-9bb0-056b880f9f77</id>
            <id>0d20e6c5-dbf5-4a85-8c2c-5bf23309cb5f</id>
            <id>0d93762e-00c4-4d16-bf22-c45ad42cdf97</id>
            <id>0e56f9fd-12c4-4e42-b865-1a77485b756a</id>
            <id>0ef321d1-9cb7-459c-b3f2-811715721d90</id>
            <id>0f113288-07d8-4413-98f1-0ecc51caa04b</id>
            <id>0f14f621-a3c3-43e6-9fe9-00bf05f8c4d9</id>
            <id>0f1a9885-183b-4e96-bc6d-9b05e6e3e90a</id>
            <id>0f25732c-9ecf-4da2-a636-ce9424e7c7f6</id>
            <id>0fefa9b5-32ff-43d2-a208-b2439c74ba80</id>
            <id>1000001</id>
            <id>1000002</id>
            <id>1000003</id>
            <id>1000004</id>
            <id>1000005</id>
            <id>1000006</id>
            <id>1000007</id>
            <id>1000008</id>
            <id>1000009</id>
            <id>1000010</id>
            <id>1000011</id>
            <id>1000012</id>
            <id>1000013</id>
            <id>1000014</id>
            <id>1000015</id>
            <id>1000016</id>
            <id>1000017</id>
            <id>1000018</id>
            <id>1000019</id>
            <id>1000020</id>
            <id>1000021</id>
            <id>1000022</id>
            <id>1000023</id>
            <id>1000024</id>
            <id>1000025</id>
            <id>1000026</id>
        </Getdocids>
        <TotalFound>9078</TotalFound>
    </ResponseData>
    <TimeStamp>2021-12-16 00:49:33.756</TimeStamp>
</GetJobDocIdsResponse>