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
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
allow_deleted | bool | ||||||||||||||||
allow_normal | bool | ||||||||||||||||
body | typing.Union[ flow_api.system.NotSet, typing.Any, NoneType ] | The body of the message form. | |||||||||||||||
bundle_id | typing.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, 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, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id | |||||||||||||||
bundle_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the bundle. Will look up the bundle and set bundle_id. | |||||||||||||||
by | str | ||||||||||||||||
cls | typing.Union[ type, NoneType ] | ||||||||||||||||
commit | bool | ||||||||||||||||
commit_message | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The commit message for this change. | |||||||||||||||
debug | bool | if set, the content of the data being written will be logged. | |||||||||||||||
description | typing.Union[ flow_api.system.NotSet, str, NoneType ] | A multiline description of what this record is and does. | |||||||||||||||
init | typing.Union[ dict, NoneType ] | ||||||||||||||||
is_readonly | typing.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_submitted | typing.Union[ flow_api.system.NotSet, bool ] | If the response was submitted by the user. | |||||||||||||||
location_inheritance | typing.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:
| |||||||||||||||
message | typing.Union[ str, NoneType ] | ||||||||||||||||
message_type | typing.Union[ flow_api.system.NotSet, str ] | The type of the message. | |||||||||||||||
name | typing.Union[ flow_api.system.NotSet, str ] | The name of this record. Must be unique across a workspace. | |||||||||||||||
project_id | typing.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_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the project. Will look up the project and set project_id. | |||||||||||||||
request | typing.Union[ str, NoneType ] | ||||||||||||||||
response | typing.Union[ flow_api.system.NotSet, typing.Any, NoneType ] | The response given by a user. | |||||||||||||||
select | typing.Union[ str, NoneType ] | ||||||||||||||||
subject | typing.Union[ flow_api.system.NotSet, str ] | The message subject. | |||||||||||||||
track_in_git | typing.Union[ flow_api.system.NotSet, bool, NoneType ] | Should new records automatically be tracked in git. |