Create Client for Existing Query
You can also create a new client for an existing query, enabling multiple independent consumers to poll the same query session.
| Description | Creates a new client for an existing query, enabling multiple independent consumers to poll the same query session. | Â | |
| Method | POST /api/v1/repositories/ | Â | |
| Request Data | Â | Â | |
| Response Data | QueryResults | Â | |
| Authentication Required | yes | Â | |
| Path Arguments | Description | Data type | Required? |
id | ID of the query job | string | required |
repo | Name of repository to be searched | string | required |
| Return Codes | Â | ||
| 200 | Request complete | Â | |
| 400 | Request is malformed and either missing critical fields or the JSON is badly structured | Â | |
| 500 | Request failed | Â | |
This returns the structure shown in the following table, however only the id field will have a value, and so is the only field returned:
Table: Metadata JSON Object Fields
| Field | Type | Description |
|---|---|---|
| hashedQueryOnView | string | A string hash of the optimized query (the "query plan"). For advanced users. |
| id | string | The id of the started queryjob. This can be used to poll results. |
| queryOnView | string | A string representation of the optimized query (the "query plan"). For advanced users. |
| staticMetaData | | If provided, indicates that the backend is running the query in a special mode, and may include information about the reason for selecting that mode. |
| Â Â Â Â Â Â Â Â executionMode | Â | The execution mode of the query. |