Chilkat Online Tools

Swift3 / Postman API / Update Mock

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "mock": {
    //     "name": "My Mock Server",
    //     "environment": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19",
    //     "description": "example describing update mock description",
    //     "private": false,
    //     "versionTag": "abf07d3d-f8ec-47d4-8015-9fe83078b4ec"
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("mock.name", value: "My Mock Server")
    json.update("mock.environment", value: "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19")
    json.update("mock.description", value: "example describing update mock description")
    json.updateBool("mock.private", value: false)
    json.update("mock.versionTag", value: "abf07d3d-f8ec-47d4-8015-9fe83078b4ec")

    http.setRequestHeader("Content-Type", value: "application/json")
    http.setRequestHeader("X-API-Key", value: "{{postman_api_key}}")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://api.getpostman.com/mocks/{{mock_uid}}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "mock": {
    //     "id": "06040138-dd6b-4cce-9a02-7e1c1ab59723",
    //     "owner": "11582779",
    //     "uid": "11582779-06040138-dd6b-4cce-9a02-7e1c1ab59723",
    //     "collection": "11582779-fd6797e2-de6b-4699-975c-85290e4c2499",
    //     "mockUrl": "https://06040138-dd6b-4cce-9a02-7e1c1ab59723.mock.pstmn.io",
    //     "name": "My Mock Server",
    //     "config": {
    //       "headers": [
    //       ],
    //       "matchBody": false,
    //       "matchQueryParams": true,
    //       "matchWildcards": true
    //     },
    //     "environment": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var Id: String? = jResp.string(of: "mock.id")
    var Owner: String? = jResp.string(of: "mock.owner")
    var Uid: String? = jResp.string(of: "mock.uid")
    var Collection: String? = jResp.string(of: "mock.collection")
    var MockUrl: String? = jResp.string(of: "mock.mockUrl")
    var Name: String? = jResp.string(of: "mock.name")
    var MatchBody: Bool = jResp.bool(of: "mock.config.matchBody")
    var MatchQueryParams: Bool = jResp.bool(of: "mock.config.matchQueryParams")
    var MatchWildcards: Bool = jResp.bool(of: "mock.config.matchWildcards")
    var Environment: String? = jResp.string(of: "mock.environment")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "mock.config.headers").intValue
    while i < count_i {
        jResp.i = i
        i = i + 1
    }


}

Curl Command

curl -X PUT
	-H "X-API-Key: {{postman_api_key}}"
	-H "Content-Type: application/json"
	-d '{
    "mock": {
        "name": "My Mock Server",
        "environment": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19",
        "description": "example describing update mock description",
        "private": false,
        "versionTag": "abf07d3d-f8ec-47d4-8015-9fe83078b4ec"
    }
}'
https://api.getpostman.com/mocks/{{mock_uid}}

Postman Collection Item JSON

{
  "name": "Update Mock",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"mock\": {\n        \"name\": \"My Mock Server\",\n        \"environment\": \"11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19\",\n        \"description\": \"example describing update mock description\",\n        \"private\": false,\n        \"versionTag\": \"abf07d3d-f8ec-47d4-8015-9fe83078b4ec\"\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.getpostman.com/mocks/{{mock_uid}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "mocks",
        "{{mock_uid}}"
      ]
    },
    "description": "This endpoint allows you to update a mock you have created using its `uid`. The endpoint allows you to edit fields,\n* name\n* environment\n* description\n* private\n* versionTag\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "success Response",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"mock\": {\n        \"name\": \"My Mock Server\",\n        \"environment\": \"11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19\",\n        \"description\": \"example describing update mock description\",\n        \"private\": false,\n        \"versionTag\": \"abf07d3d-f8ec-47d4-8015-9fe83078b4ec\"\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "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"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"mock\": {\n        \"id\": \"06040138-dd6b-4cce-9a02-7e1c1ab59723\",\n        \"owner\": \"11582779\",\n        \"uid\": \"11582779-06040138-dd6b-4cce-9a02-7e1c1ab59723\",\n        \"collection\": \"11582779-fd6797e2-de6b-4699-975c-85290e4c2499\",\n        \"mockUrl\": \"https://06040138-dd6b-4cce-9a02-7e1c1ab59723.mock.pstmn.io\",\n        \"name\": \"My Mock Server\",\n        \"config\": {\n            \"headers\": [],\n            \"matchBody\": false,\n            \"matchQueryParams\": true,\n            \"matchWildcards\": true\n        },\n        \"environment\": \"11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19\"\n    }\n}"
    }
  ]
}