Translate a classic pipeline into an OpenPipeline configuration in Dynatrace, with options to include sample data and skip disabled or built-in rules.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/classic-pipelines/translate |
You provide the configuration scope to translate, either logs or bizevents, and can optionally include sample data or skip disabled and built-in processing rules. Dynatrace returns the translated OpenPipeline configuration pipeline.
To execute this request, you need a platform token or OAuth access token with settings:objects:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| configuration | string | Configuration scope to translate, either 'logs' or 'bizevents'. | query | Required |
| includeSampleData | boolean | Include processor sample data in the translation. | query | Optional |
| skipDisabledRules | boolean | Skip disabled rules during translation. | query | Optional |
| skipBuiltinProcessingRules | boolean | Skip built-in processing rules during translation. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Classic | The translated OpenPipeline configuration pipeline. |
| 4XX | Error | Client-side error. |
| 5XX | Error | Server-side error. |
ClassicPipelineTranslationResult objectResult of translating a classic pipeline into an OpenPipeline configuration pipeline.
| Element | Type | Description |
|---|---|---|
| value | Pipeline | The translated OpenPipeline configuration pipeline. The structure is compliant with builtin:openpipeline.logs.pipelines or builtin:openpipeline.bizevents.pipelines schemas, corresponding to the requested |
| withWarning | boolean | Indicates whether at least one processor couldn't be translated automatically and needs manual review. |
PipelineSettingsValue objectThe translated OpenPipeline configuration pipeline. The structure is compliant with builtin:openpipeline.logs.pipelines or builtin:openpipeline.bizevents.pipelines schemas, corresponding to the requested configuration parameter value. Note: the raw result may not fully pass validation against the Settings API.
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic 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. |
ErrorResponseDetails objectDetailed 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 element can hold these values
|
{"value": {"customId": "defaultTranslatedFromClassic","displayName": "defaultTranslatedFromClassic","processing": {"processors": [{"id": "hostname-field-normalizer","type": "dql","matcher": "isNotNull(\"hostname\")","description": "hostname-field-normalizer","sampleData": "{\n \"hostname\": \"raspberry-pi 4\",\n \"ip\": \"10.0.0.123\"\n}","enabled": true,"dql": {"script": "fieldsRename host.name = hostname\n| fieldsRename ip.address = ip"}}]},"securityContext": {},"costAllocation": {},"productAllocation": {},"storage": {"processors": [{"id": "default","type": "bucketAssignment","matcher": "true","description": "default","enabled": true,"bucketAssignment": {"bucketName": "default_logs"}}]},"smartscapeNodeExtraction": {},"smartscapeEdgeExtraction": {},"metricExtraction": {},"davis": {},"security": {},"dataExtraction": {}},"withWarning": true}
{"error": {"code": 400,"message": "Bad request."}}