Response body array assertions in Postman

Introduction

We check arrays in response bodies to make sure the data we get is correct and complete. This helps us trust the API works as expected.

When you want to confirm the API returns a list of items, like users or products.

When you need to check that the array has the right number of elements.

When you want to verify specific values exist inside the array.

When you want to ensure each item in the array has certain properties.

When you want to test that the array is not empty before using its data.

Syntax

Postman

pm.test("Test description", function () {
    let jsonData = pm.response.json();
    pm.expect(jsonData.arrayName).to.be.an('array');
    pm.expect(jsonData.arrayName).to.have.lengthOf(expectedLength);
    pm.expect(jsonData.arrayName).to.include(expectedValue);
    pm.expect(jsonData.arrayName[0]).to.have.property('propertyName');
});

Use pm.response.json() to parse the response body as JSON.

Use pm.expect() with Chai assertions to check array properties.

Examples

This checks that the response has a key 'users' and it is an array.

Postman

pm.test("Response has an array called users", function () {
    let jsonData = pm.response.json();
    pm.expect(jsonData.users).to.be.an('array');
});

This checks the 'users' array contains exactly 3 elements.

Postman

pm.test("Users array has 3 items", function () {
    let jsonData = pm.response.json();
    pm.expect(jsonData.users).to.have.lengthOf(3);
});

This checks that among the users, there is one with the name 'Alice'.

Postman

pm.test("Users array includes a user named 'Alice'", function () {
    let jsonData = pm.response.json();
    let userNames = jsonData.users.map(user => user.name);
    pm.expect(userNames).to.include('Alice');
});

This checks the first user object has an 'id' property.

Postman

pm.test("First user has an 'id' property", function () {
    let jsonData = pm.response.json();
    pm.expect(jsonData.users[0]).to.have.property('id');
});

Sample Program

This test checks that the response has an 'items' array with exactly 2 elements. It also verifies that one of the items is named 'Book' and that the first item has a 'price' property.

Postman

pm.test("Validate response body array assertions", function () {
    let jsonData = pm.response.json();
    
    // Check 'items' is an array
    pm.expect(jsonData.items).to.be.an('array');
    
    // Check array length is 2
    pm.expect(jsonData.items).to.have.lengthOf(2);
    
    // Check array includes an item with name 'Book'
    let itemNames = jsonData.items.map(item => item.name);
    pm.expect(itemNames).to.include('Book');
    
    // Check first item has 'price' property
    pm.expect(jsonData.items[0]).to.have.property('price');
});

Important Notes

Array assertions help catch errors early by confirming the structure and content of response data.

Common mistake: Forgetting to parse the response body as JSON before assertions.

Use array assertions when you expect multiple items, and use object assertions for single items.

Summary

Response body array assertions check if the API returns the correct list of items.

We verify array type, length, contents, and properties of items inside.

These checks help ensure the API data is reliable and complete.

Practice

1. What does a response body array assertion in Postman primarily check?

easy

A. If the API returns a list of items as expected

B. If the API response time is under 1 second

C. If the API headers contain authentication tokens

D. If the API URL is correctly formatted

Solution

1. Step 1: Understand the purpose of response body array assertions

   These assertions verify the data returned by the API, especially when it should be a list or array of items.

2. Step 2: Identify what is checked in the response body

   We check if the response contains an array, its length, and the properties of each item to ensure data correctness.

3. Final Answer:

   If the API returns a list of items as expected -> Option A

4. Quick Check:

   Response body array assertions check list presence [OK]

Hint: Focus on verifying the list of items in the response body [OK]

Common Mistakes:

• Confusing response time with response content
• Checking headers instead of body data
• Assuming URL format is part of body assertions

2. Which of the following is the correct Postman test code to assert that the response body is an array?

easy

A. pm.test('Response is array', () => pm.expect(pm.response.json()).to.be.a('string'))

B. pm.test('Response is array', () => pm.expect(pm.response.text()).to.be.an('array'))

C. pm.test('Response is array', () => pm.expect(pm.response.json()).to.be.an('array'))

D. pm.test('Response is array', () => pm.expect(pm.response.body).to.be.an('object'))

Solution

1. Step 1: Identify the correct method to parse JSON response

   pm.response.json() parses the response body as JSON, which is needed to check if it is an array.

2. Step 2: Use the correct Chai assertion syntax

   to.be.an('array') correctly asserts the type is an array. Using pm.response.text() or wrong types will fail.

3. Final Answer:

   pm.test('Response is array', () => pm.expect(pm.response.json()).to.be.an('array')) -> Option C

4. Quick Check:

   Use pm.response.json() and to.be.an('array') [OK]

Hint: Use pm.response.json() with to.be.an('array') for array checks [OK]

Common Mistakes:

• Using pm.response.text() instead of json()
• Checking for 'string' instead of 'array'
• Using pm.response.body without parsing

3. Given this response body: [{"id":1,"name":"Alice"},{"id":2,"name":"Bob"} ], what will this Postman test output?

pm.test('Check length', () => {
  const jsonData = pm.response.json();
  pm.expect(jsonData.length).to.eql(3);
});

medium

A. Test fails because length is 2

B. Test passes because length is undefined

C. Test throws syntax error

D. Test passes because length is 3

Solution

1. Step 1: Parse the response and check array length

   The response JSON is an array with 2 objects, so jsonData.length equals 2.

2. Step 2: Compare expected length with actual length

   The test expects length 3, but actual length is 2, so the assertion fails.

3. Final Answer:

   Test fails because length is 2 -> Option A

4. Quick Check:

   Array length is 2, expected 3, test fails [OK]

Hint: Count array items carefully before asserting length [OK]

Common Mistakes:

• Assuming length is 3 without counting items
• Expecting syntax error when code is correct
• Confusing length property with array content

4. Identify the error in this Postman test code that checks if all items in the response array have an 'id' property:

pm.test('All items have id', () => {
  const jsonData = pm.response.json();
  jsonData.forEach(item => {
    pm.expect(item.id).to.exist;
  });
});

medium

A. pm.expect syntax is incorrect

B. Should use pm.expect(item).to.have.property('id') instead

C. forEach cannot be used on jsonData

D. No error, the test is correct

Solution

1. Step 1: Check if jsonData is an array and forEach usage

   pm.response.json() returns an array, so forEach is valid to iterate over items.

2. Step 2: Validate assertion syntax for property existence

   pm.expect(item.id).to.exist correctly asserts that the 'id' property exists on each item.

3. Final Answer:

   No error, the test is correct -> Option D

4. Quick Check:

   forEach and to.exist used correctly [OK]

Hint: Use forEach with to.exist to check property presence [OK]

Common Mistakes:

• Thinking forEach can't be used on arrays
• Confusing to.exist with to.have.property
• Incorrect pm.expect syntax assumptions

5. You want to assert that the response array contains at least one item with status equal to active. Which Postman test code correctly does this?

hard

A. pm.test('Has active status', () => {
const jsonData = pm.response.json();
pm.expect(jsonData.every(item => item.status === 'active')).to.be.true;
});

B. pm.test('Has active status', () => {
const jsonData = pm.response.json();
pm.expect(jsonData.some(item => item.status === 'active')).to.be.true;
});

C. pm.test('Has active status', () => {
const jsonData = pm.response.json();
pm.expect(jsonData.find(item => item.status === 'active')).to.be.undefined;
});

D. pm.test('Has active status', () => {
const jsonData = pm.response.json();
pm.expect(jsonData.filter(item => item.status === 'active').length).to.eql(0);
});

Solution

1. Step 1: Understand the requirement to find at least one item with status 'active'

   The method some() returns true if any item matches the condition, which fits the requirement.

2. Step 2: Analyze each option's logic

   pm.test('Has active status', () => { const jsonData = pm.response.json(); pm.expect(jsonData.some(item => item.status === 'active')).to.be.true; }); uses some() and expects true, correctly asserting presence. pm.test('Has active status', () => { const jsonData = pm.response.json(); pm.expect(jsonData.every(item => item.status === 'active')).to.be.true; }); uses every(), which requires all items to be active. pm.test('Has active status', () => { const jsonData = pm.response.json(); pm.expect(jsonData.find(item => item.status === 'active')).to.be.undefined; }); expects find() result to be undefined, which means no active items. pm.test('Has active status', () => { const jsonData = pm.response.json(); pm.expect(jsonData.filter(item => item.status === 'active').length).to.eql(0); }); expects filter length to be 0, meaning no active items.

3. Final Answer:

   pm.test('Has active status', () => { const jsonData = pm.response.json(); pm.expect(jsonData.some(item => item.status === 'active')).to.be.true; }); -> Option B

4. Quick Check:

   Use some() to check at least one match [OK]

Hint: Use some() to check if any array item matches condition [OK]

Common Mistakes:

• Using every() which requires all items to match
• Checking for undefined instead of true
• Asserting zero length for presence check