v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB
subjects

Get subject hierarchy

Retrieve the hierarchy for the specified subject using its id or absolute path.

get/subjects/{key}/hierarchy

Path parameters

keystring required

The id or absolute path of the root subject to retrieve.

Query parameters

depthinteger

The number of hierarchy levels to include (0 for all, 1 for just children, 2 for children and grandchildren, etc.).

aspectstring

Comma-separated list of aspect names to include/exclude. For example, ?aspect=FOO,BAR will only return subjects in the hierarchy with samples for those two aspects (and all those subjects' ancestors up to the specified root of the requested hierarchy). Prefix each of the aspect name with a negative sign to indicate that a sample with that aspect should be excluded. For example, ?aspect=-BAZ,-FOO will return only the subjects (and its hierarchy) that have samples with aspect name not equal to BAZ or FOO. Subjects without samples are not included in the result set

statusstring

Comma-separated list of sample status to include/exclude. For example, ?status=OK,CRITICAL will only return subjects in the hierarchy with samples that are in those statuses (and all those subjects' ancestors up to the specified root of the requested hierarchy). Prefix each of the status with a negative sign to indicate that a sample with that status should be excluded. For example, ?status=-OK,-CRITICAL will return only the subjects (and its hierarchy) that have samples not in OK or CRITICAL status. Subjects without samples are not included in the result set

aspectTagsstring

Comma-separated list of tags names to include/exclude. For example, ?aspectTags=TAG1,TAG2 will only return subjects in the hierarchy with samples having aspect with tags matching TAG1 and TAG2 (and all those subjects' ancestors up to the specified root of the requested hierarchy). Prefix each of the tag names with a negative sign to indicate that a sample having aspect with those tag names will be excluded. For example, ?aspectTags=-TAG3,-TAG4 will return the subject hierarchy without aspects having tags - TAG3 and TAG4. Subjects without samples are not included in the result set

subjectTagsstring

Comma-separated list of tags names to include/exclude. For example, ?subjectTags=TAG1,TAG2 will only return subjects in the hierarchy with tags matching TAG1 and TAG2 (and all those subjects' ancestors up to the specified root of the requested hierarchy). Prefix each of the tag names with a negative sign to indicate that the subject having tags with those names will be excluded. For example, ?subjectTags=-TAG3,-TAG4 will return the subject hierarchy without subjects having tags - TAG3 and TAG4. Tags should be passed as an include filter or as an exclude filter but not the combination of both.

fieldsstring[]

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

Response

Success, returns specified subject heirarchy.

absolutePathstring

The absolute path of the subject. This is automatically set based on the name and hierarchy.

descriptionstring

A description of the subject. 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 subject. A lens may choose to display this information to the user e.g. if the user clicks a “help” icon attached to the subject.

helpUrlstring

The url where a user can go to get more help about the subject. A lens may choose to display this information to the user e.g. if the user clicks a “help” icon attached to the subject.

idstring
imageUrlstring

Optional icon to represent the subject.

isPublishedboolean

Default false. When set to true, the subject is readable by other users; when set to false, the subject is only readable by its owner.

namestring

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

sortBystring

The sortBy string can be used to define the sort order of subjects which a lens developer can choose to honor when rendering the data. The attribute is defaulted to an empty string when the user does not provide any string value. Max 254 characters; case insensitive; allows alpha-numeric characters, + underscore () and dash (-). Filter by sortBy; asterisk (*) wildcards ok. Max 254 characters; case insensitive; allows alpha-numeric characters, underscore () and dash (-).

parentIdstring

The id of the subject's parent, empty if this subject is at the root of the hierarchy.

parentAbsolutePathstring

The absolute path of the subject's parent, empty if this subject is at the root of the hierarchy.

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 (-).

samplesobject[]

TODO

hierarchyLevelinteger

The depth of the subject starting from the root. The root always has a hierarchy level of 1