Chilkat Online Tools

Swift / MongoDB Atlas / Create an Online Archive

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

    http.DigestAuth = true
    http.Login = "username"
    http.Password = "password"

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

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

    // {
    //   "dbName": "people",
    //   "collName": "employees",
    //   "partitionFields": [
    //     {
    //       "fieldName": "firstName",
    //       "order": 0
    //     },
    //     {
    //       "fieldName": "lastName",
    //       "order": 1
    //     }
    //   ],
    //   "criteria": {
    //     "type": "DATE",
    //     "dateField": "created",
    //     "dateFormat": "ISODATE",
    //     "expireAfterDays": 5
    //   }
    // }

    let json = CkoJsonObject()
    json.UpdateString("dbName", value: "people")
    json.UpdateString("collName", value: "employees")
    json.UpdateString("partitionFields[0].fieldName", value: "firstName")
    json.UpdateInt("partitionFields[0].order", value: 0)
    json.UpdateString("partitionFields[1].fieldName", value: "lastName")
    json.UpdateInt("partitionFields[1].order", value: 1)
    json.UpdateString("criteria.type", value: "DATE")
    json.UpdateString("criteria.dateField", value: "created")
    json.UpdateString("criteria.dateFormat", value: "ISODATE")
    json.UpdateInt("criteria.expireAfterDays", value: 5)

    var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/onlineArchives", 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
	--digest -u 'username:password'
	-d '{
    "dbName": "people",
    "collName": "employees",
    "partitionFields": [
        {
            "fieldName": "firstName",
            "order": 0
        },
        {
            "fieldName": "lastName",
            "order": 1
        }
    ],
    "criteria": {
        "type": "DATE",
        "dateField": "created",
        "dateFormat": "ISODATE",
        "expireAfterDays": 5
    }
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/onlineArchives

Postman Collection Item JSON

{
  "name": "Create an Online Archive",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"dbName\": \"people\",\n    \"collName\": \"employees\",\n    \"partitionFields\": [\n        {\n            \"fieldName\": \"firstName\",\n            \"order\": 0\n        },\n        {\n            \"fieldName\": \"lastName\",\n            \"order\": 1\n        }\n    ],\n    \"criteria\": {\n        \"type\": \"DATE\",\n        \"dateField\": \"created\",\n        \"dateFormat\": \"ISODATE\",\n        \"expireAfterDays\": 5\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{base_url}}/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/onlineArchives",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "groups",
        "{{ProjectID}}",
        "clusters",
        "{{CLUSTER-NAME}}",
        "onlineArchives"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/online-archive-create-one/#std-label-api-online-archive-create-one"
  },
  "response": [
  ]
}