Chilkat Online Tools

Ruby / MongoDB Atlas / Create an Online Archive

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_DigestAuth(true)
http.put_Login("username")
http.put_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
#   }
# }

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/onlineArchives","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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": [
  ]
}