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

updateField

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

Updates 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 updated.

request

The FieldUpdateRequest object containing update information.

correlationId

(Optional) The correlation ID for tracking requests.