depot-service/io.dataos.ds.client.apis/DatasetApi/renameField

renameField

@PATCH(value = "api/v2/depots/{depot}/collections/{collection}/datasets/{dataset}/fields/{field}/rename")
abstract fun renameField(@Path(value = "depot") depot: String, @Path(value = "collection") collection: String, @Path(value = "dataset") dataset: String, @Path(value = "field") field: String, @Body request: FieldRenameRequest, @Header(value = "dataos-correlation-id") correlationId: String = UUID.randomUUID().toString()): Call<Void>

Renames a field in a dataset.

Return

A Call object with a Void response.

Parameters

depot

The depot name.

collection

The collection name.

dataset

The dataset name.

field

The field name to be renamed.

request

The FieldRenameRequest object containing rename information.

correlationId

(Optional) The correlation ID for tracking requests.