Documentation

Extensions Reference: RequestGroup
- RequestGroup
  - id
  - name
  - order
  - parent
  - getChildren
  - getChildRequests
  - getChildGroups
  - appendChild
  - insertChild

Extensions Reference: RequestGroup¶

API Reference
RequestGroup

RequestGroup

RequestGroup¶

Represents a group of Requests like it’s shown in the Requests view.

id

id¶

The unique identifier (UUID).

(Read-only)

name

name¶

The RequestGroup name as it is shown in the Requests view.

(Writable property only for Importers).

order

order¶

The order in its parent RequestGroup or as a root item (orders starts at 0).

(Writable property only for Importers)

parent

parent¶

The parent RequestGroup if any, otherwise null.

(Read-only)

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
  var getSiblings = function(context, requext) {
        var parentGroup = request.parent;
        var siblings;
        if (typeof parentGroup === 'object') {
          console.log("Parent: " + parentGroup.name);
          siblings = parentGroup.getChildRequests();
        }
        else {
          console.log("Request is at root");
          siblings = context.getRootRequests();
        }
        console.log("Has " + (siblings.length - 1) + " siblings (requests)");
        return siblings;
  }

  // Access siblings
  return getSiblings(context, context.getCurrentRequest()).length.toString();
}

getChildren

getChildren¶

Returns: None: Array
Returns all child items (either request or group), as an array of Request and RequestGroup objects.

getChildRequests

getChildRequests¶

Returns: None: Array
Returns all child requests, as an array of Request objects.

getChildGroups

getChildGroups¶

Returns: None: Array
Returns all child requests, as an array of RequestGroup objects.

appendChild

appendChild¶

Argument: child: Request || RequestGroup: None
Child to append to the end of this group.

Adds the child parameter as its last child (a child may be a Request or a RequestGroup object).

function import(context, items, options) {

  // create the request group
  var group = context.createRequestGroup('My Group');

  // create a new request
  var request = context.createRequest("Users", "GET", "http://api.example.com/users");

  // append request to group
  group.appendChild(request);
}

insertChild

insertChild¶

Argument: child: Request || RequestGroup: None
Child to append to the end of this group.

Argument: index: integer: None
index from 0 where to insert the child

Insert the child parameter as its child at the given index (a child may be a Request or a RequestGroup object).

function import(context, items, options) {

  // create a new request
  var request = context.createRequest("Users", "GET", "http://api.example.com/users");

  // get an existing group (as an example)
  var group = context.getRequestGroupByName('My Group');

  // insert request to the beginning of the group
  group.insertChild(request, 0);
}