OpenPipeline API - POST a processor preview

Latest Dynatrace
Reference
1-min read

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

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	PreviewProcessorEnvelope	The processor with sample-data to preview.	body	required

Request body objects

The `PreviewProcessorEnvelope` object

Element	Type	Description	Required
configId	string	Identifier of the configuration.	optional
processor	PreviewProcessor	The processor to execute for the preview. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor, and TechnologyProcessor.	required
scope	string	The scope in which the processor is previewed in. `ENDPOINT` `PIPELINE`	optional

The `PreviewProcessor` object

The processor to execute for the preview. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor, and TechnologyProcessor.

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

Code	Type	Description
200	PreviewProcessorResult	Preview result containing the processed sample data record.
408	ErrorResponseEnvelope	Preview run resulted in a timeout.
429	ErrorResponseEnvelope	Too many concurrent preview requests.
4XX	ErrorResponseEnvelope	Client-side error.
5XX	ErrorResponseEnvelope	Server-side error.

Response body objects

The `PreviewProcessorResult` object

Element	Type	Description
results	PreviewProcessorResultEntry[]	List of results for each sample data record.

The `PreviewProcessorResultEntry` object

Preview result for a single sample data record.

Element	Type	Description
matched	boolean	Indicates if the record matched the processors matching condition.
matchedProcessors	string[]	Contains matched processors IDs, useful in case of multi-processors preview like in case of Technology.
record	object	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.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
dqlScript	string	The DQL script to apply on the record.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `FieldsAddProcessor` object

Processor to add fields.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
fields	FieldsAddItem[]	List of fields to add to the record.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `FieldsAddItem` object

List of fields to add to the record.

Element	Type	Description
name	string	Name of the field.
value	string	Value to assign to the field.

The `FieldsRemoveProcessor` object

Processor to remove fields.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
fields	string[]	List of unique fields to remove from the record.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `FieldsRenameProcessor` object

Processor to rename fields.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
fields	FieldsRenameItem[]	List of fields to rename on the record.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `FieldsRenameItem` object

List of fields to rename on the record.

Element	Type	Description
fromName	string	The field to rename.
toName	string	The new field name.

The `TechnologyProcessor` object

Processor to apply a technology processors.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
customMatcher	string	Optional customer-defined matching condition, that is used in place of the main technology matcher.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
sampleData	string	Sample data related to the processor for documentation or testing.
technologyId	string	The reference identifier to a specific technology. This technology is applied on the record.

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 a processor preview

Parameters

Request body objects

The PreviewProcessorEnvelope object

The PreviewProcessor object

Request body JSON model

Response

Response codes

Response body objects

The PreviewProcessorResult object

The PreviewProcessorResultEntry object

Response body JSON model

JSON models

The DqlProcessor object

The FieldsAddProcessor object

The FieldsAddItem object

The FieldsRemoveProcessor object

The FieldsRenameProcessor object

The FieldsRenameItem object

The TechnologyProcessor object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

The ConstraintViolationDetails object

The ConstraintViolation object