Get autocomplete suggestions for a DQL processor script in Dynatrace OpenPipeline, using the script, cursor position, and protected fields you provide.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/dqlProcessor/autocomplete |
You send configurationId, cursorPosition, protectedFields, and script in the request body. Dynatrace returns autocomplete suggestions for the DQL processor script.
To execute this request, you need a platform token or OAuth access token with openpipeline:configurations:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | D | DQL processor script and position to create suggestions for. | body | Required |
DQLProcessorAutocompleteRequest object| Element | Type | Description | Required |
|---|---|---|---|
| configurationId | string | Identifier of the configuration | Optional |
| cursorPosition | integer | The position of the cursor inside the script. | Optional |
| protectedFields | string[] | List of protected fields | Optional |
| script | string | The current (in-)complete DQL script. | Optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"cursorPosition": 5,"script": "parse"}
| Code | Type | Description |
|---|---|---|
| 200 | Autocomplete | Returns the autocomplete suggestions for the DQL processor script. |
| 4XX | Error | Client-side error. |
| 5XX | Error | Server-side error. |
AutocompleteResponse objectThe response of the autocomplete call.
| Element | Type | Description |
|---|---|---|
| optional | boolean | True if the suggestions are optional. |
| suggestedTtlSeconds | integer | Suggested duration, in seconds, for how long the response can be cached and reused by the client. It's derived from the volatility of the suggestions on the server (such as if the suggestions are static, how long the server will cache the volatile suggestions, etc.). If no value is provided, the result might be cached for a long time. If the value is lower than |
| suggestions | Autocomplete | The list of suggestions. |
AutocompleteSuggestion objectSingle suggestion for completion of the query.
| Element | Type | Description |
|---|---|---|
| alreadyTypedCharacters | integer | Number of characters that the user already typed for this suggestion. |
| parts | Autocomplete | List of suggestion parts. |
| suggestion | string | The suggested continuation of the input. |
AutocompleteSuggestionPart objectPart of the suggestion.
| Element | Type | Description |
|---|---|---|
| info | string | The type of the suggestion. |
| suggestion | string | The suggested continuation of the input. |
| synopsis | string | The synopsis of the suggestion. |
| type | string | The type of the autocomplete token. The element can hold these values
|
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic information of the encountered error.
| Element | Type | Description |
|---|---|---|
| code | integer | The returned HTTP status code. |
| details | Error | Detailed information of the error. |
| message | string | Description of the encountered error. |
ErrorResponseDetails objectDetailed information of the error.
| Element | Type | Description |
|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
{"suggestions": [{"parts": [{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " "},{"parts": [{"suggestion": "parse","type": "COMMAND_NAME","info": "Parses a record field and puts the result(s) into one or more fields as specified in the pattern.","synopsis": "parse expression, pattern [, preserveFieldsOnFailure] [, parsingPrerequisite]"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 5,"suggestion": "parse "}],"optional": false}
{"error": {"code": 400,"message": "Bad request."}}