Chilkat Online Tools

PureBasic / MongoDB Atlas / Create an Online Archive Advanced

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkDigestAuth(http, 1)
    CkHttp::setCkLogin(http, "username")
    CkHttp::setCkPassword(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": "accounting",
    ;   "collName": "invoices",
    ;   "partitionFields": [
    ;     {
    ;       "fieldName": "created",
    ;       "order": 0
    ;     },
    ;     {
    ;       "fieldName": "customerID",
    ;       "order": 1
    ;     },
    ;     {
    ;       "fieldName": "invoiceNumber",
    ;       "order": 2
    ;     }
    ;   ],
    ;   "criteria": {
    ;     "type": "DATE",
    ;     "dateField": "created",
    ;     "dateFormat": "ISODATE",
    ;     "expireAfterDays": 7
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"dbName","accounting")
    CkJsonObject::ckUpdateString(json,"collName","invoices")
    CkJsonObject::ckUpdateString(json,"partitionFields[0].fieldName","created")
    CkJsonObject::ckUpdateInt(json,"partitionFields[0].order",0)
    CkJsonObject::ckUpdateString(json,"partitionFields[1].fieldName","customerID")
    CkJsonObject::ckUpdateInt(json,"partitionFields[1].order",1)
    CkJsonObject::ckUpdateString(json,"partitionFields[2].fieldName","invoiceNumber")
    CkJsonObject::ckUpdateInt(json,"partitionFields[2].order",2)
    CkJsonObject::ckUpdateString(json,"criteria.type","DATE")
    CkJsonObject::ckUpdateString(json,"criteria.dateField","created")
    CkJsonObject::ckUpdateString(json,"criteria.dateFormat","ISODATE")
    CkJsonObject::ckUpdateInt(json,"criteria.expireAfterDays",7)

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/onlineArchives","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	--digest -u 'username:password'
	-d '{
    "dbName": "accounting",
    "collName": "invoices",
    "partitionFields": [
        {
            "fieldName": "created",
            "order": 0
        },
        {
            "fieldName": "customerID",
            "order": 1
        },
        {
            "fieldName": "invoiceNumber",
            "order": 2
        }
    ],
    "criteria": {
        "type": "DATE",
        "dateField": "created",
        "dateFormat": "ISODATE",
        "expireAfterDays": 7
    }
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/onlineArchives

Postman Collection Item JSON

{
  "name": "Create an Online Archive Advanced",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"dbName\": \"accounting\",\n    \"collName\": \"invoices\",\n    \"partitionFields\": [\n        {\n            \"fieldName\": \"created\",\n            \"order\": 0\n        },\n        {\n            \"fieldName\": \"customerID\",\n            \"order\": 1\n        },\n        {\n            \"fieldName\": \"invoiceNumber\",\n            \"order\": 2\n        }\n    ],\n    \"criteria\": {\n        \"type\": \"DATE\",\n        \"dateField\": \"created\",\n        \"dateFormat\": \"ISODATE\",\n        \"expireAfterDays\": 7\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": [
  ]
}