OpenPipeline API - POST verify a DQL processor

Verifies if the given DQL processor is valid.

The request produces an application/json payload.

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

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

Single DQL processor script to verify.

body
required

Request body objects

The DQLProcessorVerifyRequest object

Element
Type
Description
Required
configurationId
string

Identifier of the configuration.

optional
script
string

The unverified 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.

{
  "script": "parse content, \"IPV4:ip LD HTTPDATE:time ']' LD:text\""
}

Response

Response codes

Code
Type
Description
200

Returns the verification result of the DQL processor script.

4XX

Client-side error.

5XX

Server-side error.

Response body objects

The VerifyResponse object

Verify response.

Element
Type
Description
notifications

The notifications related to the supplied input string.

valid
boolean

True if the supplied input string is valid.

The MetadataNotification object

The message that provides additional information about the execution of the input string.

Element
Type
Description
arguments
string[]

The arguments for the message format.

message
string

The complete message of the notification.

messageFormat
string

The message format of the notification, string.format based

messageFormatSpecifierTypes
string[]

The corresponding types for each format specifier used in the error message format.

notificationType
string

The notification type.

severity
string

The severity of the notification, currently: INFO, WARN, ERROR.

syntaxPosition

The position of a token in the input string used for errors and notification to map the message to a specific part of the input.

The TokenPosition object

The position of a token in the input string used for errors and notification to map the message to a specific part of the input.

Element
Type
Description
end

The exact position in the query string.

start

The exact position in the query string.

The PositionInfo object

The exact position in the query string.

Element
Type
Description
column
integer

Input string position column zero based index.

index
integer

Input string position index.

line
integer

Input string position line zero based index.

Response body JSON model

{
  "valid": false,
  "notifications": [
    {
      "severity": "ERROR",
      "syntaxPosition": {
        "start": {
          "column": 1,
          "index": 0,
          "line": 1
        },
        "end": {
          "column": 6,
          "index": 5,
          "line": 1
        }
      },
      "message": "There's been an error during parsing: There's no command `parsee`."
    }
  ]
}

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.