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
bodyUnionThe body of the message form.
bundle_idUnionReference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, LDAP_CONFIG, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, CHAT, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id
bundle_nameUnionThe name of the bundle. Will look up the bundle and set bundle_id.
bystr
clsOptional
commitbool
commit_messageUnionThe commit message for this change.
debugboolif set, the content of the data being written will be logged.
descriptionUnionA multiline description of what this record is and does.
initOptional
is_readonlyUnionA 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 CHAT, EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE
is_submittedUnionIf the response was submitted by the user.
location_inheritanceUnionControls 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 record types description
created_by all use the same location as the identity which creates the record
default all use the "Default project" where applicable or "Workspace" for record types which cannot be in a project
wrapped_resource execution use the same location as the innermost resource which is wrapped
resource execution use the same location as the resource on which the execution is based on
Notes:
  • If a project_id/project_name/bundle_id/bundle_name is specified in the request, it always takes precedence.
  • The options wrapped_resource and resource only work with executions which are based on a resource, not with ad-hoc connections or executions of type "SCRIPT". If used with ad-hoc connections or "SCRIPT" it will fall back to default.
  • If the record being created cannot be associated with the specified location, the fallback to default will be used.
  • If location_inheritance is unset, the default value used depends on the type of identity which creates the record as well as the type of record which is created. If an execution is created by any identity which is not an execution, it defaults to wrapped_resource. In all other cases it defaults to created_by.
messageOptional
message_typeUnionThe type of the message.
nameUnionThe name of this record. Must be unique across a workspace.
project_idUnionReference 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, CHAT, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.
project_nameUnionThe name of the project. Will look up the project and set project_id.
requestOptional
responseUnionThe response given by a user.
selectOptional
subjectUnionThe message subject.
track_in_gitUnionShould new records automatically be tracked in git.

Constants

RESOURCE = message

Methods

add_record_metadata

add_record_tag

add_record_user

bundle

clone

created_by_identity

delete

deleted_by_identity

duplicate

execution_list

exists

export

get

get_dict

git_log_list

metadata

metadata_exists

modified_by_identity

organization

pending_delete_identity_id_identity

pending_restore_identity_id_identity

pending_trash_identity_id_identity

project

record_log_list

record_metadata_list

record_tag_list

record_user_list

restore

save

wait

workspace