Update aspect (full)
Update the specified aspect. If a field is not included in the query body, that field will be set to null (or false or empty or a default enum value).
Path parameters
The id or name of the aspect to update
Request body
A description of the aspect. A lens may choose to display this information to the user.
The email address where a user can go to get more help about the aspect. A lens may choose to display this information to the user e.g. if the user clicks a “help” icon attached to the aspect.
The url where a user can go to get more help about the aspect. A lens may choose to display this information to the user e.g. if the user clicks a “help” icon attached to the aspect.
Optional icon to represent the aspect.
This affects the visibility of samples; defaults to false. When set to true, all the samples for this aspect are readable by other users; when set to false, the samples for this aspect are only readable by the owner of the aspect.
Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).
A two-element array of type decimal. Determines what range of values should be assigned Critical status.
A two-element array of type decimal. Determines what range of values should be assigned Warning status.
A two-element array of type decimal. Determines what range of values should be assigned Info status.
A two-element array of type decimal. Determines what range of values should be assigned OK status.
The length of time after which a sample is treated as 'N/A', in the form of /^[0-9]+[smhd]$/i. For example, use '5s' for five seconds, '2m' for two minutes, '12h' for twelve hours, '1d' for one day.
A short label the lens may display next to the value. Most useful to specify a unit of measurement, e.g. 'ms' or '%'.
The sample value must be able to be coerced to the specified data type. This allows a lens to render sample data in different ways depending on their type.
Array of tag names. Tag name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-). Tag names cannot start with a dash (-).
Provide guidance for how a lens should display aspects--ascending order by rank (numeric, nulls last) then within rank in ascending order by name (alphanumeric).
The name of the user to assign as the owner. Defaults to the user that created it
Example request
{
"criticalRange": [
1,
7
],
"warningRange": [
1,
7
],
"infoRange": [
1,
7
],
"okRange": [
1,
7
]
}Response
Success, returns the updated aspect.
A description of the aspect. A lens may choose to display this information to the user.
The email address where a user can go to get more help about the aspect. A lens may choose to display this information to the user e.g. if the user clicks a “help” icon attached to the aspect.
The url where a user can go to get more help about the aspect. A lens may choose to display this information to the user e.g. if the user clicks a “help” icon attached to the aspect.
The aspect id.
Optional icon to represent the aspect.
This affects the visibility of samples; defaults to false. When set to true, all the samples for this aspect are readable by other users; when set to false, the samples for this aspect are only readable by the owner of the aspect.
Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).
A two-element array of type decimal. Determines what range of values should be assigned to status value 0.
A two-element array of type decimal. Determines what range of values should be assigned to status value 1.
A two-element array of type decimal. Determines what range of values should be assigned to status value 2.
A two-element array of type decimal. Determines what range of values should be assigned to status value 3.
The length of time after which a sample is treated as 'N/A', in the form of /^[0-9]+[smhd]$/i. For example, use '5s' for five seconds, '2m' for two minutes, '12h' for twelve hours, '1d' for one day.
A short label the lens may display next to the value. Most useful to specify a unit of measurement, e.g. 'ms' or '%'.
The sample value must be able to be coerced to the specified data type. This allows a lens to render sample data in different ways depending on their type.
Id of the User who created this Aspect.
TODO
TODO
Array of tag names. Tag name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-). Tag names cannot start with a dash (-).
Example response
{
"criticalRange": [
1,
7
],
"warningRange": [
1,
7
],
"infoRange": [
1,
7
],
"okRange": [
1,
7
]
}