v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

transformationRuleManagement

Update a transformation rule.

Update an existing transformation rule. All properties specified in the request are replaced. Missing properties will remain the same.

put/v1/transformationRules/{id}

Path parameters

idstring required

Identifier of the transformation rule to update.

Request body

enabledboolean required

True if the rule is enabled.

Example request

{
  "ruleDefinition": {
    "name": "Transformation Rule 1",
    "selector": "_sourceCategory=metricsstore",
    "dimensionTransformations": [
      {
        "transformationType": "AggregateOnTransformation",
        "aggregateOn": [
          "metric"
        ]
      },
      {
        "transformationType": "AddOrReplaceTransformation",
        "dimensionToReplace": "metric",
        "value": "{{metric}}_aggregated"
      }
    ],
    "transformedMetricsRetention": 8,
    "retention": 8
  },
  "enabled": true
}

Response

The transformation rule was successfully modified.

enabledboolean required

True if the rule is enabled.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring required

Unique identifier for the transformation rule.

Example response

{
  "ruleDefinition": {
    "name": "Transformation Rule 1",
    "selector": "_sourceCategory=metricsstore",
    "dimensionTransformations": [
      {
        "transformationType": "AggregateOnTransformation",
        "aggregateOn": [
          "metric"
        ]
      },
      {
        "transformationType": "AddOrReplaceTransformation",
        "dimensionToReplace": "metric",
        "value": "{{metric}}_aggregated"
      }
    ],
    "transformedMetricsRetention": 8,
    "retention": 8
  },
  "enabled": true,
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8"
}