OpenPipeline API - POST a processor preview
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 |
Authentication
To execute this request, you need an OAuth2 client with openpipeline:configurations:write
permission.
To learn how to obtain and use it, see OAuth clients.
Parameters
Request body objects
The PreviewProcessorEnvelope
object
The processor to execute for the preview. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor and FieldsRenameProcessor.
The PreviewProcessor
object
The processor to execute for the preview. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor and FieldsRenameProcessor.
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.
{"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"}]}}
Response
Response codes
Response body objects
The PreviewProcessorResult
object
The PreviewProcessorResultEntry
object
Preview result for a single sample data record.
Indicates if the record matched the processors matching condition.
The altered record after the processor was applied.
Response body JSON model
{"results": [{"matched": true,"record": {"ip.address": "10.0.0.123","host.name": "raspberry-pi 4","timestamp": "2024-06-24T07:21:52.200000000Z"}}]}
JSON models
The DqlProcessor
object
Processor 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.
The FieldsAddProcessor
object
Processor 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.
The FieldsAddItem
object
List of fields to add to the record.
Name of the field.
Value to assign to the field.
The FieldsRemoveProcessor
object
Processor 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 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.
The FieldsRenameProcessor
object
Processor 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.
The FieldsRenameItem
object
List of fields to rename on the record.
The field to rename.
The new field name.
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.