Creates a preview for an OpenPipeline processor in your Dynatrace environment for the given sample data.
The request produces an application/json payload.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/preview/processor |
To execute this request, you need an access token with settings.read scope.
To learn how to obtain and use it, see Tokens and authentication.
You can execute this request also with an OAuth2 client with openpipeline:configurations:write permission.
To learn how to obtain and use it, see OAuth clients.
PreviewProcessorEnvelope objectIdentifier of the configuration.
The processor to execute for the preview. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor and TechnologyProcessor.
PreviewProcessor objectThe processor to execute for the preview. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor and TechnologyProcessor.
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"processor": {"type": "fieldsRename","enabled": false,"editable": true,"id": "hostname-field-normalizer","description": "hostname field normalizer","matcher": "isNotNull(\"hostname\")","sampleData": "{\"hostname\": \"raspberry-pi 4\",\"ip\":\"10.0.0.123\"}","fields": [{"fromName": "hostname","toName": "host.name"},{"fromName": "ip","toName": "ip.address"}]}}
PreviewProcessorResult objectPreviewProcessorResultEntry objectPreview result for a single sample data record.
Indicates if the record matched the processors matching condition.
Contains matched processors ids, useful in case of multi-processors preview like in case of Technology.
The altered record after the processor was applied.
{"results": [{"matched": true,"record": {"ip.address": "10.0.0.123","host.name": "raspberry-pi 4","timestamp": "2024-06-24T07:21:52.200000000Z"}}]}
DqlProcessor objectProcessor to apply a DQL script.
Name or description of the processor.
The DQL script to apply on the record.
Indicates if the user is allowed to edit this object based on permissions and builtin property.
Indicates if the object is active.
Identifier of the processor. Must be unique within a stage.
Matching condition to apply on incoming records.
Sample data related to the processor for documentation or testing.
FieldsAddProcessor objectProcessor to add fields.
Name or description of the processor.
Indicates if the user is allowed to edit this object based on permissions and builtin property.
Indicates if the object is active.
Identifier of the processor. Must be unique within a stage.
Matching condition to apply on incoming records.
Sample data related to the processor for documentation or testing.
FieldsAddItem objectList of fields to add to the record.
Name of the field.
Value to assign to the field.
FieldsRemoveProcessor objectProcessor to remove fields.
Name or description of the processor.
Indicates if the user is allowed to edit this object based on permissions and builtin property.
Indicates if the object is active.
List of unique fields to remove from the record.
Identifier of the processor. Must be unique within a stage.
Matching condition to apply on incoming records.
Sample data related to the processor for documentation or testing.
FieldsRenameProcessor objectProcessor to rename fields.
Name or description of the processor.
Indicates if the user is allowed to edit this object based on permissions and builtin property.
Indicates if the object is active.
Identifier of the processor. Must be unique within a stage.
Matching condition to apply on incoming records.
Sample data related to the processor for documentation or testing.
FieldsRenameItem objectList of fields to rename on the record.
The field to rename.
The new field name.
TechnologyProcessor objectProcessor to apply a technology processors.
Indicates if the user is allowed to edit this object based on permissions and builtin property.
Indicates if the object is active.
Identifier of the processor. Must be unique within a stage.
Sample data related to the processor for documentation or testing.
The reference identifier to a specific technology. This technology is applied on the record.
ErrorResponseEnvelope objectEncloses the encountered error.
ErrorResponse objectBasic information of the encountered error.
The returned HTTP status code.
Description of the encountered error.
ErrorResponseDetails objectDetailed information of the error.
Defines the actual set of fields depending on the value. See one of the following objects:
constraintViolation -> ConstraintViolationDetailsconstraintViolationConstraintViolationDetails objectList of encountered constraint violations.
ConstraintViolation objectInformation about a single constraint violation.
Description of the constraint violation.