Chilkat Online Tools

Swift / Postman API / Create a Fork

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.

    // {
    //   "label": "Fork label"
    // }

    let json = CkoJsonObject()
    json.UpdateString("label", value: "Fork label")

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

    var resp: CkoHttpResponse? = http.PostJson3("https://api.getpostman.com/collections/fork/{{collection_uid}}?workspace={{workspace_id}}", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

Curl Command

curl -X POST
	-H "X-API-Key: {{postman_api_key}}"
	-H "Content-Type: application/json"
	-d '{
	"label": "Fork label"
}'
https://api.getpostman.com/collections/fork/{{collection_uid}}?workspace={{workspace_id}}

Postman Collection Item JSON

{
  "name": "Create a Fork",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"label\": \"Fork label\"\n}"
    },
    "url": {
      "raw": "https://api.getpostman.com/collections/fork/{{collection_uid}}?workspace={{workspace_id}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "collections",
        "fork",
        "{{collection_uid}}"
      ],
      "query": [
        {
          "key": "workspace",
          "value": "{{workspace_id}}",
          "description": "Workspace ID is required to create a fork"
        }
      ]
    },
    "description": "This endpoint allows you to create a fork from an existing collection.\n\nOn successful creation of the collection, the response returns the collection `name`, `id`, `uid` along with `fork` information.\n\nYou can also specify the context of a workspace to fork a collection in by passing the `workspace` as a query param.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Create a Fork",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"label\": \"Fork label\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.getpostman.com/collections/fork/{{collection_uid}}?workspace={{workspace_id}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "collections",
            "fork",
            "{{collection_uid}}"
          ],
          "query": [
            {
              "key": "workspace",
              "value": "{{workspace_id}}",
              "description": "Workspace ID is required to create a fork"
            }
          ]
        }
      },
      "_postman_previewlanguage": "json",
      "header": null,
      "cookie": [
      ],
      "body": "{\n    \"collection\": {\n        \"id\": \"1eea798e-335e-4d3c-be2a-a058e5914701\",\n        \"name\": \"Sample Collection\",\n        \"fork\": {\n            \"label\": \"Fork label\",\n            \"createdAt\": \"2021-06-16T07:01:17.317Z\",\n            \"from\": \"48eda956-11ff-471c-a022-bcacb1a4c497\"\n        },\n        \"uid\": \"b9253cbd-d9ea-411f-b847-26a1b6ba09ae\"\n    }\n}"
    }
  ]
}