The Platform API contains tenant level configuration and settings used throughout Rhythm. This includes Saved Queries, Custom Fields, and Forms.
The Platform API contains tenant level configuration and settings used throughout Rhythm. This includes Saved Queries, Custom Fields, and Forms.
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customFields/{tenantId}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The custom fieldswere retrieved successfully.
Advanced rules for when this field should be required
For table custom fields, the custom object being references
Whether or not this custom field should have a default value
Determines whether parent field mappings are enabled
Optional text to display when filling out a form with this field; if not set, the field name is used
The safe field name used in reporting and data storage. This must be unique
Whether not this is an active field that should be displayed in dropdowns
For large text fields, the maximum # of words
For picklists, define a parent/child mapping between fields in the parent picklist and fields in this one
The maximum rating value that can be given
The meaning of the maximum value of hte scale (i.e., Very Important, Very Satisfied
The meaning of the minimum value of the scale (i.e., Not Important, Unsatisfied)
For reference lookup fields, the service/object being referenced
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The data type to be used
For list based values, whether to download data from a Rhythm curated dataset
[ { "acceptable_values": [ … ], "can_enter_new_values": true, "complex_requirement_rules": { … }, "curated_dataset": "string", "custom_object_id": "string", "default_value": {}, "display_order": 0.1, "enable_default_value": true, "enable_parent_field_mapping": true, "form_prompt": "string", "help_text": "string", "id": "string", "is_active": true, "maximum_number_of_words": 0.1, "name": "string", "number_of_decimal_places": 0, "optional_in_console": true, "parent_child_options": { … }, "portal_accessibility": "none", "rating_options": { … }, "reference_type": "string", "required": true, "service": "string", "sort_values_alphabetically": true, "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ … ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "textbox_options": { … }, "type": "checkboxes", "use_curated_dataset": true, "use_first_value_as_default": true } ]
The custom field that you would like to be saved.
Advanced rules for when this field should be required
For table custom fields, the custom object being references
Whether or not this custom field should have a default value
Determines whether parent field mappings are enabled
Optional text to display when filling out a form with this field; if not set, the field name is used
The safe field name used in reporting and data storage. This must be unique
Whether not this is an active field that should be displayed in dropdowns
For large text fields, the maximum # of words
For picklists, define a parent/child mapping between fields in the parent picklist and fields in this one
The maximum rating value that can be given
The meaning of the maximum value of hte scale (i.e., Very Important, Very Satisfied
The meaning of the minimum value of the scale (i.e., Not Important, Unsatisfied)
For reference lookup fields, the service/object being referenced
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The data type to be used
For list based values, whether to download data from a Rhythm curated dataset
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customFields/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"acceptable_values": [
{
"label": "string",
"value": "string"
}
],
"can_enter_new_values": true,
"complex_requirement_rules": {
"all": [
{
"all": {},
"any": {},
"fact": "string",
"operator": "contains",
"path": "string",
"value": "string"
}
],
"any": [
{
"all": {},
"any": {},
"fact": "string",
"operator": "contains",
"path": "string",
"value": "string"
}
]
},
"curated_dataset": "string",
"custom_object_id": "string",
"default_value": {},
"display_order": 0.1,
"enable_default_value": true,
"enable_parent_field_mapping": true,
"form_prompt": "string",
"help_text": "string",
"id": "string",
"is_active": true,
"maximum_number_of_words": 0.1,
"name": "string",
"number_of_decimal_places": 0,
"optional_in_console": true,
"parent_child_options": {
"field_mappings": [
{
"child_field_values": [
"string"
],
"parent_field_value": "string"
}
],
"parent_field_id": "string"
},
"portal_accessibility": "none",
"rating_options": {
"maximum_rating": 0.1,
"meaning_of_maximum": "string",
"meaning_of_minimum": "string",
"show_text": true,
"theme": "horizontal"
},
"reference_type": "string",
"required": true,
"service": "string",
"sort_values_alphabetically": true,
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_pk": "string",
"sys_bulk_load_record_no": 0.1,
"sys_bulk_load_source_file": "string",
"sys_calculated_field_error": "string",
"sys_calculated_field_errors": [
{
"error": "string",
"field": "string"
}
],
"sys_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"textbox_options": {
"append_text": "string",
"prepend_text": "string"
},
"type": "checkboxes",
"use_curated_dataset": true,
"use_first_value_as_default": true
}'The custom field was saved successfully.
Advanced rules for when this field should be required
For table custom fields, the custom object being references
Whether or not this custom field should have a default value
Determines whether parent field mappings are enabled
Optional text to display when filling out a form with this field; if not set, the field name is used
The safe field name used in reporting and data storage. This must be unique
Whether not this is an active field that should be displayed in dropdowns
For large text fields, the maximum # of words
For picklists, define a parent/child mapping between fields in the parent picklist and fields in this one
The maximum rating value that can be given
The meaning of the maximum value of hte scale (i.e., Very Important, Very Satisfied
The meaning of the minimum value of the scale (i.e., Not Important, Unsatisfied)
For reference lookup fields, the service/object being referenced
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The data type to be used
For list based values, whether to download data from a Rhythm curated dataset
{ "acceptable_values": [ { … } ], "can_enter_new_values": true, "complex_requirement_rules": { "all": [ … ], "any": [ … ] }, "curated_dataset": "string", "custom_object_id": "string", "default_value": {}, "display_order": 0.1, "enable_default_value": true, "enable_parent_field_mapping": true, "form_prompt": "string", "help_text": "string", "id": "string", "is_active": true, "maximum_number_of_words": 0.1, "name": "string", "number_of_decimal_places": 0, "optional_in_console": true, "parent_child_options": { "field_mappings": [ … ], "parent_field_id": "string" }, "portal_accessibility": "none", "rating_options": { "maximum_rating": 0.1, "meaning_of_maximum": "string", "meaning_of_minimum": "string", "show_text": true, "theme": "horizontal" }, "reference_type": "string", "required": true, "service": "string", "sort_values_alphabetically": true, "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "textbox_options": { "append_text": "string", "prepend_text": "string" }, "type": "checkboxes", "use_curated_dataset": true, "use_first_value_as_default": true }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customFields/{tenantId}/batch' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"operations": [
{
"id": null,
"object": {},
"operation": "create",
"patch_directives": {
"0": {
"op": "add",
"path": "string",
"value": "string"
}
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customFields/{tenantId}/service/{service}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customFields/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customFields/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The custom field was retrieved successfully.
Advanced rules for when this field should be required
For table custom fields, the custom object being references
Whether or not this custom field should have a default value
Determines whether parent field mappings are enabled
Optional text to display when filling out a form with this field; if not set, the field name is used
The safe field name used in reporting and data storage. This must be unique
Whether not this is an active field that should be displayed in dropdowns
For large text fields, the maximum # of words
For picklists, define a parent/child mapping between fields in the parent picklist and fields in this one
The maximum rating value that can be given
The meaning of the maximum value of hte scale (i.e., Very Important, Very Satisfied
The meaning of the minimum value of the scale (i.e., Not Important, Unsatisfied)
For reference lookup fields, the service/object being referenced
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The data type to be used
For list based values, whether to download data from a Rhythm curated dataset
{ "acceptable_values": [ { … } ], "can_enter_new_values": true, "complex_requirement_rules": { "all": [ … ], "any": [ … ] }, "curated_dataset": "string", "custom_object_id": "string", "default_value": {}, "display_order": 0.1, "enable_default_value": true, "enable_parent_field_mapping": true, "form_prompt": "string", "help_text": "string", "id": "string", "is_active": true, "maximum_number_of_words": 0.1, "name": "string", "number_of_decimal_places": 0, "optional_in_console": true, "parent_child_options": { "field_mappings": [ … ], "parent_field_id": "string" }, "portal_accessibility": "none", "rating_options": { "maximum_rating": 0.1, "meaning_of_maximum": "string", "meaning_of_minimum": "string", "show_text": true, "theme": "horizontal" }, "reference_type": "string", "required": true, "service": "string", "sort_values_alphabetically": true, "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "textbox_options": { "append_text": "string", "prepend_text": "string" }, "type": "checkboxes", "use_curated_dataset": true, "use_first_value_as_default": true }
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customFields/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The custom field was patched successfully.
Advanced rules for when this field should be required
For table custom fields, the custom object being references
Whether or not this custom field should have a default value
Determines whether parent field mappings are enabled
Optional text to display when filling out a form with this field; if not set, the field name is used
The safe field name used in reporting and data storage. This must be unique
Whether not this is an active field that should be displayed in dropdowns
For large text fields, the maximum # of words
For picklists, define a parent/child mapping between fields in the parent picklist and fields in this one
The maximum rating value that can be given
The meaning of the maximum value of hte scale (i.e., Very Important, Very Satisfied
The meaning of the minimum value of the scale (i.e., Not Important, Unsatisfied)
For reference lookup fields, the service/object being referenced
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The data type to be used
For list based values, whether to download data from a Rhythm curated dataset
{ "acceptable_values": [ { … } ], "can_enter_new_values": true, "complex_requirement_rules": { "all": [ … ], "any": [ … ] }, "curated_dataset": "string", "custom_object_id": "string", "default_value": {}, "display_order": 0.1, "enable_default_value": true, "enable_parent_field_mapping": true, "form_prompt": "string", "help_text": "string", "id": "string", "is_active": true, "maximum_number_of_words": 0.1, "name": "string", "number_of_decimal_places": 0, "optional_in_console": true, "parent_child_options": { "field_mappings": [ … ], "parent_field_id": "string" }, "portal_accessibility": "none", "rating_options": { "maximum_rating": 0.1, "meaning_of_maximum": "string", "meaning_of_minimum": "string", "show_text": true, "theme": "horizontal" }, "reference_type": "string", "required": true, "service": "string", "sort_values_alphabetically": true, "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "textbox_options": { "append_text": "string", "prepend_text": "string" }, "type": "checkboxes", "use_curated_dataset": true, "use_first_value_as_default": true }
The updated custom field that will be saved.
Advanced rules for when this field should be required
For table custom fields, the custom object being references
Whether or not this custom field should have a default value
Determines whether parent field mappings are enabled
Optional text to display when filling out a form with this field; if not set, the field name is used
The safe field name used in reporting and data storage. This must be unique
Whether not this is an active field that should be displayed in dropdowns
For large text fields, the maximum # of words
For picklists, define a parent/child mapping between fields in the parent picklist and fields in this one
The maximum rating value that can be given
The meaning of the maximum value of hte scale (i.e., Very Important, Very Satisfied
The meaning of the minimum value of the scale (i.e., Not Important, Unsatisfied)
For reference lookup fields, the service/object being referenced
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The data type to be used
For list based values, whether to download data from a Rhythm curated dataset
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customFields/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"acceptable_values": [
{
"label": "string",
"value": "string"
}
],
"can_enter_new_values": true,
"complex_requirement_rules": {
"all": [
{
"all": {},
"any": {},
"fact": "string",
"operator": "contains",
"path": "string",
"value": "string"
}
],
"any": [
{
"all": {},
"any": {},
"fact": "string",
"operator": "contains",
"path": "string",
"value": "string"
}
]
},
"curated_dataset": "string",
"custom_object_id": "string",
"default_value": {},
"display_order": 0.1,
"enable_default_value": true,
"enable_parent_field_mapping": true,
"form_prompt": "string",
"help_text": "string",
"id": "string",
"is_active": true,
"maximum_number_of_words": 0.1,
"name": "string",
"number_of_decimal_places": 0,
"optional_in_console": true,
"parent_child_options": {
"field_mappings": [
{
"child_field_values": [
"string"
],
"parent_field_value": "string"
}
],
"parent_field_id": "string"
},
"portal_accessibility": "none",
"rating_options": {
"maximum_rating": 0.1,
"meaning_of_maximum": "string",
"meaning_of_minimum": "string",
"show_text": true,
"theme": "horizontal"
},
"reference_type": "string",
"required": true,
"service": "string",
"sort_values_alphabetically": true,
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_pk": "string",
"sys_bulk_load_record_no": 0.1,
"sys_bulk_load_source_file": "string",
"sys_calculated_field_error": "string",
"sys_calculated_field_errors": [
{
"error": "string",
"field": "string"
}
],
"sys_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"textbox_options": {
"append_text": "string",
"prepend_text": "string"
},
"type": "checkboxes",
"use_curated_dataset": true,
"use_first_value_as_default": true
}'The custom field was updated successfully.
Advanced rules for when this field should be required
For table custom fields, the custom object being references
Whether or not this custom field should have a default value
Determines whether parent field mappings are enabled
Optional text to display when filling out a form with this field; if not set, the field name is used
The safe field name used in reporting and data storage. This must be unique
Whether not this is an active field that should be displayed in dropdowns
For large text fields, the maximum # of words
For picklists, define a parent/child mapping between fields in the parent picklist and fields in this one
The maximum rating value that can be given
The meaning of the maximum value of hte scale (i.e., Very Important, Very Satisfied
The meaning of the minimum value of the scale (i.e., Not Important, Unsatisfied)
For reference lookup fields, the service/object being referenced
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The data type to be used
For list based values, whether to download data from a Rhythm curated dataset
{ "acceptable_values": [ { … } ], "can_enter_new_values": true, "complex_requirement_rules": { "all": [ … ], "any": [ … ] }, "curated_dataset": "string", "custom_object_id": "string", "default_value": {}, "display_order": 0.1, "enable_default_value": true, "enable_parent_field_mapping": true, "form_prompt": "string", "help_text": "string", "id": "string", "is_active": true, "maximum_number_of_words": 0.1, "name": "string", "number_of_decimal_places": 0, "optional_in_console": true, "parent_child_options": { "field_mappings": [ … ], "parent_field_id": "string" }, "portal_accessibility": "none", "rating_options": { "maximum_rating": 0.1, "meaning_of_maximum": "string", "meaning_of_minimum": "string", "show_text": true, "theme": "horizontal" }, "reference_type": "string", "required": true, "service": "string", "sort_values_alphabetically": true, "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "textbox_options": { "append_text": "string", "prepend_text": "string" }, "type": "checkboxes", "use_curated_dataset": true, "use_first_value_as_default": true }