Objective-C / Postman API / All Mocks
Back to Collection Items
#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
[http SetRequestHeader: @"X-API-Key" value: @"{{postman_api_key}}"];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://api.getpostman.com/mocks" sbContent: sbResponseBody];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",http.LastHeader);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "mocks": [
// {
// "id": "e782b64e-406b-4a6c-8fe9-9ebe84aeb706",
// "owner": "1686168",
// "uid": "1686168-e782b64e-406b-4a6c-8fe9-9ebe84aeb706",
// "collection": "1686168-39fee52f-b806-3ffa-1173-00a6f5b183dc",
// "environment": "1686168-2b90cdd8-e9ac-4086-91c2-bc4cad659511",
// "mockUrl": "https://e782b64e-406b-4a6c-8fe9-9ebe84aeb706.mock.pstmn.io",
// "name": "mock1",
// "config": {
// "headers": [
// ],
// "matchBody": false,
// "matchQueryParams": true,
// "matchWildcards": true,
// "delay": null
// },
// "createdAt": "2020-12-15T06:44:37.000Z",
// "updatedAt": "2020-12-15T06:44:37.000Z",
// "isPublic": false
// },
// {
// "id": "8f9d4b95-780d-455d-af38-772277bc9393",
// "owner": "1686168",
// "uid": "1686168-8f9d4b95-780d-455d-af38-772277bc9393",
// "collection": "1686168-37eeb72f-5d3e-48b4-8022-6b9cca6d2664",
// "mockUrl": "https://8f9d4b95-780d-455d-af38-772277bc93936.mock.pstmn.io",
// "name": "mock2",
// "config": {
// "headers": [
// ],
// "matchBody": false,
// "matchQueryParams": true,
// "matchWildcards": true,
// "delay": null
// },
// "createdAt": "2020-11-15T06:44:37.000Z",
// "updatedAt": "2020-12-15T06:48:37.000Z",
// "isPublic": true
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *id = 0;
NSString *owner = 0;
NSString *uid = 0;
NSString *collection = 0;
NSString *environment = 0;
NSString *mockUrl = 0;
NSString *name = 0;
BOOL MatchBody;
BOOL MatchQueryParams;
BOOL MatchWildcards;
NSString *Delay = 0;
NSString *createdAt = 0;
NSString *updatedAt = 0;
BOOL isPublic;
int j;
int count_j;
int i = 0;
int count_i = [[jResp SizeOfArray: @"mocks"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
id = [jResp StringOf: @"mocks[i].id"];
owner = [jResp StringOf: @"mocks[i].owner"];
uid = [jResp StringOf: @"mocks[i].uid"];
collection = [jResp StringOf: @"mocks[i].collection"];
environment = [jResp StringOf: @"mocks[i].environment"];
mockUrl = [jResp StringOf: @"mocks[i].mockUrl"];
name = [jResp StringOf: @"mocks[i].name"];
MatchBody = [jResp BoolOf: @"mocks[i].config.matchBody"];
MatchQueryParams = [jResp BoolOf: @"mocks[i].config.matchQueryParams"];
MatchWildcards = [jResp BoolOf: @"mocks[i].config.matchWildcards"];
Delay = [jResp StringOf: @"mocks[i].config.delay"];
createdAt = [jResp StringOf: @"mocks[i].createdAt"];
updatedAt = [jResp StringOf: @"mocks[i].updatedAt"];
isPublic = [jResp BoolOf: @"mocks[i].isPublic"];
j = 0;
count_j = [[jResp SizeOfArray: @"mocks[i].config.headers"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/mocks
Postman Collection Item JSON
{
"name": "All Mocks",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/mocks",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks"
]
},
"description": "This endpoint fetches all the mocks that you have created.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Successful Response",
"originalRequest": {
"method": "GET",
"header": [
],
"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": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"mocks\": [\n {\n \"id\": \"e782b64e-406b-4a6c-8fe9-9ebe84aeb706\",\n \"owner\": \"1686168\",\n \"uid\": \"1686168-e782b64e-406b-4a6c-8fe9-9ebe84aeb706\",\n \"collection\": \"1686168-39fee52f-b806-3ffa-1173-00a6f5b183dc\",\n \"environment\": \"1686168-2b90cdd8-e9ac-4086-91c2-bc4cad659511\",\n \"mockUrl\": \"https://e782b64e-406b-4a6c-8fe9-9ebe84aeb706.mock.pstmn.io\",\n \"name\": \"mock1\",\n \"config\": {\n \"headers\": [],\n \"matchBody\": false,\n \"matchQueryParams\": true,\n \"matchWildcards\": true,\n \"delay\": null\n },\n \"createdAt\": \"2020-12-15T06:44:37.000Z\",\n \"updatedAt\": \"2020-12-15T06:44:37.000Z\",\n \"isPublic\": false\n },\n {\n \"id\": \"8f9d4b95-780d-455d-af38-772277bc9393\",\n \"owner\": \"1686168\",\n \"uid\": \"1686168-8f9d4b95-780d-455d-af38-772277bc9393\",\n \"collection\": \"1686168-37eeb72f-5d3e-48b4-8022-6b9cca6d2664\",\n \"mockUrl\": \"https://8f9d4b95-780d-455d-af38-772277bc93936.mock.pstmn.io\",\n \"name\": \"mock2\",\n \"config\": {\n \"headers\": [],\n \"matchBody\": false,\n \"matchQueryParams\": true,\n \"matchWildcards\": true,\n \"delay\": null\n },\n \"createdAt\": \"2020-11-15T06:44:37.000Z\",\n \"updatedAt\": \"2020-12-15T06:48:37.000Z\",\n \"isPublic\": true\n }\n ]\n}"
}
]
}
