api response

$.response API

Represents the HTTP response currently being populated. This API is used for returning a result response to the xsk HTTP service caller.

Reference

• SAP Help

https://help.sap.com/doc/3de842783af24336b6305a3c0223a369/2.0.03/en-US/$.web.WebResponse.html

• Module

https://github.com/SAP/xsk/tree/main/modules/api/api-xsjs/src/main/resources/xsk/web

• Sample usage:

function filterCarsByColor(color) {
  // ...filter operation
}

if ($.request.method === $.net.http.GET) {
  // get query parameter color
  let color = $.request.parameters.get("color");

  // handle some request operation if color param has been passed else return bad request
  if (color) {
    let cars = filterCarsByColor(color);

    // send response with filtered cars by color
    $.response.contentType = "application/json";
    $.response.status = $.net.http.OK;
    $.response.setBody(JSON.stringify({
      "cars": cars
    }));
  } else {
    $.response.status = $.net.http.BAD_REQUEST;
    $.response.setBody(JSON.stringify({
      "error": "missing color parameter"
    }));
  }
} else {
  // unsupported method
  $.response.status = $.net.http.NOT_FOUND;
  $.response.setBody(JSON.stringify({
    "error": "not found"
  }));
}

• Coverage

Members	Description	Status
body	The body of the response.	✅
cacheControl	Easy access to the cache control header of the entity.	❌
contentType	The content type of the entity.	⚠️
cookies	The cookies associated with the entity.	❌
entities	The sub-entities of the entity.	❌
headers	The headers of the entity.	✅
status	The HTTP status code of the outgoing HTTP response.	⚠️

Methods	Description	Status
setBody()	Sets the body of the entity.	✅
followUp()	Enable running a follow up job that executes in the background.	❌

• Issues

https://github.com/SAP/xsk/issues/13

• Unit Tests

https://github.com/SAP/xsk/tree/main/modules/engines/engine-xsjs/src/test/resources/test/xsk/response.xsjs

• Integration Tests ❌