TCL / Postman API / Sync relations with schema
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_SetRequestHeader $http "X-API-Key" "{{postman_api_key}}"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "PUT" "https://api.getpostman.com/apis/:apiId/versions/:apiVersionId/:entityType/:entityId/syncWithSchema"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
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}"
}
]
}