Skip to main content
Version: 7 - Gugelhupf

Message

class resources.message.Message

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 Flow Api class at Message

PropertyDescriptionTypeImport/Export
activity_typeEnum('EXECUTION', 'MESSAGE', 'PROCESS', name='activitytype')neither
bodyThe body of the message form.JSONB(astext_type=Text())both
bundle_idReference to the bundle this record is associated with. Allowed for CONNECTOR, FILE, FLOW, PLUGIN, ROLE, SCHEDULER, SCHEMA, SETTING, TAG, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, EXECUTION, GIT_CONFIG, MESSAGE, OAUTH, ORGANIZATION, PROCESS, PROJECT, SCHEDULE, SYNC_CONFIG, USER, VAULT_CONFIG, WEBHOOK, WORKSPACE. Mutually exclusive with project_idUUID()both
created_atDateTime(timezone=True)export only
created_byUUID()export only
deleted_atDateTime(timezone=True)export only
deleted_byUUID()export only
descriptionText()both
idUUID()neither
is_archivedBoolean()both
is_bundle_readonlyBoolean()neither
is_project_readonlyBoolean()neither
is_readonlyA flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, FILE, FLOW, GIT_CONFIG, OAUTH, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for EXECUTION, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACEBoolean()both
is_submittedIf the response was submitted by the user.Boolean()both
message_typeThe type of the message.Enum('SUCCESS', 'INFO', 'WARNING', 'ERROR', 'POPUP', name='messagetype')both
modified_atDateTime(timezone=True)export only
modified_byUUID()export only
nameString(length=128)both
organization_idUUID()export only
project_idReference to the project this record is associated with. Allowed for CONNECTOR, EXECUTION, FILE, FLOW, GIT_CONFIG, MESSAGE, OAUTH, PLUGIN, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.UUID()both
record_typeEnum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'EXECUTION', 'FILE', 'FLOW', 'GIT_CONFIG', 'MESSAGE', 'OAUTH', 'ORGANIZATION', 'PLUGIN', 'PROCESS', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype')neither
responseThe response given by a user.JSONB(astext_type=Text())both
schema_versionString(length=128)neither
subjectThe message subject.String(length=128)both
workspace_idUUID()export only