Classic ASP / Postman API / Sync relations with schema
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.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")
http.SetRequestHeader "X-API-Key","{{postman_api_key}}"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequest("PUT","https://api.getpostman.com/apis/:apiId/versions/:apiVersionId/:entityType/:entityId/syncWithSchema")
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
Response.Write "<pre>" & Server.HTMLEncode( resp.StatusCode) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.BodyStr) & "</pre>"
%>
</body>
</html>
Curl Command
curl -X PUT
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/apis/:apiId/versions/:apiVersionId/:entityType/:entityId/syncWithSchema
Postman Collection Item JSON
{
"name": "Sync relations with schema",
"request": {
"method": "PUT",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/apis/:apiId/versions/:apiVersionId/:entityType/:entityId/syncWithSchema",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
":apiId",
"versions",
":apiVersionId",
":entityType",
":entityId",
"syncWithSchema"
],
"variable": [
{
"key": "apiId",
"value": "{{apiId}}",
"description": "Id of the API"
},
{
"key": "apiVersionId",
"value": "{{apiVersionId}}",
"description": "Id of the API version"
},
{
"key": "entityType",
"value": "{{entityType}}",
"description": "Relation type (e.g documentation, contracttest, integrationtest, testsuite, mock, monitor)"
},
{
"key": "entityId",
"value": "{{entityId}}",
"description": "Relation id"
}
]
},
"description": "This call allows you to keep the relation in sync with the API schema.\n\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Failed to sync",
"originalRequest": {
"method": "PUT",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/apis/:apiId/versions/:apiVersionId/:entityType/:entityId/syncWithSchema",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
":apiId",
"versions",
":apiVersionId",
":entityType",
":entityId",
"syncWithSchema"
],
"variable": [
{
"key": "apiId",
"value": ""
},
{
"key": "apiVersionId",
"value": ""
},
{
"key": "entityType",
"value": ""
},
{
"key": "entityId",
"value": ""
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"error\": {\n \"name\": \"validationFailed\",\n \"message\": \"Unable to validate. Only the OpenAPI 3.0 schema format is supported.\"\n }\n}"
},
{
"name": "Successful sync",
"originalRequest": {
"method": "PUT",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/apis/:apiId/versions/:apiVersionId/:entityType/:entityId/syncWithSchema",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
":apiId",
"versions",
":apiVersionId",
":entityType",
":entityId",
"syncWithSchema"
],
"variable": [
{
"key": "apiId",
"value": "{{apiId}}",
"description": "Id of the API"
},
{
"key": "apiVersionId",
"value": "{{apiVersionId}}",
"description": "Id of the API version"
},
{
"key": "entityType",
"value": "{{entityType}}",
"description": "Relation type (e.g documentation, contracttest, integrationtest, testsuite, mock, monitor)"
},
{
"key": "entityId",
"value": "{{entityId}}",
"description": "Relation id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"success\": true\n}"
}
]
}
