{ "uuid": "8b5f6759-2cd9-42b8-ad15-b3eeb699e82a", "lastMigration": 29, "name": "SearchServiceClient", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "b337212a-8941-47e6-9687-c5c3dcd160b0", "documentation": "Lists all datasources available for a search service.", "method": "get", "endpoint": "datasources", "responses": [ { "uuid": "bcbfaeed-0fcd-4574-9a0c-eed357efae82", "body": "{\n \"value\": [\n {\n \"@odata.etag\": \"\",\n \"container\": {\n \"name\": \"\",\n \"query\": \"\"\n },\n \"credentials\": {\n \"connectionString\": \"\"\n },\n \"dataChangeDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"dataDeletionDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"{{oneOf (array 'azuresql' 'cosmosdb' 'azureblob' 'azuretable' 'mysql')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e8247707-9368-4548-b6ba-af37eb146ecb", "documentation": "Creates a new datasource.", "method": "post", "endpoint": "datasources", "responses": [ { "uuid": "297bbb10-2fb0-4d31-8713-af6fda0583a1", "body": "{\n \"@odata.etag\": \"\",\n \"container\": {\n \"name\": \"\",\n \"query\": \"\"\n },\n \"credentials\": {\n \"connectionString\": \"\"\n },\n \"dataChangeDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"dataDeletionDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"{{oneOf (array 'azuresql' 'cosmosdb' 'azureblob' 'azuretable' 'mysql')}}\"\n}", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f5d3f849-22b8-47f5-b5c5-6e70486d06c5", "documentation": "Deletes a datasource.", "method": "delete", "endpoint": "datasources(':dataSourceName')", "responses": [ { "uuid": "529b5888-8d59-4a18-b63a-614956169942", "body": "", "latency": 0, "statusCode": 204, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "10347a48-2860-40c6-8a61-15540f1dd8cb", "body": "", "latency": 0, "statusCode": 404, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c47859cb-3b2a-4e62-8cfc-df2673352788", "documentation": "Retrieves a datasource definition.", "method": "get", "endpoint": "datasources(':dataSourceName')", "responses": [ { "uuid": "49d512ce-6aea-4753-b846-de13208fb4eb", "body": "{\n \"@odata.etag\": \"\",\n \"container\": {\n \"name\": \"\",\n \"query\": \"\"\n },\n \"credentials\": {\n \"connectionString\": \"\"\n },\n \"dataChangeDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"dataDeletionDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"{{oneOf (array 'azuresql' 'cosmosdb' 'azureblob' 'azuretable' 'mysql')}}\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "62105359-7a1c-4f00-a4c8-bf8574b59a9c", "documentation": "Creates a new datasource or updates a datasource if it already exists.", "method": "put", "endpoint": "datasources(':dataSourceName')", "responses": [ { "uuid": "4f072463-f8c6-4ed9-822f-95e6bd4d77dd", "body": "{\n \"@odata.etag\": \"\",\n \"container\": {\n \"name\": \"\",\n \"query\": \"\"\n },\n \"credentials\": {\n \"connectionString\": \"\"\n },\n \"dataChangeDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"dataDeletionDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"{{oneOf (array 'azuresql' 'cosmosdb' 'azureblob' 'azuretable' 'mysql')}}\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e13067e3-88dd-43c6-8331-2e61e5741166", "body": "{\n \"@odata.etag\": \"\",\n \"container\": {\n \"name\": \"\",\n \"query\": \"\"\n },\n \"credentials\": {\n \"connectionString\": \"\"\n },\n \"dataChangeDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"dataDeletionDetectionPolicy\": {\n \"@odata.type\": \"\"\n },\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"{{oneOf (array 'azuresql' 'cosmosdb' 'azureblob' 'azuretable' 'mysql')}}\"\n}", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "db372848-5cc9-4257-9c20-ca69dc4f391d", "documentation": "Lists all indexers available for a search service.", "method": "get", "endpoint": "indexers", "responses": [ { "uuid": "b5acbb7f-616c-49e1-b325-f9bb15fbcf8d", "body": "{\n \"value\": [\n {\n \"@odata.etag\": \"\",\n \"dataSourceName\": \"\",\n \"description\": \"\",\n \"disabled\": {{faker 'datatype.boolean'}},\n \"fieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"name\": \"\",\n \"outputFieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"parameters\": {\n \"base64EncodeKeys\": {{faker 'datatype.boolean'}},\n \"batchSize\": {{faker 'number.int' max=99999}},\n \"configuration\": {},\n \"maxFailedItems\": {{faker 'number.int' max=99999}},\n \"maxFailedItemsPerBatch\": {{faker 'number.int' max=99999}}\n },\n \"schedule\": {\n \"interval\": \"\",\n \"startTime\": \"{{faker 'date.recent' 365}}\"\n },\n \"skillsetName\": \"\",\n \"targetIndexName\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2c81b6d6-b593-4b09-8c80-75cc77e1e24a", "documentation": "Creates a new indexer.", "method": "post", "endpoint": "indexers", "responses": [ { "uuid": "0df0573c-0f4f-4262-b0fa-cf1115793b4e", "body": "{\n \"@odata.etag\": \"\",\n \"dataSourceName\": \"\",\n \"description\": \"\",\n \"disabled\": {{faker 'datatype.boolean'}},\n \"fieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"name\": \"\",\n \"outputFieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"parameters\": {\n \"base64EncodeKeys\": {{faker 'datatype.boolean'}},\n \"batchSize\": {{faker 'number.int' max=99999}},\n \"configuration\": {},\n \"maxFailedItems\": {{faker 'number.int' max=99999}},\n \"maxFailedItemsPerBatch\": {{faker 'number.int' max=99999}}\n },\n \"schedule\": {\n \"interval\": \"\",\n \"startTime\": \"{{faker 'date.recent' 365}}\"\n },\n \"skillsetName\": \"\",\n \"targetIndexName\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0b375f1-7cf4-47b2-83fe-a1a1b8ff552f", "documentation": "Deletes an indexer.", "method": "delete", "endpoint": "indexers(':indexerName')", "responses": [ { "uuid": "f22718d2-2bf9-449c-9c6d-72c29e33e902", "body": "", "latency": 0, "statusCode": 204, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f7ce6059-2a06-4475-8e26-26d9c5e381ac", "body": "", "latency": 0, "statusCode": 404, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b927e299-69fc-4bc8-b4ca-24ce96a054b7", "documentation": "Retrieves an indexer definition.", "method": "get", "endpoint": "indexers(':indexerName')", "responses": [ { "uuid": "d4e9a18d-9059-404b-87f3-766c1ba71c16", "body": "{\n \"@odata.etag\": \"\",\n \"dataSourceName\": \"\",\n \"description\": \"\",\n \"disabled\": {{faker 'datatype.boolean'}},\n \"fieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"name\": \"\",\n \"outputFieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"parameters\": {\n \"base64EncodeKeys\": {{faker 'datatype.boolean'}},\n \"batchSize\": {{faker 'number.int' max=99999}},\n \"configuration\": {},\n \"maxFailedItems\": {{faker 'number.int' max=99999}},\n \"maxFailedItemsPerBatch\": {{faker 'number.int' max=99999}}\n },\n \"schedule\": {\n \"interval\": \"\",\n \"startTime\": \"{{faker 'date.recent' 365}}\"\n },\n \"skillsetName\": \"\",\n \"targetIndexName\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4f5c3cb2-a8a0-4e88-81be-76151642d996", "documentation": "Creates a new indexer or updates an indexer if it already exists.", "method": "put", "endpoint": "indexers(':indexerName')", "responses": [ { "uuid": "cd4a08bd-711a-48e2-a946-6d3101915391", "body": "{\n \"@odata.etag\": \"\",\n \"dataSourceName\": \"\",\n \"description\": \"\",\n \"disabled\": {{faker 'datatype.boolean'}},\n \"fieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"name\": \"\",\n \"outputFieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"parameters\": {\n \"base64EncodeKeys\": {{faker 'datatype.boolean'}},\n \"batchSize\": {{faker 'number.int' max=99999}},\n \"configuration\": {},\n \"maxFailedItems\": {{faker 'number.int' max=99999}},\n \"maxFailedItemsPerBatch\": {{faker 'number.int' max=99999}}\n },\n \"schedule\": {\n \"interval\": \"\",\n \"startTime\": \"{{faker 'date.recent' 365}}\"\n },\n \"skillsetName\": \"\",\n \"targetIndexName\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3674360c-44b9-4d0d-a6f6-02799a2e9151", "body": "{\n \"@odata.etag\": \"\",\n \"dataSourceName\": \"\",\n \"description\": \"\",\n \"disabled\": {{faker 'datatype.boolean'}},\n \"fieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"name\": \"\",\n \"outputFieldMappings\": [\n {\n \"mappingFunction\": {\n \"name\": \"\",\n \"parameters\": {}\n },\n \"sourceFieldName\": \"\",\n \"targetFieldName\": \"\"\n }\n ],\n \"parameters\": {\n \"base64EncodeKeys\": {{faker 'datatype.boolean'}},\n \"batchSize\": {{faker 'number.int' max=99999}},\n \"configuration\": {},\n \"maxFailedItems\": {{faker 'number.int' max=99999}},\n \"maxFailedItemsPerBatch\": {{faker 'number.int' max=99999}}\n },\n \"schedule\": {\n \"interval\": \"\",\n \"startTime\": \"{{faker 'date.recent' 365}}\"\n },\n \"skillsetName\": \"\",\n \"targetIndexName\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "83bf77de-6cdd-437a-a302-1f83424f01ee", "documentation": "Resets the change tracking state associated with an indexer.", "method": "post", "endpoint": "indexers(':indexerName')/search.reset", "responses": [ { "uuid": "4787a1aa-2580-48fa-a719-dda7db55270d", "body": "", "latency": 0, "statusCode": 204, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8d8b7ea0-31d7-490b-9695-b302dd24113f", "documentation": "Runs an indexer on-demand.", "method": "post", "endpoint": "indexers(':indexerName')/search.run", "responses": [ { "uuid": "c2c2b9e3-620d-431c-be4b-a331717e684c", "body": "", "latency": 0, "statusCode": 202, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0bd618c3-0552-4b5d-a411-d553546bece8", "documentation": "Returns the current status and execution history of an indexer.", "method": "get", "endpoint": "indexers(':indexerName')/search.status", "responses": [ { "uuid": "e7ca107e-d96f-44d9-90eb-2851708ff469", "body": "{\n \"executionHistory\": [\n {\n \"endTime\": \"{{faker 'date.recent' 365}}\",\n \"errorMessage\": \"\",\n \"errors\": [\n {\n \"details\": \"\",\n \"documentationLink\": \"\",\n \"errorMessage\": \"\",\n \"key\": \"\",\n \"name\": \"\",\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ],\n \"finalTrackingState\": \"\",\n \"initialTrackingState\": \"\",\n \"itemsFailed\": {{faker 'number.int' max=99999}},\n \"itemsProcessed\": {{faker 'number.int' max=99999}},\n \"startTime\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"{{oneOf (array 'transientFailure' 'success' 'inProgress' 'reset')}}\",\n \"warnings\": [\n {\n \"details\": \"\",\n \"documentationLink\": \"\",\n \"key\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"lastResult\": {\n \"endTime\": \"{{faker 'date.recent' 365}}\",\n \"errorMessage\": \"\",\n \"errors\": [\n {\n \"details\": \"\",\n \"documentationLink\": \"\",\n \"errorMessage\": \"\",\n \"key\": \"\",\n \"name\": \"\",\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ],\n \"finalTrackingState\": \"\",\n \"initialTrackingState\": \"\",\n \"itemsFailed\": {{faker 'number.int' max=99999}},\n \"itemsProcessed\": {{faker 'number.int' max=99999}},\n \"startTime\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"{{oneOf (array 'transientFailure' 'success' 'inProgress' 'reset')}}\",\n \"warnings\": [\n {\n \"details\": \"\",\n \"documentationLink\": \"\",\n \"key\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"limits\": {\n \"maxDocumentContentCharactersToExtract\": {{faker 'number.int' max=99999}},\n \"maxDocumentExtractionSize\": {{faker 'number.int' max=99999}},\n \"maxRunTime\": \"\"\n },\n \"status\": \"{{oneOf (array 'unknown' 'error' 'running')}}\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c7208d8-61be-4c5a-9412-79853c0c775d", "documentation": "Lists all indexes available for a search service.", "method": "get", "endpoint": "indexes", "responses": [ { "uuid": "6037a27e-4d96-40e7-8ae2-c7de4f6af843", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "476acdcd-c95d-4431-b8ff-4baecd7c6701", "documentation": "Creates a new search index.", "method": "post", "endpoint": "indexes", "responses": [ { "uuid": "f750b74b-7897-4563-afc1-eea7537f5b03", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1ea58711-68c4-43a4-99dd-60207083fa1e", "documentation": "Deletes a search index and all the documents it contains.", "method": "delete", "endpoint": "indexes(':indexName')", "responses": [ { "uuid": "20385055-6386-4f54-b0c2-df9cd5155abe", "body": "", "latency": 0, "statusCode": 204, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2a8fa0d7-536a-4760-b33a-c9f9708a75c4", "body": "", "latency": 0, "statusCode": 404, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cf97b005-b68b-42d6-9a61-2641ffd92fb6", "documentation": "Retrieves an index definition.", "method": "get", "endpoint": "indexes(':indexName')", "responses": [ { "uuid": "9bcbf4c1-c622-4086-a550-08b398645e31", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "85307b66-c776-4397-97d1-1d41da20ec01", "documentation": "Creates a new search index or updates an index if it already exists.", "method": "put", "endpoint": "indexes(':indexName')", "responses": [ { "uuid": "35947848-99eb-4e1c-a87e-285b6ad297b4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dd55da95-3497-473f-a0a7-888900322f5e", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6bad080f-8574-45d5-9f2b-c613be380ab8", "documentation": "Shows how an analyzer breaks text into tokens.", "method": "post", "endpoint": "indexes(':indexName')/search.analyze", "responses": [ { "uuid": "d8093c03-0eed-408c-bfff-2c73b783d70d", "body": "{\n \"tokens\": [\n {\n \"endOffset\": {{faker 'number.int' max=99999}},\n \"position\": {{faker 'number.int' max=99999}},\n \"startOffset\": {{faker 'number.int' max=99999}},\n \"token\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b27e6bd-bea4-49e3-8b9d-ae9c98ffd715", "documentation": "Returns statistics for the given index, including a document count and storage usage.", "method": "get", "endpoint": "indexes(':indexName')/search.stats", "responses": [ { "uuid": "d88bdd02-c4b4-4015-88be-56852f7eaefb", "body": "{\n \"documentCount\": {{faker 'number.int' max=99999}},\n \"storageSize\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f3943350-1226-4cd4-bafe-cb4a5d5246d0", "documentation": "Gets service level statistics for a search service.", "method": "get", "endpoint": "servicestats", "responses": [ { "uuid": "930b55a1-bd1d-4479-ba6d-b2cfc8007451", "body": "{\n \"counters\": {\n \"dataSourcesCount\": {\n \"quota\": {{faker 'number.int' max=99999}},\n \"usage\": {{faker 'number.int' max=99999}}\n },\n \"documentCount\": {\n \"quota\": {{faker 'number.int' max=99999}},\n \"usage\": {{faker 'number.int' max=99999}}\n },\n \"indexersCount\": {\n \"quota\": {{faker 'number.int' max=99999}},\n \"usage\": {{faker 'number.int' max=99999}}\n },\n \"indexesCount\": {\n \"quota\": {{faker 'number.int' max=99999}},\n \"usage\": {{faker 'number.int' max=99999}}\n },\n \"storageSize\": {\n \"quota\": {{faker 'number.int' max=99999}},\n \"usage\": {{faker 'number.int' max=99999}}\n },\n \"synonymMaps\": {\n \"quota\": {{faker 'number.int' max=99999}},\n \"usage\": {{faker 'number.int' max=99999}}\n }\n },\n \"limits\": {\n \"maxComplexCollectionFieldsPerIndex\": {{faker 'number.int' max=99999}},\n \"maxComplexObjectsInCollectionsPerDocument\": {{faker 'number.int' max=99999}},\n \"maxFieldNestingDepthPerIndex\": {{faker 'number.int' max=99999}},\n \"maxFieldsPerIndex\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "95d3ede5-137b-42d6-8c72-0fbc32f15138", "documentation": "List all skillsets in a search service.", "method": "get", "endpoint": "skillsets", "responses": [ { "uuid": "0e5e5d86-b1cf-47c6-964d-a5d35b8e9c16", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The list is successfully returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "91710993-47a6-4076-8b91-c87ed684a0ac", "documentation": "Creates a new skillset in a search service.", "method": "post", "endpoint": "skillsets", "responses": [ { "uuid": "83951d85-0a6f-4707-91d6-e52800bd3991", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The skillset is successfully created.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2a8d9e49-4a7a-4c6f-9207-cc398a705d60", "documentation": "Deletes a skillset in a search service.", "method": "delete", "endpoint": "skillsets(':skillsetName')", "responses": [ { "uuid": "b9937761-36e8-44e5-bf1e-40341efecd52", "body": "", "latency": 0, "statusCode": 204, "label": "The skillset is successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "797d15e6-59cf-4332-b39b-182a6a92cf68", "body": "", "latency": 0, "statusCode": 404, "label": "The provided skillset name is not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d683172-e1ef-4b85-93ea-1d4d043f605f", "documentation": "Retrieves a skillset in a search service.", "method": "get", "endpoint": "skillsets(':skillsetName')", "responses": [ { "uuid": "3c86c5ed-3861-468b-98bd-e2d8b08e855a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The skillset is successfully returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3cd811fe-7e8d-4305-9d26-790a6ea2935c", "documentation": "Creates a new skillset in a search service or updates the skillset if it already exists.", "method": "put", "endpoint": "skillsets(':skillsetName')", "responses": [ { "uuid": "83103e8e-96a7-46b9-8ef1-6a2333c76183", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The skillset is successfully updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "00e2738c-3a5a-4771-9ce6-635b36a8d89a", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The skillset is successfully created.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "daeb19a9-0bf9-488d-adee-3d2b77c736b9", "documentation": "Lists all synonym maps available for a search service.", "method": "get", "endpoint": "synonymmaps", "responses": [ { "uuid": "fa3ea76b-5b6d-4d9e-9e72-2341cad12859", "body": "{\n \"value\": [\n {\n \"@odata.etag\": \"\",\n \"encryptionKey\": {\n \"accessCredentials\": {\n \"applicationId\": \"\",\n \"applicationSecret\": \"\"\n },\n \"keyVaultKeyName\": \"\",\n \"keyVaultKeyVersion\": \"\",\n \"keyVaultUri\": \"\"\n },\n \"format\": \"{{oneOf (array 'solr')}}\",\n \"name\": \"\",\n \"synonyms\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0984e727-5f91-4654-93fc-dc9b146b7330", "documentation": "Creates a new synonym map.", "method": "post", "endpoint": "synonymmaps", "responses": [ { "uuid": "68907ea7-c451-43ab-8089-a4d4baab963b", "body": "{\n \"@odata.etag\": \"\",\n \"encryptionKey\": {\n \"accessCredentials\": {\n \"applicationId\": \"\",\n \"applicationSecret\": \"\"\n },\n \"keyVaultKeyName\": \"\",\n \"keyVaultKeyVersion\": \"\",\n \"keyVaultUri\": \"\"\n },\n \"format\": \"{{oneOf (array 'solr')}}\",\n \"name\": \"\",\n \"synonyms\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1e8087aa-3537-4e4f-99fd-8f07fc086d60", "documentation": "Deletes a synonym map.", "method": "delete", "endpoint": "synonymmaps(':synonymMapName')", "responses": [ { "uuid": "33d2fefc-2410-4a4d-aea4-06463be66316", "body": "", "latency": 0, "statusCode": 204, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7bbf2b9c-d20a-43e7-bdae-d127f7c94479", "body": "", "latency": 0, "statusCode": 404, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "704fe168-ed7e-41e6-a337-3d5cba389a95", "documentation": "Retrieves a synonym map definition.", "method": "get", "endpoint": "synonymmaps(':synonymMapName')", "responses": [ { "uuid": "64c38259-ea83-43c0-b57e-e2fd884e1e31", "body": "{\n \"@odata.etag\": \"\",\n \"encryptionKey\": {\n \"accessCredentials\": {\n \"applicationId\": \"\",\n \"applicationSecret\": \"\"\n },\n \"keyVaultKeyName\": \"\",\n \"keyVaultKeyVersion\": \"\",\n \"keyVaultUri\": \"\"\n },\n \"format\": \"{{oneOf (array 'solr')}}\",\n \"name\": \"\",\n \"synonyms\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e9bcdff5-ea6c-47a0-aaaa-6a1b006968e9", "documentation": "Creates a new synonym map or updates a synonym map if it already exists.", "method": "put", "endpoint": "synonymmaps(':synonymMapName')", "responses": [ { "uuid": "ae4ef6c7-a46a-4d14-8f02-8b47fcaae468", "body": "{\n \"@odata.etag\": \"\",\n \"encryptionKey\": {\n \"accessCredentials\": {\n \"applicationId\": \"\",\n \"applicationSecret\": \"\"\n },\n \"keyVaultKeyName\": \"\",\n \"keyVaultKeyVersion\": \"\",\n \"keyVaultUri\": \"\"\n },\n \"format\": \"{{oneOf (array 'solr')}}\",\n \"name\": \"\",\n \"synonyms\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "02f04376-8e39-4bd1-aac4-f1bca64b9794", "body": "{\n \"@odata.etag\": \"\",\n \"encryptionKey\": {\n \"accessCredentials\": {\n \"applicationId\": \"\",\n \"applicationSecret\": \"\"\n },\n \"keyVaultKeyName\": \"\",\n \"keyVaultKeyVersion\": \"\",\n \"keyVaultUri\": \"\"\n },\n \"format\": \"{{oneOf (array 'solr')}}\",\n \"name\": \"\",\n \"synonyms\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "b337212a-8941-47e6-9687-c5c3dcd160b0" }, { "type": "route", "uuid": "e8247707-9368-4548-b6ba-af37eb146ecb" }, { "type": "route", "uuid": "f5d3f849-22b8-47f5-b5c5-6e70486d06c5" }, { "type": "route", "uuid": "c47859cb-3b2a-4e62-8cfc-df2673352788" }, { "type": "route", "uuid": "62105359-7a1c-4f00-a4c8-bf8574b59a9c" }, { "type": "route", "uuid": "db372848-5cc9-4257-9c20-ca69dc4f391d" }, { "type": "route", "uuid": "2c81b6d6-b593-4b09-8c80-75cc77e1e24a" }, { "type": "route", "uuid": "c0b375f1-7cf4-47b2-83fe-a1a1b8ff552f" }, { "type": "route", "uuid": "b927e299-69fc-4bc8-b4ca-24ce96a054b7" }, { "type": "route", "uuid": "4f5c3cb2-a8a0-4e88-81be-76151642d996" }, { "type": "route", "uuid": "83bf77de-6cdd-437a-a302-1f83424f01ee" }, { "type": "route", "uuid": "8d8b7ea0-31d7-490b-9695-b302dd24113f" }, { "type": "route", "uuid": "0bd618c3-0552-4b5d-a411-d553546bece8" }, { "type": "route", "uuid": "3c7208d8-61be-4c5a-9412-79853c0c775d" }, { "type": "route", "uuid": "476acdcd-c95d-4431-b8ff-4baecd7c6701" }, { "type": "route", "uuid": "1ea58711-68c4-43a4-99dd-60207083fa1e" }, { "type": "route", "uuid": "cf97b005-b68b-42d6-9a61-2641ffd92fb6" }, { "type": "route", "uuid": "85307b66-c776-4397-97d1-1d41da20ec01" }, { "type": "route", "uuid": "6bad080f-8574-45d5-9f2b-c613be380ab8" }, { "type": "route", "uuid": "0b27e6bd-bea4-49e3-8b9d-ae9c98ffd715" }, { "type": "route", "uuid": "f3943350-1226-4cd4-bafe-cb4a5d5246d0" }, { "type": "route", "uuid": "95d3ede5-137b-42d6-8c72-0fbc32f15138" }, { "type": "route", "uuid": "91710993-47a6-4076-8b91-c87ed684a0ac" }, { "type": "route", "uuid": "2a8d9e49-4a7a-4c6f-9207-cc398a705d60" }, { "type": "route", "uuid": "1d683172-e1ef-4b85-93ea-1d4d043f605f" }, { "type": "route", "uuid": "3cd811fe-7e8d-4305-9d26-790a6ea2935c" }, { "type": "route", "uuid": "daeb19a9-0bf9-488d-adee-3d2b77c736b9" }, { "type": "route", "uuid": "0984e727-5f91-4654-93fc-dc9b146b7330" }, { "type": "route", "uuid": "1e8087aa-3537-4e4f-99fd-8f07fc086d60" }, { "type": "route", "uuid": "704fe168-ed7e-41e6-a337-3d5cba389a95" }, { "type": "route", "uuid": "e9bcdff5-ea6c-47a0-aaaa-6a1b006968e9" } ] }