SAsalesforce
aspects

Get aspect

Retrieve the specified aspect by its id or name. You may also optionally specify a list of fields to include in the response.

get/aspects/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/aspects/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id or name of the aspect to retrieve.

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

Response

Success, returns the specified aspect.

descriptionstring

A description of the aspect. A lens may choose to display this information to the user.

helpEmailstring

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.

helpUrlstring

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.

idstring

The aspect id.

imageUrlstring

Optional icon to represent the aspect.

isPublishedboolean

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.

namestring

Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).

criticalRangenumber[]

A two-element array of type decimal. Determines what range of values should be assigned to status value 0.

warningRangenumber[]

A two-element array of type decimal. Determines what range of values should be assigned to status value 1.

infoRangenumber[]

A two-element array of type decimal. Determines what range of values should be assigned to status value 2.

okRangenumber[]

A two-element array of type decimal. Determines what range of values should be assigned to status value 3.

timeoutstring

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.

valueLabelstring

A short label the lens may display next to the value. Most useful to specify a unit of measurement, e.g. 'ms' or '%'.

valueType'BOOLEAN' | 'NUMERIC' | 'PERCENT'

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.

createdBystring

Id of the User who created this Aspect.

createdAtstring

TODO

updatedAtstring

TODO

tagsstring[]

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
  ]
}

Changes

No recorded changes to this operation across all 70 revisions of this API.