Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "mock": {
// "collection": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc",
// "environment": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524"
// }
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('mock.collection','1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc');
$json->UpdateString('mock.environment','1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('X-API-Key','{{postman_api_key}}');
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://api.getpostman.com/mocks','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "mock": {
// "id": "0fca2246-c108-41f5-8454-cc032def329f",
// "owner": "1679925",
// "uid": "1679925-0fca2246-c108-41f5-8454-cc032def329f",
// "collection": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc",
// "environment": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524",
// "mockUrl": "https://0fca2246-c108-41f5-8454-cc032def329f.mock.pstmn.io"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Id = $jResp->stringOf('mock.id');
$Owner = $jResp->stringOf('mock.owner');
$Uid = $jResp->stringOf('mock.uid');
$Collection = $jResp->stringOf('mock.collection');
$Environment = $jResp->stringOf('mock.environment');
$MockUrl = $jResp->stringOf('mock.mockUrl');
?>
Curl Command
curl -X POST
-H "X-API-Key: {{postman_api_key}}"
-H "Content-Type: application/json"
-d '{
"mock": {
"collection": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc",
"environment": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524"
}
}'
https://api.getpostman.com/mocks
Postman Collection Item JSON
{
"name": "Create Mock",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"mock\": {\n\t\t\"collection\": \"1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc\",\n\t\t\"environment\": \"1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524\"\n\t}\n}"
},
"url": {
"raw": "https://api.getpostman.com/mocks",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks"
]
},
"description": "This endpoint allows you to create a mock on a collection. You can also provide an environment UID to resolve any environment variables in the collection.\n\nYou can also specify the context of a workspace to create a mock in directly by passing the `workspace` as a query param.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Create Mock in a Workspace",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"mock\": {\n \"collection\": \"1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc\",\n \"environment\": \"1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524\"\n }\n}"
},
"url": {
"raw": "https://api.getpostman.com/mocks?workspace={{workspace_id}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks"
],
"query": [
{
"key": "workspace",
"value": "{{workspace_id}}",
"description": "The workspace ID in which the mock will be created"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"mock\": {\n \"id\": \"0fca2246-c108-41f5-8454-cc032def329f\",\n \"owner\": \"1679925\",\n \"uid\": \"1679925-0fca2246-c108-41f5-8454-cc032def329f\",\n \"collection\": \"1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc\",\n \"environment\": \"1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524\",\n \"mockUrl\": \"https://0fca2246-c108-41f5-8454-cc032def329f.mock.pstmn.io\"\n }\n}"
},
{
"name": "Successful Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"mock\": {\n\t\t\"collection\": \"1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc\",\n\t\t\"environment\": \"1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524\"\n\t}\n}"
},
"url": {
"raw": "https://api.getpostman.com/mocks",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "The mime type of this content",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"mock\": {\n \"id\": \"0fca2246-c108-41f5-8454-cc032def329f\",\n \"owner\": \"1679925\",\n \"uid\": \"1679925-0fca2246-c108-41f5-8454-cc032def329f\",\n \"collection\": \"1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc\",\n \"environment\": \"1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524\",\n \"mockUrl\": \"https://0fca2246-c108-41f5-8454-cc032def329f.mock.pstmn.io\"\n }\n}"
}
]
}
