Classic ASP / Postman API / Update an API Version
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
set http = Server.CreateObject("Chilkat_9_5_0.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.
' {
' "version": {
' "name": "2.0"
' }
' }
set json = Server.CreateObject("Chilkat_9_5_0.JsonObject")
success = json.UpdateString("version.name","2.0")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "X-API-Key","{{postman_api_key}}"
set sbRequestBody = Server.CreateObject("Chilkat_9_5_0.StringBuilder")
success = json.EmitSb(sbRequestBody)
' resp is a Chilkat_9_5_0.HttpResponse
Set resp = http.PTextSb("PUT","https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
set sbResponseBody = Server.CreateObject("Chilkat_9_5_0.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
set jResp = Server.CreateObject("Chilkat_9_5_0.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"
respStatusCode = resp.StatusCode
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.Header) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"
Response.End
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "version": {
' "id": "d71cf403-c549-4c7c-9dc6-a6a105acf67c",
' "name": "2.0",
' "createdAt": "2019-07-26T11:24:15.000Z",
' "updatedAt": "2019-08-09T09:27:36.000Z",
' "api": "2b95d07c-8379-4bd1-924f-e7e1af185284",
' "createdBy": "12",
' "updatedBy": "5665"
' }
' }
' 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("version.id")
Name = jResp.StringOf("version.name")
CreatedAt = jResp.StringOf("version.createdAt")
UpdatedAt = jResp.StringOf("version.updatedAt")
Api = jResp.StringOf("version.api")
CreatedBy = jResp.StringOf("version.createdBy")
UpdatedBy = jResp.StringOf("version.updatedBy")
%>
</body>
</html>
Curl Command
curl -X PUT
-H "X-API-Key: {{postman_api_key}}"
-H "Content-Type: application/json"
-d '{
"version": {
"name": "2.0"
}
}'
https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}
Postman Collection Item JSON
{
"name": "Update an API Version",
"request": {
"method": "PUT",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"version\": {\n\t\t\"name\": \"2.0\"\n\t}\n}"
},
"url": {
"raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
"{{apiId}}",
"versions",
"{{apiVersionId}}"
]
},
"description": "This call updates an existing API Version. \n\nRequest body should contain a `version` object with the fields which need to be updated. Only field which can be updated is `name`.\n\nResponse contains a `version` object with all the details related to the created API Version, namely, `id`, `name`, `api` etc.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Update an API version",
"originalRequest": {
"method": "PUT",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"version\": {\n\t\t\"name\": \"2.0\"\n\t}\n}"
},
"url": {
"raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{versionId}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
"{{apiId}}",
"versions",
"{{versionId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n\t\"version\": {\n\t\t\"id\": \"d71cf403-c549-4c7c-9dc6-a6a105acf67c\",\n\t \"name\": \"2.0\",\n\t \"createdAt\": \"2019-07-26T11:24:15.000Z\",\n\t \"updatedAt\": \"2019-08-09T09:27:36.000Z\",\n\t \"api\": \"2b95d07c-8379-4bd1-924f-e7e1af185284\",\n\t \"createdBy\": \"12\",\n\t \"updatedBy\": \"5665\"\n\t}\n}"
}
]
}
