Skip to main content
Version: 10 - Vanillekipferl

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'>, 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
bodytyping.Union[ flow_api.system.NotSet, typing.Any, NoneType ]The body of the message form.
bundle_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, FILE, FLOW, LDAP_CONFIG, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, EXECUTION, MESSAGE, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id
bundle_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the bundle. Will look up the bundle and set bundle_id.
bystr
clstyping.Union[ type, NoneType ]
commitbool
commit_messagetyping.Union[ flow_api.system.NotSet, str, NoneType ]The commit message for this change.
debugboolif set, the content of the data being written will be logged.
descriptiontyping.Union[ flow_api.system.NotSet, str, NoneType ]A multiline description of what this record is and does.
inittyping.Union[ dict, NoneType ]
is_readonlytyping.Union[ flow_api.system.NotSet, bool ]A flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, FILE, FLOW, OAUTH, OBJECT_TEMPLATE, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE
is_submittedtyping.Union[ flow_api.system.NotSet, bool ]If the response was submitted by the user.
location_inheritancetyping.Union[ flow_api.system.NotSet, str, NoneType ]Controls the project/bundle association of a newly created record when no project_id/project_name/bundle_id/bundle_name is specified in the create request. Depending on the record type different options are available: location_inheritance
messagetyping.Union[ str, NoneType ]
message_typetyping.Union[ flow_api.system.NotSet, str ]The type of the message.
nametyping.Union[ flow_api.system.NotSet, str ]The name of this record. Must be unique across a workspace.
project_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]Reference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.
project_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the project. Will look up the project and set project_id.
requesttyping.Union[ str, NoneType ]
responsetyping.Union[ flow_api.system.NotSet, typing.Any, NoneType ]The response given by a user.
selecttyping.Union[ str, NoneType ]
subjecttyping.Union[ flow_api.system.NotSet, str ]The message subject.

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​