mstrio > helpers

exception mstrio.helpers.IServerError(message, http_code)

Bases: OSError

add_note(object, /)

Exception.add_note(note) – add a note to the exception

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

characters_written

errno

POSIX exception code

filename

exception filename

filename2

second exception filename

strerror

exception strerror

exception mstrio.helpers.IServerException

Bases: Exception

add_note(object, /)

Exception.add_note(note) – add a note to the exception

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception mstrio.helpers.MstrException(err_data)

Bases: Exception

Base class for exceptions returned by the Strategy One REST API.

Parameters:

err_data (dict) –

code

Error code

message

Error message

ticket_id

MSTR Ticket ID

add_note(object, /)

Exception.add_note(note) – add a note to the exception

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception mstrio.helpers.MstrTimeoutError(err_data)

Bases: MstrException

Parameters:

err_data (dict) –

add_note(object, /)

Exception.add_note(note) – add a note to the exception

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception mstrio.helpers.NotSupportedError

Bases: Exception

add_note(object, /)

Exception.add_note(note) – add a note to the exception

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception mstrio.helpers.PartialSuccess(data)

Bases: Exception

This error holds details about the requested operation.

Parameters:

data (list[dict]) –

succeeded

list of succeeded operations dict elements

failed

list of failed operations dict elements

add_note(object, /)

Exception.add_note(note) – add a note to the exception

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception mstrio.helpers.PromptedContentError

Bases: Exception

add_note(object, /)

Exception.add_note(note) – add a note to the exception

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception mstrio.helpers.Success(data)

Bases: Exception

This error holds details about the requested operation.

Parameters:

data (list[dict]) –

succeeded

list of succeeded operations dict elements

add_note(object, /)

Exception.add_note(note) – add a note to the exception

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

exception mstrio.helpers.VersionException

Bases: Exception

add_note(object, /)

Exception.add_note(note) – add a note to the exception

with_traceback(object, /)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args

flag mstrio.helpers.AggregatedRights(value)

Bases: IntFlag

Enumeration constants used to specify combination of Rights values.

Member Type:

int

Valid values are as follows:

NONE = <AggregatedRights.NONE: 0>

CONSUME = <AggregatedRights.CONSUME: 69>

VIEW = <AggregatedRights.VIEW: 197>

MODIFY = <AggregatedRights.MODIFY: 221>

ALL = <AggregatedRights.ALL: 255>

enum mstrio.helpers.Permissions(value)

Bases: Enum

Enumeration constants used to specify combination of Rights values similar to workstation Security Access.

This has to be string-based to discern between ‘Denied All’ and ‘Full Control’, which have the same mask.

Valid values are as follows:

DENIED_ALL = <Permissions.DENIED_ALL: 'Denied All'>

DEFAULT_ALL = <Permissions.DEFAULT_ALL: 'Default All'>

CONSUME = <Permissions.CONSUME: 'Consume'>

VIEW = <Permissions.VIEW: 'View'>

MODIFY = <Permissions.MODIFY: 'Modify'>

FULL_CONTROL = <Permissions.FULL_CONTROL: 'Full Control'>

flag mstrio.helpers.Rights(value)

Bases: IntFlag

Enumeration constants used to specify the access granted attribute of the DSS objects.

Member Type:

int

Valid values are as follows:

EXECUTE = <Rights.EXECUTE: 128>

USE = <Rights.USE: 64>

CONTROL = <Rights.CONTROL: 32>

DELETE = <Rights.DELETE: 16>

WRITE = <Rights.WRITE: 8>

READ = <Rights.READ: 4>

USE_EXECUTE = <Rights.USE_EXECUTE: 2>

BROWSE = <Rights.BROWSE: 1>

INHERITABLE = <Rights.INHERITABLE: 536870912>