CustomObject
class resources.custom_object.CustomObject
Base class: Resource
An object built upon an object_template.
See the corresponding Flow Api class at CustomObject
| Property | Description | Type | Import/Export |
|---|---|---|---|
| bundle_id | Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, 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 | UUID(as_uuid=False) | both |
| bundle_name | The name of the bundle. Will look up the bundle and set bundle_id. | String(length=128) | neither |
| commit_message | The commit message for this change. | Text() | import only |
| created_at | DateTime(timezone=True) | export only | |
| created_by | UUID(as_uuid=False) | export only | |
| deleted_at | DateTime(timezone=True) | export only | |
| deleted_by | UUID(as_uuid=False) | export only | |
| description | A multiline description of what this record is and does. | Text() | both |
| id | UUID(as_uuid=False) | neither | |
| is_bundle_readonly | Boolean() | neither | |
| is_deleted | Boolean() | export only | |
| is_project_readonly | Boolean() | neither | |
| is_readonly | A flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, 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 | Boolean() | both |
| modified_at | DateTime(timezone=True) | export only | |
| modified_by | UUID(as_uuid=False) | export only | |
| name | The name of this record. Must be unique across a workspace. | String(length=128) | both |
| object_template_id | Reference to the object_template this object was built upon. | UUID(as_uuid=False) | both |
| organization_id | UUID(as_uuid=False) | export only | |
| project_id | Reference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, 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. | UUID(as_uuid=False) | both |
| project_name | The name of the project. Will look up the project and set project_id. | String(length=128) | neither |
| provisioning_state | The state of the custom object. One of CREATE_FAILED, CREATING, DELETE_FAILED, DELETING, READY, UPDATE_FAILED, UPDATING. | Enum('CREATING', 'CREATE_FAILED', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', 'READY', name='customobjectprovisioningstate') | export only |
| record_type | Enum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'EXECUTION', 'FILE', 'FLOW', 'LDAP_CONFIG', 'MESSAGE', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROCESS', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype') | neither | |
| repository_path | The path to the storing repository, relative to GIT_REPOSITORY_SAVE_PATH | String(length=256) | neither |
| resource_type | Enum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'FILE', 'FLOW', 'LDAP_CONFIG', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='resourcetype') | neither | |
| schema_version | String(length=128) | both | |
| value | The data as defined by the object_template attributes. | JSONB(astext_type=Text()) | both |
| workspace_id | UUID(as_uuid=False) | export only |