SAsalesforce
subjects

Update subject (full)

Update the specified subject. If a field is not included in the query body, that field will be set to null or its default value. You can only unpublish a subject if it has no subject children of its own or if all its descendants are unpublished. Beware! Updating a subject's name/parentId/parentAbsolutePath deletes all the samples associated with this subject.

put/subjects/{key}

Request

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

Path parameters

keystring required

The id or absolute path of the subject to update.

Request body

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.

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. You can only unpublish a subject if it has no subject children of its own or if all its descendants are unpublished.

namestring required

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.

parentAbsolutePathstring

The absolutePath of the subject's parent.

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

geolocationnumber[]

If the subject has a physical location, specify its longitude and latitude in this two-element array, e.g. [-122.431297, 37.773972]. The first element in the array represents longitude; the second element represents latitude.

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Response

Success, returns updated subject.

absolutePathstring

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

childrenSubjectsResponse[] circular
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

Changes

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