Skip to main content
Version: 12 - TBD

Message

class flow_api.message.Message(select=None, cls=None, init=None, by='id', allow_normal=True, allow_deleted=False, commit=False, body=<class 'flow_api.system.NotSet'>, bundle_id=<class 'flow_api.system.NotSet'>, bundle_name=<class 'flow_api.system.NotSet'>, commit_message=<class 'flow_api.system.NotSet'>, description=<class 'flow_api.system.NotSet'>, is_readonly=<class 'flow_api.system.NotSet'>, is_submitted=<class 'flow_api.system.NotSet'>, location_inheritance=<class 'flow_api.system.NotSet'>, message_type=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, response=<class 'flow_api.system.NotSet'>, subject=<class 'flow_api.system.NotSet'>, track_in_git=<class 'flow_api.system.NotSet'>, debug=False, request=None, message=None)

Base class: Activity

There are two uses for messages:

  • A form which a user can fill out to provide data to an execution,
  • A message generated by an execution to inform a user.

See the corresponding Resources class at Message

Parameters

NameTypeDescription
allow_deletedbool
allow_normalbool
bodyUnion
bundle_idUnion
bundle_nameUnion
bystr
clsOptional
commitbool
commit_messageUnion
debugbool
descriptionUnion
initOptional
is_readonlyUnion
is_submittedUnion
location_inheritanceUnion
messageOptional
message_typeUnion
nameUnion
project_idUnion
project_nameUnion
requestOptional
responseUnion
selectOptional
subjectUnion
track_in_gitUnion

Constants

RESOURCE = message

Methods

add_record_metadata

add_record_tag

add_record_user

bundle

clone

created_by_identity

delete

deleted_by_identity

execution_list

exists

export

get

get_dict

git_log_list

metadata

modified_by_identity

organization

project

record_log_list

record_metadata_list

record_tag_list

record_user_list

restore

save

wait

workspace