Syntax

Tip: Click the eyeball icon () in code blocks to toggle the visibility of the hidden lines.

Click here to view Example tests for the following syntax.

Qase Id

You can link multiple Qase Ids to a single test. Here’s an example

// qase: 10
// Qase: 1, 2, 3
pm.test('expect response be 200', function() {
  pm.response.to.be.info
})

Using parameters with a Data file

Newman allows you to leverage parameters from data files to make your API tests more dynamic and efficient. By utilizing the --data or -d option when running a collection, you can feed your tests with various input sets. The data files can be formatted as either JSON or CSV.

Example Data File

Consider the following data.json file, which contains user data structured as complex objects:

[
  {
    "userid": 1,
    "user": {
      "name": "Leanne Graham"
    }
  },
  {
    "userid": 2,
    "user": {
      "name": "Ervin Howell"
    }
  },
  {
    "userid": 3,
    "user": {
      "name": "Clementine Bauch"
    }
  }
]

Example Tests

Below are example tests that utilize the data parameters defined in the data file:

 qase.parameters: userid, user.name
pm.test('Status code is 200', function () {
    pm.response.to.have.status(200);
});

 qase.parameters: userid
pm.test('Response has correct userId', function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.id).to.eql(parseInt(pm.iterationData.get('userid')));
});,
,
pm.test('Response has correct name', function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.name).to.eql(pm.iterationData.get('user.name'));
});

You also can specify parameters on collection or folder level. In this case, all tests in collection or folder will have these parameters. If test has own parameters, they will be merged with collection or folder parameters.

{
  "info": {
    "_postman_id": "12345",
    "name": "User Collection",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": [
    {
      "name": "Get User Info",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "https://jsonplaceholder.typicode.com/users/{{userid}}",
          "host": [
            "jsonplaceholder",
            "typicode",
            "com"
          ],
          "path": [
            "users",
            "{{userid}}"
          ]
        }
      },
      "event": [
        {
          "listen": "test",
          "script": {
            "type": "text/javascript",
            "exec": [
              "// qase.parameters: userid, user.name",
              "pm.test('Status code is 200', function () {",
              "    pm.response.to.have.status(200);",
              "});",
            ]
          }
        }
      ]
    }
  ]
}

Expected Behavior

When you run the tests, the following behavior is expected:

In the first test - Status code is 200 test, both userId and user.name will be passed as parameters.
In the Response has correct userId test, only the userId parameter will be passed.

In the Response has correct name test, by default, test will not have any parameters passed. But you can enable specific option in config file to pass all parameters from data file if test have not commented qase.parameters line.