📘 Guía de la API de OpenSearch

URL base:

https://api.opensearch.prod.trysolved.com/

Índice:

incidents_v1

Auth:

Usa Basic Auth con tu usuario y contraseña de OpenSearch.

Autenticación básica

Utiliza la cabecera HTTP Authorization así:

Authorization: Basic <base64(usuario:contraseña)>

Para crear el string en formato usuario:contraseña codificado en Base64 (usado en el header Authorization: Basic), ejecuta el siguiente comando según tu sistema operativo:

En Linux/macOS (bash):
```
echo -n 'usuario:contraseña' | base64 
```

En Windows (PowerShell):

[Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("usuario:contraseña"))

Endpoint para consultas

Para buscar en el índice:

POST https://api.opensearch.prod.trysolved.com/incidents_v1/_search

Cabeceras:

Content-Type: application/json
Authorization: Basic <base64 string>

Campos que puedes consultar

Desde tu función de indexación, aquí tienes los campos clave:

		Notas de tipo de campo
`id`	string	ID del incidente
`category`	string	Categoría del incidente
`companyId`	string	ID de la empresa asociada
`creationDate`	ISO date	Fecha de creación del incidente
`description`	string	Descripción (analizada)
`description_insensitive`	string	Campo de búsqueda sin distinción de mayúsculas
`plant`	string	Planta/ubicación
`priority`	string	Nivel de prioridad
`status`	string	Estado del incidente
`template_id`	string	ID de la plantilla usada
`refId`	string	ID de referencia externa
`productType`	string	Tipo de producto
`owner.`, `creator.`, `connectedUser.*`	object	Campos de info de usuario como `email`, `username`, `uid`, etc.

Consultas de ejemplo

1. Coincidir con todos los incidentes

POST /incidents_v1/_search
{
  "query": {
    "match_all": {}
  },
  "size": 10
}

2. Filtrar por estado

POST /incidents_v1/_search
{
  "query": {
    "term": {
      "status.keyword": "open"
    }
  }
}

3. Buscar por categoría y prioridad

POST /incidents_v1/_search
{
  "query": {
    "bool": {
      "must": [
        { "term": { "category.keyword": "safety" } },
        { "term": { "priority": 0 } }
      ]
    }
  }
}

4. Búsqueda de texto completo en la descripción

POST /incidents_v1/_search
{
  "query": {
    "match": {
      "description": "chemical spill"
    }
  }
}

5. Filtrar por rango de fechas

POST /incidents_v1/_search
{
  "query": {
    "range": {
      "creationDate": {
        "gte": "2024-01-01T00:00:00Z",
        "lte": "2024-12-31T23:59:59Z"
      }
    }
  }
}

6. Filtrar por email del creador

POST /incidents_v1/_search
{
  "query": {
    "term": {
      "creator.email.keyword": "jane.doe@example.com"
    }
  }
}

7. Contar incidentes por estado

POST /incidents_v1/_search
{
  "size": 0,
  "aggs": {
    "by_status": {
      "terms": {
        "field": "status.keyword"
      }
    }
  }
}

Ejemplo cURL

curl -X POST "https://api.opensearch.prod.trysolved.com/incidents_v1/_search" \
  -u 'your_username:your_password' \
  -H "Content-Type: application/json" \
  -d '{
    "query": {
      "term": { "status.keyword": "open" }
    }
  }'

Consejos

Usa .keyword para buscar cadenas exactas.
Usa "size" y "from" para paginación.
Usa "match" para búsquedas difusas o de texto completo.
Limita los campos devueltos con _source, por ejemplo:

"_source": ["id", "status", "priority"]

Postman

Aquí tienes una colección de postman con los ejemplos anteriores

Para usarlo, sigue estos pasos.

Guarda el siguiente contenido json en un archivo (por ejemplo: postman_incidents.json)
Importa este archivo en Postman
Haz clic en el nombre de la colección que acabas de importar y en Authorization pon tu username y password
Elige la colección que quieras probar (por ejemplo Filter by Status) entra en Body así puedes ver el cuerpo de la consulta y editarlo si quieres.
Haz clic en Send

{
	"info": {
		"name": "OpenSearch API - incidents_v1",
		"description": "Consultas de la API de OpenSearch para el índice `incidents_v1` usando Basic Auth.",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "1. Coincidir con todos los incidentes",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n  \"query\": { \"match_all\": {} },\n  \"size\": 10\n}"
				},
				"url": {
					"raw": "{{baseURL}}/incidents_v1/_search",
					"host": [
						"{{baseURL}}"
					],
					"path": [
						"incidents_v1",
						"_search"
					]
				}
			},
			"response": []
		},
		{
			"name": "2. Filtrar por estado",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n  \"query\": {\n    \"term\": { \"status.keyword\": \"open\" }\n  }\n}"
				},
				"url": {
					"raw": "{{baseURL}}/incidents_v1/_search",
					"host": [
						"{{baseURL}}"
					],
					"path": [
						"incidents_v1",
						"_search"
					]
				}
			},
			"response": []
		},
		{
			"name": "3. Filtrar por categoría y prioridad",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n  \"query\": {\n    \"bool\": {\n      \"must\": [\n        { \"term\": { \"category.keyword\": \"safety\" } },\n        { \"term\": { \"priority\": 0 } }\n      ]\n    }\n  }\n}"
				},
				"url": {
					"raw": "{{baseURL}}/incidents_v1/_search",
					"host": [
						"{{baseURL}}"
					],
					"path": [
						"incidents_v1",
						"_search"
					]
				}
			},
			"response": []
		},
		{
			"name": "4. Búsqueda de texto completo en la descripción",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n  \"query\": {\n    \"match\": {\n      \"description\": \"chemical spill\"\n    }\n  }\n}"
				},
				"url": {
					"raw": "{{baseURL}}/incidents_v1/_search",
					"host": [
						"{{baseURL}}"
					],
					"path": [
						"incidents_v1",
						"_search"
					]
				}
			},
			"response": []
		},
		{
			"name": "5. Rango de fechas por fecha de creación",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n  \"query\": {\n    \"range\": {\n      \"creationDate\": {\n        \"gte\": \"2024-01-01T00:00:00Z\",\n        \"lte\": \"2024-12-31T23:59:59Z\"\n      }\n    }\n  }\n}"
				},
				"url": {
					"raw": "{{baseURL}}/incidents_v1/_search",
					"host": [
						"{{baseURL}}"
					],
					"path": [
						"incidents_v1",
						"_search"
					]
				}
			},
			"response": []
		},
		{
			"name": "6. Filtrar por email del creador",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n  \"query\": {\n    \"term\": {\n      \"creator.email.keyword\": \"jane.doe@example.com\"\n    }\n  }\n}"
				},
				"url": {
					"raw": "{{baseURL}}/incidents_v1/_search",
					"host": [
						"{{baseURL}}"
					],
					"path": [
						"incidents_v1",
						"_search"
					]
				}
			},
			"response": []
		},
		{
			"name": "7. Agregación por estado",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n  \"size\": 0,\n  \"aggs\": {\n    \"by_status\": {\n      \"terms\": {\n        \"field\": \"status.keyword\"\n      }\n    }\n  }\n}"
				},
				"url": {
					"raw": "{{baseURL}}/incidents_v1/_search",
					"host": [
						"{{baseURL}}"
					],
					"path": [
						"incidents_v1",
						"_search"
					]
				}
			},
			"response": []
		}
	],
	"auth": {
		"type": "basic",
		"basic": [
			{
				"key": "password",
				"value": "",
				"type": "string"
			},
			{
				"key": "username",
				"value": "",
				"type": "string"
			}
		]
	},
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"type": "text/javascript",
				"packages": {},
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"type": "text/javascript",
				"packages": {},
				"exec": [
					""
				]
			}
		}
	],
	"variable": [
		{
			"key": "baseURL",
			"value": "https://api.opensearch.prod.trysolved.com",
			"type": "default"
		}
	]
}

OpenSearch API Reference

Consulta la referencia oficial de la API de OpenSearch para más detalles.

Soporte