Skip to main content
Version: 8 - Apfelstrudel

Schema

class resources.schema.Schema

Base class: Resource

A YAML schema document which can be used to validate data.

See the corresponding Flow Api class at Schema

PropertyDescriptionTypeImport/Export
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, LDAP_CONFIG, MESSAGE, OAUTH, ORGANIZATION, PROCESS, PROJECT, SCHEDULE, SYNC_CONFIG, USER, VAULT_CONFIG, WEBHOOK, WORKSPACE. Mutually exclusive with project_idUUID(as_uuid=False)both
bundle_nameThe name of the bundle. Will look up the bundle and set bundle_id.String(length=128)neither
created_atDateTime(timezone=True)export only
created_byUUID(as_uuid=False)export only
deleted_atDateTime(timezone=True)export only
deleted_byUUID(as_uuid=False)export only
descriptionText()both
idUUID(as_uuid=False)neither
is_archivedBoolean()both
is_bundle_readonlyBoolean()neither
is_deletedBoolean()export only
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, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACEBoolean()both
modified_atDateTime(timezone=True)export only
modified_byUUID(as_uuid=False)export only
nameString(length=128)both
organization_idUUID(as_uuid=False)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, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.UUID(as_uuid=False)both
project_nameThe name of the project. Will look up the project and set project_id.String(length=128)neither
record_typeEnum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'EXECUTION', 'FILE', 'FLOW', 'GIT_CONFIG', 'LDAP_CONFIG', 'MESSAGE', 'OAUTH', 'ORGANIZATION', 'PLUGIN', 'PROCESS', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype')neither
repository_pathThe path to the storing repository, relative to GIT_REPOSITORY_SAVE_PATHString(length=256)neither
resource_typeEnum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'FILE', 'FLOW', 'GIT_CONFIG', 'LDAP_CONFIG', 'OAUTH', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='resourcetype')neither
schema_versionString(length=128)both
valueThe data stored in the schema.JSONB(astext_type=Text())both
workspace_idUUID(as_uuid=False)export only