OpenPipeline API - POST autocomplete suggestions for a DQL processor

Creates autocompletion suggestions for the given DQL processor script.

The request produces an application/json payload.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/dqlProcessor/autocomplete

You can execute this request also with an OAuth2 client with openpipeline:configurations:read permission.

To learn how to obtain and use it, see OAuth clients.

Parameters

Parameter
Type
Description
In
Required
body

DQL processor script and position to create suggestions for.

body
required

Request body objects

The DQLProcessorAutocompleteRequest object

Element
Type
Description
Required
configurationId
string

Identifier of the configuration

optional
cursorPosition
integer

The position of the cursor inside the script.

optional
script
string

The current (in-)complete DQL script.

optional

Request body JSON model

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"
}

Response

Response codes

Code
Type
Description
200

Returns the autocomplete suggestions for the DQL processor script.

4XX

Client-side error.

5XX

Server-side error.

Response body objects

The AutocompleteResponse object

The 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 may be cached and reused by the client. It is derived from the volatility of the suggestions on the server (if the suggestions are static, how long the server will cache the volatile suggestions, ...). If not provided, then the result may be cached for long time. Value below 1 means that the result should not be cached.

suggestions

The list of suggestions.

The AutocompleteSuggestion object

Single suggestion for completion of the query.

Element
Type
Description
alreadyTypedCharacters
integer

Number of characters that the user already typed for this suggestion.

parts

List of suggestion parts.

suggestion
string

The suggested continuation of the input.

The AutocompleteSuggestionPart object

Part 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.

  • ASSIGNMENT
  • BOOLEAN_FALSE
  • BOOLEAN_TRUE
  • BRACE_CLOSE
  • BRACE_OPEN
  • BRACKET_CLOSE
  • BRACKET_OPEN
  • COLON
  • COMMA
  • COMMAND_NAME
  • DATA_OBJECT
  • DOT
  • END_COMMENT
  • ENTITY_ATTRIBUTE
  • ENTITY_SELECTOR_PART
  • ENTITY_TYPE
  • FIELD_MODIFIER
  • FIELD_PATTERN
  • FUNCTION_NAME
  • INDENT
  • LINEBREAK
  • METRIC_KEY
  • NULL
  • NUMBER
  • OPERATOR
  • PARAMETER_KEY
  • PARAMETER_VALUE_SCOPE
  • PARENTHESIS_CLOSE
  • PARENTHESIS_OPEN
  • PARSE_PATTERN
  • PIPE
  • QUOTE
  • SIMPLE_IDENTIFIER
  • SINGLE_QUOTE
  • SLASH
  • SPACE
  • STRING
  • TIMESERIES_AGGREGATION
  • TIMESERIES_AGGREGATION_EXPRESSION
  • TIMESTAMP_VALUE
  • TIME_UNIT
  • TRAVERSAL_HOP_COUNT
  • TRAVERSAL_OPERATOR
  • TRAVERSAL_RELATION_NAME
  • UID_VALUE
  • VARIABLE

Response body JSON model

{
  "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
}

JSON models

The ErrorResponseEnvelope object

Encloses the encountered error.

Element
Type
Description
error

Basic information of the encountered error.

The ErrorResponse object

Basic information of the encountered error.

Element
Type
Description
code
integer

The returned HTTP status code.

details

Detailed information of the error.

message
string

Description of the encountered error.

The ErrorResponseDetails object

Detailed 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:

  • constraintViolation

The ConstraintViolationDetails object

List of encountered constraint violations.

Element
Type
Description
constraintViolations

List of encountered constraint violations.

The ConstraintViolation object

Information about a single constraint violation.

Element
Type
Description
message
string

Description of the constraint violation.