v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB

subjects

Find subjects

Find a subject or subjects. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response. The global default limit will apply if no limit param is specified.

get/subjects

Query parameters

fieldsstring[]

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

sortstring[]

Specify the sort order using a field name, e.g. '...?sort=name'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

absolutePathstring

Filter by absolutePath; asterisk (*) wildcards ok.

descriptionstring

Filter by description; asterisk (*) wildcards ok.

helpEmailstring

Filter by helpEmail; asterisk (*) wildcards ok.

helpUrlstring

Filter by helpUrl; asterisk (*) wildcards ok.

imageUrlstring

Filter by imageUrl; asterisk (*) wildcards ok.

isPublishedboolean

Filter by isPublished (true|false).

namestring

Filter by name; asterisk (*) wildcards ok.

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.

parentAbsolutePathstring

Filter by parentAbsolutePath; asterisk (*) wildcards ok.

tagsstring[]

Comma-separated list of tags to include/exclude. Tag names are case-insensitive. For example, ?tags=FOO,BAR will only return subjects with tags FOO or BAR. Prefix each of the tag name with a negative sign to indicate that a subject with that tag should be excluded. For example, ?tags=-BAZ,-FOO will return only the subjects with tag name not equal to BAZ or FOO. Subjects without tags are not included in the result set.

createdAtstring

Filter by time period when subjects were created.

updatedAtstring

Filter by time period when subjects were updated.

Response

Success, a list of subjects.

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