OpenPipeline API - POST verify a matcher
Verifies if the given matcher is valid.
The request produces an application/json payload.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/matcher/verify |
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
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Matcher | Single matcher to verify. | body | required |
Request body objects
The MatcherRequest object
| Element | Type | Description | Required |
|---|---|---|---|
| query | string | The matcher query to process. | 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.
{"query": "matchesValue(type, \"security\")"}
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Verify | Returns the verification result of the matcher. |
| 4XX | Error | Client-side error. |
| 5XX | Error | Server-side error. |
Response body objects
The VerifyResponse object
Verify response.
| Element | Type | Description |
|---|---|---|
| notifications | Metadata | 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 | Token | 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 | Position | The exact position in the query string. |
| start | Position | 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 | 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 | Error | 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:
|
The ConstraintViolationDetails object
List of encountered constraint violations.
| Element | Type | Description |
|---|---|---|
| constraintViolations | Constraint | List of encountered constraint violations. |
The ConstraintViolation object
Information about a single constraint violation.
| Element | Type | Description |
|---|---|---|
| message | string | Description of the constraint violation. |