User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In
API Reference
Doc HomeHelp Center

Update an Attribute

put http://<host>:9100/api/versioned/v1/datasets//attributes/

You can update an attribute's description only.

🚧

Requirements

To update an attribute, the following must be true:

  • Attribute's name has to be the same
  • Attribute's type has to be the same

This means the only field that can be updated for an attribute is the description.

For example, the following PUT request body updates the description of myAttribute.

{
  "name": "myAttribute",
  "description": "new info about myAttribute",
  "type": {
    "baseType": "STRING"
  }
}

Response Fields

Returns a JSON object with the name and data type of the attribute, and its description if exists.

FieldDescription
nameThe name of the attribute.
descriptionOptional. The description of the attribute. Will only be included in the response if there is a description associated with the attribute.
typeThe type of the attribute. Will contain a base type. For certain base types, such as array or map, it will also contain an inner type describing the type contained by the base type (e.g. boolean or int).
Language