SQL Server / Postman API / Single Mock
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/{{mock_uid}}', @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)
-- {
-- "mock": {
-- "id": "950dcaf2-ec37-4365-b106-ed659cc2ff5d",
-- "owner": "1679925",
-- "uid": "1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d",
-- "collection": "1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf",
-- "environment": "1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511",
-- "mockUrl": "https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.mock.pstmn.io",
-- "name": "mock1",
-- "config": {
-- "headers": [
-- ],
-- "matchBody": false,
-- "matchQueryParams": true,
-- "matchWildcards": true,
-- "delay": null
-- },
-- "createdAt": "2020-12-14T08:12:21.000Z",
-- "updatedAt": "2020-12-15T06:44:37.000Z",
-- "isPublic": false
-- }
-- }
-- 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)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'mock.id'
DECLARE @Owner nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Owner OUT, 'mock.owner'
DECLARE @Uid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Uid OUT, 'mock.uid'
DECLARE @Collection nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Collection OUT, 'mock.collection'
DECLARE @Environment nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Environment OUT, 'mock.environment'
DECLARE @MockUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @MockUrl OUT, 'mock.mockUrl'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'mock.name'
DECLARE @MatchBody int
EXEC sp_OAMethod @jResp, 'BoolOf', @MatchBody OUT, 'mock.config.matchBody'
DECLARE @MatchQueryParams int
EXEC sp_OAMethod @jResp, 'BoolOf', @MatchQueryParams OUT, 'mock.config.matchQueryParams'
DECLARE @MatchWildcards int
EXEC sp_OAMethod @jResp, 'BoolOf', @MatchWildcards OUT, 'mock.config.matchWildcards'
DECLARE @Delay nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Delay OUT, 'mock.config.delay'
DECLARE @CreatedAt nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedAt OUT, 'mock.createdAt'
DECLARE @UpdatedAt nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @UpdatedAt OUT, 'mock.updatedAt'
DECLARE @IsPublic int
EXEC sp_OAMethod @jResp, 'BoolOf', @IsPublic OUT, 'mock.isPublic'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'mock.config.headers'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
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/{{mock_uid}}
Postman Collection Item JSON
{
"name": "Single Mock",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/mocks/{{mock_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks",
"{{mock_uid}}"
]
},
"description": "This endpoint fetches you the basic information about a single mock using its `uid`.\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/{{mock_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks",
"{{mock_uid}}"
]
}
},
"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\":\"950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n \"owner\":\"1679925\",\n \"uid\":\"1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n \"collection\":\"1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf\",\n \"environment\": \"1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511\",\n \"mockUrl\":\"https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.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-14T08:12:21.000Z\",\n \"updatedAt\":\"2020-12-15T06:44:37.000Z\",\n \"isPublic\":false\n }\n}"
}
]
}
