OpenPipeline API - POST autocomplete suggestions for a matcher
Creates autocompletion suggestions for the given matcher.
The request produces an application/json
payload.
POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/matcher/autocomplete |
Authentication
To execute this request, you need an OAuth2 client with openpipeline:configurations:read
permission.
To learn how to obtain and use it, see OAuth clients.
Parameters
Request body objects
The MatcherAutocompleteRequest
object
The position of the cursor inside the query.
The current (in-)complete matcher query.
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.
{"query": "match","cursorPosition": 5}
Response
Response codes
Response body objects
The AutocompleteResponse
object
The response of the autocomplete call.
True if the suggestions are optional.
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.
The AutocompleteSuggestion
object
Single suggestion for completion of the query.
Number of characters that the user already typed for this suggestion.
The suggested continuation of the input.
The AutocompleteSuggestionPart
object
Part of the suggestion.
The type of the suggestion.
The suggested continuation of the input.
The synopsis of the suggestion.
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": "SIMPLE_IDENTIFIER","info": "some custom field"}],"alreadyTypedCharacters": 0,"suggestion": ""},{"parts": [{"suggestion": "matchesPhrase","type": "FUNCTION_NAME","info": "Matches a phrase against the input string expression using token matchers.","synopsis": "matchesPhrase(expression, phrase [, caseSensitive])"},{"suggestion": "(","type": "PARENTHESIS_OPEN"}],"alreadyTypedCharacters": 5,"suggestion": "matchesPhrase("},{"parts": [{"suggestion": "matchesValue","type": "FUNCTION_NAME","info": "Matches a value against the input expression using token matchers.","synopsis": "matchesValue(expression, value [, caseSensitive])"},{"suggestion": "(","type": "PARENTHESIS_OPEN"}],"alreadyTypedCharacters": 5,"suggestion": "matchesValue("},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "*","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " * "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "/","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " / "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "%","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " % "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "+","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " + "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "-","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " - "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "==","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " == "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "!=","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " != "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "<","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " < "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": ">","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " > "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "<=","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " <= "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": ">=","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " >= "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "and","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " and "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "xor","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " xor "},{"parts": [{"suggestion": " ","type": "SPACE"},{"suggestion": "or","type": "OPERATOR"},{"suggestion": " ","type": "SPACE"}],"alreadyTypedCharacters": 0,"suggestion": " or "},{"parts": [{"suggestion": "|","type": "PIPE"}],"alreadyTypedCharacters": 0,"suggestion": "|"}],"optional": true}
JSON models
The ErrorResponseEnvelope
object
Encloses the encountered error.
The ErrorResponse
object
Basic information of the encountered error.
The returned HTTP status code.
Description of the encountered error.
The ErrorResponseDetails
object
Detailed information of the error.
Defines the actual set of fields depending on the value. See one of the following objects:
constraintViolation
-> ConstraintViolationDetails
constraintViolation
The ConstraintViolationDetails
object
List of encountered constraint violations.
The ConstraintViolation
object
Information about a single constraint violation.
Description of the constraint violation.