TCL / MongoDB Atlas / Create an Online Archive
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_put_DigestAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $http "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
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "dbName" "people"
CkJsonObject_UpdateString $json "collName" "employees"
CkJsonObject_UpdateString $json "partitionFields[0].fieldName" "firstName"
CkJsonObject_UpdateInt $json "partitionFields[0].order" 0
CkJsonObject_UpdateString $json "partitionFields[1].fieldName" "lastName"
CkJsonObject_UpdateInt $json "partitionFields[1].order" 1
CkJsonObject_UpdateString $json "criteria.type" "DATE"
CkJsonObject_UpdateString $json "criteria.dateField" "created"
CkJsonObject_UpdateString $json "criteria.dateFormat" "ISODATE"
CkJsonObject_UpdateInt $json "criteria.expireAfterDays" 5
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/onlineArchives" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
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": [
]
}