Chilkat Online Tools

Node.js / MongoDB Atlas / Update an Atlas Search Index

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    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.

    // {
    //   "collectionName": "synonyms",
    //   "database": "my_test",
    //   "name": "default",
    //   "mappings": {
    //     "dynamic": true
    //   },
    //   "analyzer": "lucene.standard",
    //   "synonyms": [
    //     {
    //       "name": "egSynonyms",
    //       "source": {
    //         "collection": "synonyms"
    //       },
    //       "analyzer": "lucene.standard"
    //     }
    //   ]
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("collectionName","synonyms");
    json.UpdateString("database","my_test");
    json.UpdateString("name","default");
    json.UpdateBool("mappings.dynamic",true);
    json.UpdateString("analyzer","lucene.standard");
    json.UpdateString("synonyms[0].name","egSynonyms");
    json.UpdateString("synonyms[0].source.collection","synonyms");
    json.UpdateString("synonyms[0].analyzer","lucene.standard");

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);

    // resp: HttpResponse
    var resp = http.PTextSb("PATCH","https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes/{{INDEX-ID}}",sbRequestBody,"utf-8","application/json",false,false);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -X PATCH
	--digest -u 'username:password'
	-d '{
    "collectionName": "synonyms",
    "database": "my_test",
    "name": "default",
    "mappings": {
        "dynamic": true
    },
    "analyzer": "lucene.standard",
    "synonyms": [
        {
            "name": "egSynonyms",
            "source": {
                "collection": "synonyms"
            },
            "analyzer": "lucene.standard"
        }
    ]
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes/{{INDEX-ID}}

Postman Collection Item JSON

{
  "name": "Update an Atlas Search Index",
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"collectionName\": \"synonyms\",\n    \"database\": \"my_test\",\n    \"name\": \"default\",\n    \"mappings\": {\n        \"dynamic\": true\n    },\n    \"analyzer\": \"lucene.standard\",\n    \"synonyms\": [\n        {\n            \"name\": \"egSynonyms\",\n            \"source\": {\n                \"collection\": \"synonyms\"\n            },\n            \"analyzer\": \"lucene.standard\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{base_url}}/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes/{{INDEX-ID}}",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "groups",
        "{{ProjectID}}",
        "clusters",
        "{{CLUSTER-NAME}}",
        "fts",
        "indexes",
        "{{INDEX-ID}}"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/fts-indexes-create-one/"
  },
  "response": [
  ]
}