SQL Server / Postman API / Create API
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
DECLARE @iTmp0 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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "api": {
-- "name": "Sync Service API",
-- "summary": "This is supposed to be a short summary.",
-- "description": "This is description."
-- }
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'api.name', 'Sync Service API'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'api.summary', 'This is supposed to be a short summary.'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'api.description', 'This is description.'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-API-Key', '{{postman_api_key}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.getpostman.com/apis?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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 @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "api": {
-- "id": "387c2863-6ee3-4a56-8210-225f774edade",
-- "name": "Sync API",
-- "summary": "This is a summary",
-- "description": "This is supposed to handle markdown *descriptions*.",
-- "createdBy": "5665",
-- "createdAt": "2019-02-12 19:34:49",
-- "updatedAt": "2019-02-12 19:34:49"
-- }
-- }
-- 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, 'api.id'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'api.name'
DECLARE @Summary nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Summary OUT, 'api.summary'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'api.description'
DECLARE @CreatedBy nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedBy OUT, 'api.createdBy'
DECLARE @CreatedAt nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedAt OUT, 'api.createdAt'
DECLARE @UpdatedAt nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @UpdatedAt OUT, 'api.updatedAt'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "X-API-Key: {{postman_api_key}}"
-H "Content-Type: application/json"
-d '{
"api": {
"name": "Sync Service API",
"summary": "This is supposed to be a short summary.",
"description": "This is description."
}
}'
https://api.getpostman.com/apis?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605
Postman Collection Item JSON
{
"name": "Create API",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"const jsonData = pm.response.json();",
"",
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Should have valid response\", function () {",
" pm.expect(jsonData.data).to.include.all.keys('id', 'name', 'createdAt', 'createdBy', 'updatedAt', 'updatedBy');",
" ",
" pm.expect(jsonData.data.name).to.be.equal('New API');",
" pm.expect(jsonData.data.id).to.be.ok;",
" pm.expect(jsonData.data.createdAt).to.be.ok;",
" pm.expect(jsonData.data.createdBy).to.be.ok;",
" pm.expect(jsonData.data.updatedAt).to.be.ok;",
" pm.expect(jsonData.data.updatedBy).to.be.ok;",
"});",
"",
"pm.environment.set(\"apiId\", jsonData.data.id); "
]
}
}
],
"request": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"api\": {\n\t\t\"name\": \"Sync Service API\",\n\t\t\"summary\": \"This is supposed to be a short summary.\",\n\t\t\"description\": \"This is description.\"\n\t}\n}"
},
"url": {
"raw": "https://api.getpostman.com/apis?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis"
],
"query": [
{
"key": "workspace",
"value": "c90a3482-f80d-43d6-9dfb-0830f5e43605"
}
]
},
"description": "This call creates a new API with a default API Version. \n\nRequest body should contain an `api` object which should atleast have a property `name`.\n\nResponse contains an `api` object with all the details related to the created API, namely, `id`, `name`, `summary`, `description`, etc. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Create API",
"originalRequest": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"api\": {\n\t\t\"name\": \"Sync Service API\",\n\t\t\"summary\": \"This is supposed to be a short summary.\",\n\t\t\"description\": \"This is description.\"\n\t}\n}"
},
"url": {
"raw": "https://api.getpostman.com/apis?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis"
],
"query": [
{
"key": "workspace",
"value": "c90a3482-f80d-43d6-9dfb-0830f5e43605"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n\t\"api\": {\n\t\t\"id\": \"387c2863-6ee3-4a56-8210-225f774edade\",\n\t\t\"name\": \"Sync API\",\n\t\t\"summary\": \"This is a summary\",\n\t\t\"description\": \"This is supposed to handle markdown *descriptions*.\",\n\t\t\"createdBy\": \"5665\",\n\t\t\"createdAt\": \"2019-02-12 19:34:49\",\n\t\t\"updatedAt\": \"2019-02-12 19:34:49\"\n\t}\n}"
}
]
}
