OpenPipeline API - POST verify a DQL processor

Latest Dynatrace
Reference
1-min read

Verifies if the given DQL processor is valid.

The request produces an application/json payload.

POST SaaS https://{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	DQLProcessorVerifyRequest	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
protectedFields	string[]	List of protected fields	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	VerifyResponse	Returns the verification result of the DQL processor script.
4XX	ErrorResponseEnvelope	Client-side error.
5XX	ErrorResponseEnvelope	Server-side error.

Response body objects

The `VerifyResponse` object

Verify response.

Element	Type	Description
notifications	MetadataNotification[]	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	TokenPosition	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	PositionInfo	The exact position in the query string.
start	PositionInfo	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	ErrorResponse	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	ErrorResponseDetails	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` -> ConstraintViolationDetails `constraintViolation`

The `ConstraintViolationDetails` object

List of encountered constraint violations.

Element	Type	Description
constraintViolations	ConstraintViolation[]	List of encountered constraint violations.

The `ConstraintViolation` object

Information about a single constraint violation.

Element	Type	Description
context	object	Structured context of the constraint violation. Well known keys that can be present are: `reason` -> Additional reasoning behind the occurred violation. `pipeline` -> Pipeline related to the violation. `endpoint` -> Endpoint related to the violation. `stage` -> Stage related to the violation. `processor` -> Processor related to the violation. `routingRule` -> Routing rule related to the violation.
message	string	Description of the constraint violation.

OpenPipeline API - POST verify a DQL processor

Parameters

Request body objects

The DQLProcessorVerifyRequest object

Request body JSON model

Response

Response codes

Response body objects

The VerifyResponse object

The MetadataNotification object

The TokenPosition object

The PositionInfo object