Property Configuration Management

Config

API for reading and writing configuration files. For a detailed guide, see the Property Configuration API Guide.

PUT /properties/{property_name}/config

This method updates an existing property config.

The property config retrieval method must be invoked first to get the etag of the property config before calling update api. This etag is used internally to detect conflicts.

For example, say A and B want to modify the same property config. They first retrieve the config and get its etag. Let's assume they get the same etag. Then they make some changes and submit them. A submits the change first, and internally the etag for the property config will be updated. Then when B submits their change, the system will find that B's etag doesn't match the latest etag. This indicates that B was editing a stale config, and so the system will reject B's change. B has to retrieve the latest property and re-try the changes, then submit again.

The incoming property config will be compared with the exiting property config to determine whether this is a validate update. The field id is used to identify which existing node the incoming node derives. However, if the id is also modified the config system still tries its best to infer the originated existing node by matching the read-only part of that node versus all nodes at same level in existing config tree. If there's a match then this new node is regarded to be copied from that matched node. Otherwise, the incoming node is regarded as a new node and no read-only fields can be set. For the updated node, the read-only fields must not be modified.

On success, the incoming property config will replace the existing property config.

Parameters

ParameterDescriptionParameter TypeData Type
property_nameThe name of the propertypathstring
If-MatchThe etag of the property config returned by property config retrieval methodheaderstring
updatePropertyModelThe updated property config data and commentbodyJSON object

Response Message

HTTP Status CodeResponse Model
200When the property config is successfully updated
400

When the request is bad or property config is invalid

404

When the property config doesn't exist

409When there is a conflict detected
default

successful operation

GET /properties/{property_name}/config

This method retrieves an existing property config.

The etag in the response message must be included in the If-Match header for all update methods.

Parameters

ParameterDescriptionParameter TypeData Type
property_nameThe name of the propertypathstring

Response Message

HTTP Status CodeResponse Model
200When the property config is successfully retrieved
404

When the property config doesn't exist

default

successful operation