> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/health/v2.1/design/architecture/low-level-design/services/health-services/console-services/boundary-management/generate-search-api.md).

# Generate Search API

### Endpoint

* **Endpoint:** `/boundary-management/v1/_generate-search`
* **Method:** `POST`

### Purpose

Use this endpoint to poll a template generation job.

Search by job `id`, or by `tenantId` and `hierarchyType`.

If no generated template exists yet for the requested hierarchy, the service can trigger generation instead of returning an empty result.

### Request Structure

#### Query Parameters

* `tenantId` — required.
* `hierarchyType` — required when `id` is not provided.
* `id` — optional.
* `referenceId` — optional.

#### Body Parameters

* `RequestInfo` — request metadata and user context.

### Request Examples

Search by hierarchy:

```
POST /boundary-management/v1/_generate-search?tenantId=mz&hierarchyType=ADMIN
```

Search by job id:

```
POST /boundary-management/v1/_generate-search?tenantId=mz&id=550e8400-e29b-41d4-a716-446655440000
```

Example body:

```json
{
  "RequestInfo": {
    "apiId": "Rainmaker",
    "authToken": "{{authToken}}",
    "msgId": "1761036073664|en_MZ"
  }
}
```

### Response Structure

A successful response returns the current generation record.

Key fields:

* `id` — generation job id.
* `tenantId` — tenant for the job.
* `hierarchyType` — hierarchy used for the template.
* `fileStoreId` — generated file id when the job is complete.
* `status` — current job status.
* `locale` — locale used for headers and sheet labels.
* `referenceId` — optional campaign or project reference.
* `additionalDetails.error` — error details when the job fails.

### Flow

1. Client calls `_generate-search`.
2. Service looks up the matching generation row.
3. If the row exists, it returns the current status.
4. If the row is complete, it also returns `fileStoreId`.
5. If no row exists, the service can start generation for that hierarchy.
6. Client keeps polling until the status is terminal.

### Status States

* `inprogress`
* `completed`
* `failed`
* `expired`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digit.org/health/v2.1/design/architecture/low-level-design/services/health-services/console-services/boundary-management/generate-search-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
