SQL Server / Postman API / All Mocks
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-API-Key', '{{postman_api_key}}'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.getpostman.com/mocks', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @id nvarchar(4000)
DECLARE @owner nvarchar(4000)
DECLARE @uid nvarchar(4000)
DECLARE @collection nvarchar(4000)
DECLARE @environment nvarchar(4000)
DECLARE @mockUrl nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @MatchBody int
DECLARE @MatchQueryParams int
DECLARE @MatchWildcards int
DECLARE @Delay nvarchar(4000)
DECLARE @createdAt nvarchar(4000)
DECLARE @updatedAt nvarchar(4000)
DECLARE @isPublic int
DECLARE @j int
DECLARE @count_j int
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'mocks'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'mocks[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @owner OUT, 'mocks[i].owner'
EXEC sp_OAMethod @jResp, 'StringOf', @uid OUT, 'mocks[i].uid'
EXEC sp_OAMethod @jResp, 'StringOf', @collection OUT, 'mocks[i].collection'
EXEC sp_OAMethod @jResp, 'StringOf', @environment OUT, 'mocks[i].environment'
EXEC sp_OAMethod @jResp, 'StringOf', @mockUrl OUT, 'mocks[i].mockUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'mocks[i].name'
EXEC sp_OAMethod @jResp, 'BoolOf', @MatchBody OUT, 'mocks[i].config.matchBody'
EXEC sp_OAMethod @jResp, 'BoolOf', @MatchQueryParams OUT, 'mocks[i].config.matchQueryParams'
EXEC sp_OAMethod @jResp, 'BoolOf', @MatchWildcards OUT, 'mocks[i].config.matchWildcards'
EXEC sp_OAMethod @jResp, 'StringOf', @Delay OUT, 'mocks[i].config.delay'
EXEC sp_OAMethod @jResp, 'StringOf', @createdAt OUT, 'mocks[i].createdAt'
EXEC sp_OAMethod @jResp, 'StringOf', @updatedAt OUT, 'mocks[i].updatedAt'
EXEC sp_OAMethod @jResp, 'BoolOf', @isPublic OUT, 'mocks[i].isPublic'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'mocks[i].config.headers'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
