How to configure Query job API in service now

How to configure Query job API in service now

Steps :
  1. Submit query job with POST /queryJobs , get the job id in response
  2. Poll query job with GET /queryJobs/{job_id} , if status received is “FINISHED“, go to next step.
  3. Get query job results with GET /queryjobs/${job_id}/results.

Add A REST Message for query job and add the 3 required apis to it :

        

POST query job and get query job id :


  1.         var postData = '{"query":' + query + ', "type":"global"}';
  2.         var message = new sn_ws.RESTMessageV2('Uptycs Query Job', 'POST Query Job');
  3.         message.setStringParameterNoEscape('url', this.url);
  4.         message.setStringParameterNoEscape('customer_id', this.customerId);
  5.         now = new Date();
  6.         message.setRequestHeader('date', now.toUTCString());
  7. message.setRequestHeader('Authorization', authToken;
  8.         message.setRequestHeader('content-type', 'application/json');
  9.         message.setRequestBody(postData);
  10.         var resp = msg.execute();
  11.         var respObj = JSON.parse(resp.getBody());
  12.         var queryJobId = respObj.id;

        

Poll Query job :

  1. createJobInfoMessage: function(queryJobId) {
  2.         var message = new sn_ws.RESTMessageV2('Uptycs Query Job', 'GET Query Job Info');
  3.         message.setStringParameterNoEscape('url', this.url);
  4.         message.setStringParameterNoEscape('customer_id', this.customerId);
  5.         message.setStringParameterNoEscape('job_id', queryJobId);
  6.         message.setRequestHeader('content-type', 'application/json');
  7.         now = new Date();
  8.         message.setRequestHeader('date', now.toUTCString());
  9. message.setRequestHeader('Authorization', authtoken;
  10.         return message;
  11.     },

  13.     pollQueryJob: function(queryJobId) {
  14.         var message = this.createJobInfoMessage(queryJobId);
  15.         var status = 'QUEUED';
  16.         do {
  17.             response = message.execute();
  18. var httpResponseStatus = response.getStatusCode();
  19.             responseObj = JSON.parse(response.getBody());
  20. gs.info('query job status code ' + queryJobId + ' ' + httpResponseStatus);
  21.             status = responseObj.status;
  22. // Check if status is undefined and exit the loop
  23. if (!status || httpResponseStatus != 200) {
  24. gs.error('status is undefined. Exiting the loop.');
  25. break;
  26. }
  27. if (status != 'FINISHED' && status != 'ERROR' && status != 'QUEUED' && status != 'RUNNING') {
  28.                 gs.error('status is not FINISHED, ERROR, RUNNING, or QUEUED.  status is: ' + status);
  29. break;
  30.             }
  31.             comp.wait(5000);
  32.         }
  33.         while (status != 'FINISHED' && status != 'ERROR');

  35.         if (status != 'FINISHED') {
  36.             this.missedSections.push(section);
  37.             gs.error('error: ' + responseObj.error.message.detail);
  38.         }
  39.         var nRows = responseObj.rowCount;
  40.         gs.warn(' nRows recieved: ' + nRows);
  41. return nRows;
  42. },

        

Get query job result :

each call to get results returns 10000 rows, use offset to pull all rows

  1.         var message = new sn_ws.RESTMessageV2('Uptycs Query Job', 'GET Query Jobs Results'); 
  2.         message.setStringParameterNoEscape('url', this.url);
  3.         message.setStringParameterNoEscape('customer_id', this.customerId);
  4.         message.setStringParameterNoEscape('job_id', queryJobId);
  5.         message.setStringParameterNoEscape('offset', offset);
  6.         now = new Date();
  7.         message.setRequestHeader('date', now.toUTCString());
  8.         message.setRequestHeader('content-type', 'application/json');
  9. message.setRequestHeader('Authorization',authToken);
  10.         response = msg.execute();
  11.         responseBody = response.getBody();
  12.         responseObj = JSON.parse(responseBody);
  13.         for (i = 0; i < responseObj.items.length; i++) { 
  14.             // loop over query result rows
  15.         }
        

    • Related Articles

    • API calling via Swagger

      Go To the "Account Settings". Click the "CREATE" button to generate API keys, which will be downloaded in JSON format. The downloaded JSON will contain information such as customerId, API key, API Secret, Domain, DomainSuffix, and other relevant ...

    • How to Retrieve Software Bill of Materials (SBOM) Using the Uptycs API: A Step-by-Step Guide

      To get SBOM(Software Bill of Material) information for your resource through Uptycs API, follow below step → Obtain Access Keys: • Login to the Uptycs console • Go to Account Settings • Create an API Key • Download the API Key in JSON format. For ...

    • Provisioning roles using API

      Overview Starting with Uptycs portal release 46025, Uptycs provides entity level granular user permissions through roles. This document outlines the process to create roles using API - with examples. Procedure -- Create a new role $ urestapi -k ...

    • Create Custom Threat Source using API

      The article includes the API query to create and update the threat source. We support uploading CSV as of now. To create Threat source: curl --location --request POST ...

    • How to check Audit logs under upi_api_audit_logs

      The article contains useful queries about how to use the upt_api_audit_logs to capture audit log events. The api_name column in the table suggests how the api call was made. the following are the different values that can be present: Api call Query ...