{ "opencollection": "1.0.0", "info": { "name": "Manticore Search Client Index API", "version": "5.0.0" }, "items": [ { "info": { "name": "Index", "type": "folder" }, "items": [ { "info": { "name": "Bulk table operations", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1:9308/bulk", "body": { "type": "json", "data": "{}" } }, "docs": "Sends multiple operatons like inserts, updates, replaces or deletes. \nFor each operation it's object must have same format as in their dedicated method. \nThe method expects a raw string as the batch in NDJSON.\n Each operation object needs to be serialized to \n JSON and separated by endline (\\n). \n \n An example of raw input:\n \n ```\n {\"insert\": {\"table\": \"movies\", \"doc\": {\"plot\": \"A secret team goes to North Pole\", \"rating\": 9.5, \"language\": [2, 3], \"title\": \"This is an older movie\", \"lon\": 51" }, { "info": { "name": "Delete a document in a table", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1:9308/delete", "body": { "type": "json", "data": "{}" } }, "docs": "Delete one or several documents.\nThe method has 2 ways of deleting: either by id, in case only one document is deleted or by using a match query, in which case multiple documents can be delete .\nExample of input to delete by id:\n\n ```\n {'table':'movies','id':100}\n ```\n\nExample of input to delete using a query:\n\n ```\n {\n 'table':'movies',\n 'query':\n {\n 'bool':\n {\n 'must':\n [\n {'query_string':'new movie'}\n ]\n }\n }\n }\n ```\n\nThe match " }, { "info": { "name": "Create a new document in a table", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1:9308/insert", "body": { "type": "json", "data": "{}" } }, "docs": "Insert a document. \nExpects an object like:\n \n ```\n {\n 'table':'movies',\n 'id':701,\n 'doc':\n {\n 'title':'This is an old movie',\n 'plot':'A secret team goes to North Pole',\n 'year':1950,\n 'rating':9.5,\n 'lat':60.4,\n 'lon':51.99,\n 'advise':'PG-13',\n 'meta':'{\"keywords\":{\"travel\",\"ice\"},\"genre\":{\"adventure\"}}',\n 'language':[2,3]\n }\n }\n ```\n \nThe document id can also be missing, in which case an autogenerated one will be used:\n " }, { "info": { "name": "Replace new document in a table", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1:9308/replace", "body": { "type": "json", "data": "{}" } }, "docs": "Replace an existing document. Input has same format as `insert` operation.\nResponds with an object in format:\n\n ```\n {'table':'products','id':1,'created':false,'result':'updated','status':200}\n ```\n" }, { "info": { "name": "Update a document in a table", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1:9308/update", "body": { "type": "json", "data": "{}" } }, "docs": "Update one or several documents.\nThe update can be made by passing the id or by using a match query in case multiple documents can be updated. For example update a document using document id:\n\n ```\n {'table':'movies','doc':{'rating':9.49},'id':100}\n ```\n\nAnd update by using a match query:\n\n ```\n {\n 'table':'movies',\n 'doc':{'rating':9.49},\n 'query':\n {\n 'bool':\n {\n 'must':\n [\n {'query_string':'new movie'}\n ]\n }\n }\n }\n ``` \n\nThe " }, { "info": { "name": "Partially replaces a document in a table", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1:9308/:table/_update/:id", "params": [ { "name": "table", "value": "", "type": "path", "description": "Name of the percolate table" }, { "name": "id", "value": "", "type": "path", "description": "Id of the document to replace" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially replaces a document with given id in a table\nResponds with an object of the following format: \n\n ```\n {'table':'products','updated':1}\n ```\n" } ] } ], "bundled": true }