Dataset and Session Objects

Parent Previous Next

report_objects.DatasetREST object

This object is a Python representation of a Nexus dataset object.  When this object is created, a GUID will automatically be generated for the object.

Data members

The following attributes are available on a DatasetREST object:

Methods

dataset.set_tags(tagstring)

Set the tags for the dataset to the passed string. Multiple tags are space-separated.


dataset.get_tags()

Returns the tags string for this object. Multiple tags are space-separated.


dataset.add_tag(tag, value=None)

Adds a tag to the current tag string.  If no value is passed, the simple tag string is added to the tags string.  If a value is specified, a string of the form tag=value will be added to the tag string.


dataset.rem_tag(tag)

Remove the tag (and any potential associated value) from the current tag string.


report_objects.SessionREST object

This object is a Python representation of a Nexus session object.  When this object is created, a GUID will automatically be generated for the object and the date is set to the current time/date.

Data members

The following attributes are available on a SessionREST object:

Methods

session.set_tags(tagstring)

Set the tags for the session to the passed string. Multiple tags are space-separated.


session.get_tags()

Returns the tags string for this object. Multiple tags are space-separated.


session.add_tag(tag, value=None)

Adds a tag to the current tag string.  If no value is passed, the simple tag string is added to the tags string.  If a value is specified, a string of the form tag=value will be added to the tag string.


session.rem_tag(tag)

Remove the tag (and any potential associated value) from the current tag string.