Chilkat Online Tools

Objective-C / MongoDB Atlas / Create an Atlas Search Index

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.DigestAuth = YES;
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": "movies",
//   "database": "sample_mflix",
//   "name": "Synon",
//   "mappings": {
//     "dynamic": true
//   },
//   "analyzer": "lucene.standard",
//   "synonyms": [
//     {
//       "name": "mySynonyms",
//       "source": {
//         "collection": "synonyms"
//       },
//       "analyzer": "lucene.standard"
//     }
//   ]
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"collectionName" value: @"movies"];
[json UpdateString: @"database" value: @"sample_mflix"];
[json UpdateString: @"name" value: @"Synon"];
[json UpdateBool: @"mappings.dynamic" value: YES];
[json UpdateString: @"analyzer" value: @"lucene.standard"];
[json UpdateString: @"synonyms[0].name" value: @"mySynonyms"];
[json UpdateString: @"synonyms[0].source.collection" value: @"synonyms"];
[json UpdateString: @"synonyms[0].analyzer" value: @"lucene.standard"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X POST
	--digest -u 'username:password'
	-d '{
    "collectionName": "movies",
    "database": "sample_mflix",
    "name": "Synon",
    "mappings": {
        "dynamic": true
    },
    "analyzer": "lucene.standard",
    "synonyms": [
        {
            "name": "mySynonyms",
            "source": {
                "collection": "synonyms"
            },
            "analyzer": "lucene.standard"
        }
    ]
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes

Postman Collection Item JSON

{
  "name": "Create an Atlas Search Index",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"collectionName\": \"movies\",\n    \"database\": \"sample_mflix\",\n    \"name\": \"Synon\",\n    \"mappings\": {\n        \"dynamic\": true\n    },\n    \"analyzer\": \"lucene.standard\",\n    \"synonyms\": [\n        {\n            \"name\": \"mySynonyms\",\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",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "groups",
        "{{ProjectID}}",
        "clusters",
        "{{CLUSTER-NAME}}",
        "fts",
        "indexes"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/fts-indexes-create-one/"
  },
  "response": [
  ]
}