Playwright Power Platform Toolkit v0.0.4

Playwright Power Platform Toolkit / validateApiResponse

Function: validateApiResponse()

validateApiResponse(response): Promise<ApiResponseValidation>

Defined in: utils/api-utilities.ts:282

Validate API response and extract common fields

Validates an API response and extracts commonly needed fields including status code, headers, request ID, and parsed response data.

Parameters

response

any

Playwright APIResponse object

Returns

Promise<ApiResponseValidation>

Response validation result with extracted fields

Example

const response = await apiContext.get('/api/apps');
const validation = await validateApiResponse(response);
 
if (validation.success) {
  console.log(`Found ${validation.data.value.length} apps`);
} else {
  console.error(`Request failed with status ${validation.status}`);
  console.error(`Correlation ID: ${validation.requestId}`);
}