/{version}/configuration/udfs/{udfid}
The following operations are supported on this resource:
GET
Gets the representation of a user defined field.
Parameters
| name | description | type | default |
|---|---|---|---|
| udfid | The ID of the user defined field. | path |
Output Payload
| element | produceable content type(s) |
|---|---|
| field (XML) |
|
| description | |
| The representation of the user defined field. | |
PUT
Updates the mutable values for a user defined field.
Only a subset of the user defined field's attributes can be modified. Unmodifiable attributes will be ignored.
The following attributes of a user defined field can be modified:
- name
- display-precision
- unit label
- presets
Parameters
| name | description | type | default |
|---|---|---|---|
| udfid | The ID of the user defined field. | path |
Input Payload
| element | consumeable content type(s) |
|---|---|
| field (XML) |
|
| description | |
| The new representation of the user defined field. | |
Output Payload
| element | produceable content type(s) |
|---|---|
| field (XML) |
|
| description | |
| The current representation of the user defined field, after modifiable attributes have been updated. | |