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.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/preview/processor

Authentication

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.

Parameters

Parameter
Type
Description
In
Required
body

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

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

required

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

Preview result containing the processed sample data record.

4XX

Client-side error.

5XX

Server-side error.

Response body objects

The PreviewProcessorResult object

Element
Type
Description
results

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
description
string

Name or description of the processor.

dqlScript
string

The DQL script to apply on the record.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on incoming records.

sampleData
string

Sample data related to the processor for documentation or testing.

The FieldsAddProcessor object

Processor to add fields.

Element
Type
Description
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

fields

List of fields to add to the record.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on 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
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to 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

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on incoming records.

sampleData
string

Sample data related to the processor for documentation or testing.

The FieldsRenameProcessor object

Processor to rename fields.

Element
Type
Description
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

fields

List of fields to rename on the record.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on 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
editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. 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

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

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

The ConstraintViolationDetails object

List of encountered constraint violations.

Element
Type
Description
constraintViolations

List of encountered constraint violations.

The ConstraintViolation object

Information about a single constraint violation.

Element
Type
Description
message
string

Description of the constraint violation.