How to create a Scripted REST API to attachment?

Snow20 · ‎11-27-2019

Hi Community expert,

Thanks

Service_RNow · ‎11-27-2019

Hi,

I think that would be easier than figuring out how to script it but if you have to script it you'll probably find the GlideSysAttachment API useful.

https://developer.servicenow.com/app.do#!/api_doc?v=london&id=r_SGSA-GlideSysAttachment

Attachment API

You can use the same process as mentioned in this link. With slight modifications, you can get to download all attachments.

https://www.servicenowguru.com/scripting/download-attachments-zip-file/#comment-34336

Please note that the script might take time and if you want to limit to N number of records, you can do so in the below script.

Few points to Note

1. The count variable is added to the file name to avoid duplicate file names. If there are duplicate file names, the zip process will break.

2. The script is modified to simply query sys_attachment and download them in the processor. It is not capturing any parameters from UI action as such.

3. Create the UI action as a form button on any incident or any other table.

  var zipName = 'attachments.zip';
  var StringUtil = GlideStringUtil;
  var gr = new GlideRecord('sys_attachment');
  gr.query();
  if (gr.next()){
    g_response.setHeader('Pragma', 'public');
    g_response.addHeader('Cache-Control', 'max-age=0');
    g_response.setContentType('application/octet-stream');
    g_response.addHeader('Content-Disposition', 'attachment;filename=' + zipName);
    var out = new Packages.java.util.zip.ZipOutputStream(g_response.getOutputStream());
    var count=0;
    while (gr.next()){
        var sa = new GlideSysAttachment();
        var binData = sa.getBytes(gr); 
        //add counter so that the filename is NOT duplicate
        var file = gr.file_name+"-"+count; 
	gs.info("Entered into this loop"+file);
	addBytesToZip(out, zipName, file, binData);
        count ++;
    }
    // Complete the ZIP file
    out.close();
}

function addBytesToZip (out, dir, file, stream){
    // Add ZIP entry to output stream.
    out.putNextEntry(new Packages.java.util.zip.ZipEntry(file));
    out.write(stream, 0, stream.length);
    out.closeEntry();
}

I ran this in my dev instance and it worked fine. The script takes time to download all the attachments. To test the script, i suggest you break the loop above at 5 or 10 records.

Mark the comment as correct and also helpful once worked.

View solution in original post

Bhavana20 · ‎05-25-2021

Hye if you got the solution, can you please share it.

Thanks

Swarupa1 · ‎04-12-2021

create custom processors is it best practice?

KLewis · ‎01-26-2022

Did anyone figure out how to do this without a custom processor?

Astha5 · ‎05-08-2023

Hi @Service_RNow ,

Packages.java.util.zip.ZipEntry is not identified in the REST API code, hence this package call is throwing error. Are there any alternate solutions to download attachments in ZIP format in ServiceNow?

Thank you

Khushbu Chhapar · ‎11-27-2019

Hi,

Please refer link below :

https://docs.servicenow.com/bundle/geneva-servicenow-platform/page/integrate/inbound_rest/reference/r_AttachmentAPI-GET.html