Download file using REST API

[Rj27]

Hi All,

I need to download files attached to any incident using REST API.

I will be sending incident detail from my postman. 

Already Referred to attachment api reference docs but could'nt find a solution.

NOTE: I don't have the option to use ui action 

Is this doable?

Thanks in Advance!

[Ankur Bawiskar]

Hi,

So you are trying to send the base64Encoded data to the 3rd party once they consume the endpoint and they will send RITM number.

if yes then please check below

For scoped app use this to get base64data

updated script below

(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {

	// implement resource here

	var arr = [];

	var queryParams = request.queryParams;
	var queryRITM = queryParams.number;

	var gr = new GlideRecord('sc_req_item');
	gr.addQuery('number', queryRITM);
	gr.query();
	while (gr.next()) {

		var ga = new GlideRecord('sys_attachment');
		ga.addQuery('table_sys_id', gr.sys_id);
		ga.query();
		while (ga.next()) {
			var attachsysid = ga.sys_id;
			var filename = ga.file_name;

			var attachmentRec = new GlideRecord('sys_attachment');
			attachmentRec.get(attachsysid);
			var sysAtt = new GlideSysAttachment();
			var base64Data = sysAtt.getContentBase64(attachmentRec);

			var obj = {};
			obj["filename"] = filename;
			obj["attachmentBase64Data"] = base64Data;
			arr.push(obj);
		}
	}

	response.setStatus(200);
	response.setBody(obj);

})(request, response);

your sample json output would look like this

{
  "result": [
    {
      "filename": "sample file.txt",
      "attachmentBase64Data": "base64DataForThisFile"
    },
    {
      "filename": "sample file.docx",
      "attachmentBase64Data": "base64DataForThisFile"
    }
  ]
}

Regards
Ankur

[Rj27]

Hi Ankur,

The json is just returning me the file name.

My requirement is to download the attached file.

I tried  below script but when i click send and download from postman, file is downloaded with name 'response' and not in the correct format. I am asked to select the format in which i want to open the downloaded response.
Also, if there are multiple attachments, then only one file is downloaded.

SCRIPT::

var queryParams = request.queryParams;
var queryRITM = queryParams.number;

var gr = new GlideRecord('sc_req_item');
gr.addQuery('number', queryRITM);
gr.query();
while (gr.next()) {

var ga = new GlideRecord('sys_attachment');
ga.addQuery('table_sys_id', gr.sys_id);
ga.query();
while (ga.next()) {
var obj = {};
var attachsysid = ga.sys_id;
var filename = ga.file_name;

obj['Content-Type'] = "'" + ga.content_type + "'";
response.setStatus(200);
response.setHeaders(obj);
var writer = response.getStreamWriter();
var attachmentStream = new GlideSysAttachmentInputStream(attachsysid);
writer.writeStream(attachmentStream);

[Ankur Bawiskar]

Hi,

I believe as per your script it would download only one.

Usually the attachments are transferred in base64Encoded format when integrated with other 3rd party applications.

Regards
Ankur

[Ankur Bawiskar]

@Rj27 

Hope you are doing good.

Did you get a chance to check on the comments?

If your query is resolved please mark appropriate response as correct & helpful so that this thread can be closed and others can be benefited by this.

Regards
Ankur

[Hitoshi Ozawa]

I haven't done this yet but there's a attachment api with a get method. There's also a curl and python samples. It's going to be necessary to get the sys_ids before calling this API. Will test it out tomorrow during lunch hours. 🙂

https://developer.servicenow.com/dev.do#!/reference/api/orlando/rest/c_AttachmentAPI#r_AttachmentAPI...