Custom Fields

Custom Fields

Creates a new custom field record that does not already exist.

This method will auto-generate an ID and create a new custom field. If an ID is specified for the custom field, an error will be thrown.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The custom field that you would like to be saved.

id
required
string (ID) ^[a-z\d:_-]{1,300}__c$

The safe field name used in reporting and data storage. This must be unique

display_order
number <float> (Display Order)

An optional display order

service
required
string (Service)

The service for which this custom field is being created.

name
required
string (Name)

The name of the custom field, visible on forms to users

form_prompt
string (Form Prompt)

Optional text to display when filling out a form with this field; if not set, the field name is used

type
required
string (Type)

The data type to be used

Enum: "text" "email" "phone" "percent" "currency" "url" "image" "file" "reference" "picklist" "multiselect picklist" "checkboxes" "radiobuttons" "table" "html" "large text" "number" "date" "date-time" "yes-no" "electronic signature" "rating"
Array of objects
object (Textbox Options)
required
object (Rating Options)
object (Complex Requirement Rules)

Advanced rules for when this field should be required

enable_parent_field_mapping
boolean (Enable Parent Field Mapping)

Determines whether parent field mappings are enabled

required
object (Parent Child Options)

For picklists, define a parent/child mapping between fields in the parent picklist and fields in this one

use_curated_dataset
boolean (Use Curated Dataset)

For list based values, whether to download data from a Rhythm curated dataset

curated_dataset
string (Curated Dataset)

The name of the cureated dataset to use

enable_default_value
boolean (Enable Default Value)

Whether or not this custom field should have a default value

default_value
object (Default Value)

Default value to use for this field

can_enter_new_values
boolean (Can Enter New Values)

For picklists, whether you can enter in new values

portal_accessibility
string (Portal Accessibility)
Enum: "write" "read only" "none"
custom_object_id
required
string (Custom Object)

For table custom fields, the custom object being references

use_first_value_as_default
boolean (Use First Value As Default)
sort_values_alphabetically
boolean (Sort Values Alphabetically)
required
boolean (Required)
optional_in_console
boolean (Optional In Console)
number_of_decimal_places
integer (Number Of Decimal Places)
maximum_number_of_words
number <float> (Maximum Number Of Words)

For large text fields, the maximum # of words

help_text
string (Help Text)

Help text shown to the user

reference_type
string (Reference Type)

For reference lookup fields, the service/object being referenced

is_active
boolean (Is Active)

Whether not this is an active field that should be displayed in dropdowns

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The custom field was saved successfully.
400The custom field you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The custom field could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add custom field based on tenant limits.
500General server error.
post/customFields/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "display_order": 0,
  • "service": "string",
  • "name": "string",
  • "form_prompt": "string",
  • "type": "text",
  • "acceptable_values": [
    ],
  • "textbox_options": {
    },
  • "rating_options": {
    },
  • "complex_requirement_rules": {
    },
  • "enable_parent_field_mapping": true,
  • "parent_child_options": {
    },
  • "use_curated_dataset": true,
  • "curated_dataset": "string",
  • "enable_default_value": true,
  • "default_value": { },
  • "can_enter_new_values": true,
  • "portal_accessibility": "write",
  • "custom_object_id": "string",
  • "use_first_value_as_default": true,
  • "sort_values_alphabetically": true,
  • "required": true,
  • "optional_in_console": true,
  • "number_of_decimal_places": 0,
  • "maximum_number_of_words": 0,
  • "help_text": "string",
  • "reference_type": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "display_order": 0,
  • "service": "string",
  • "name": "string",
  • "form_prompt": "string",
  • "type": "text",
  • "acceptable_values": [
    ],
  • "textbox_options": {
    },
  • "rating_options": {
    },
  • "complex_requirement_rules": {
    },
  • "enable_parent_field_mapping": true,
  • "parent_child_options": {
    },
  • "use_curated_dataset": true,
  • "curated_dataset": "string",
  • "enable_default_value": true,
  • "default_value": { },
  • "can_enter_new_values": true,
  • "portal_accessibility": "write",
  • "custom_object_id": "string",
  • "use_first_value_as_default": true,
  • "sort_values_alphabetically": true,
  • "required": true,
  • "optional_in_console": true,
  • "number_of_decimal_places": 0,
  • "maximum_number_of_words": 0,
  • "help_text": "string",
  • "reference_type": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Gets all of the custom fields in the system.

This method will scan all custom fields and and return them to the caller.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKey
string

The start key, if you're making a subsequent request

Responses
200The custom fieldswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/customFields/{tenantId}
Request samples
curl -i -X GET \
  'https://platform.api.756794052567.rhythmsoftware.com/customFields/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a custom field from the system by its ID.

This method will look up a custom field by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the custom field to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The custom field was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The custom field could not be found.
429Limit exceeded... unable to retrieve custom field based on tenant limits.
500General server error.
get/customFields/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://platform.api.756794052567.rhythmsoftware.com/customFields/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "display_order": 0,
  • "service": "string",
  • "name": "string",
  • "form_prompt": "string",
  • "type": "text",
  • "acceptable_values": [
    ],
  • "textbox_options": {
    },
  • "rating_options": {
    },
  • "complex_requirement_rules": {
    },
  • "enable_parent_field_mapping": true,
  • "parent_child_options": {
    },
  • "use_curated_dataset": true,
  • "curated_dataset": "string",
  • "enable_default_value": true,
  • "default_value": { },
  • "can_enter_new_values": true,
  • "portal_accessibility": "write",
  • "custom_object_id": "string",
  • "use_first_value_as_default": true,
  • "sort_values_alphabetically": true,
  • "required": true,
  • "optional_in_console": true,
  • "number_of_decimal_places": 0,
  • "maximum_number_of_words": 0,
  • "help_text": "string",
  • "reference_type": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a custom field with the specified ID.

This method will update an existing custom field with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the custom field to update.

Request Body schema: application/json

The updated custom field that will be saved.

id
required
string (ID) ^[a-z\d:_-]{1,300}__c$

The safe field name used in reporting and data storage. This must be unique

display_order
number <float> (Display Order)

An optional display order

service
required
string (Service)

The service for which this custom field is being created.

name
required
string (Name)

The name of the custom field, visible on forms to users

form_prompt
string (Form Prompt)

Optional text to display when filling out a form with this field; if not set, the field name is used

type
required
string (Type)

The data type to be used

Enum: "text" "email" "phone" "percent" "currency" "url" "image" "file" "reference" "picklist" "multiselect picklist" "checkboxes" "radiobuttons" "table" "html" "large text" "number" "date" "date-time" "yes-no" "electronic signature" "rating"
Array of objects
object (Textbox Options)
required
object (Rating Options)
object (Complex Requirement Rules)

Advanced rules for when this field should be required

enable_parent_field_mapping
boolean (Enable Parent Field Mapping)

Determines whether parent field mappings are enabled

required
object (Parent Child Options)

For picklists, define a parent/child mapping between fields in the parent picklist and fields in this one

use_curated_dataset
boolean (Use Curated Dataset)

For list based values, whether to download data from a Rhythm curated dataset

curated_dataset
string (Curated Dataset)

The name of the cureated dataset to use

enable_default_value
boolean (Enable Default Value)

Whether or not this custom field should have a default value

default_value
object (Default Value)

Default value to use for this field

can_enter_new_values
boolean (Can Enter New Values)

For picklists, whether you can enter in new values

portal_accessibility
string (Portal Accessibility)
Enum: "write" "read only" "none"
custom_object_id
required
string (Custom Object)

For table custom fields, the custom object being references

use_first_value_as_default
boolean (Use First Value As Default)
sort_values_alphabetically
boolean (Sort Values Alphabetically)
required
boolean (Required)
optional_in_console
boolean (Optional In Console)
number_of_decimal_places
integer (Number Of Decimal Places)
maximum_number_of_words
number <float> (Maximum Number Of Words)

For large text fields, the maximum # of words

help_text
string (Help Text)

Help text shown to the user

reference_type
string (Reference Type)

For reference lookup fields, the service/object being referenced

is_active
boolean (Is Active)

Whether not this is an active field that should be displayed in dropdowns

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The custom field was updated successfully.
400The custom field supplied was not valid.
401Unauthorized.
403Forbidden.
404The custom field could not be found.
409The custom field could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve custom field based on tenant limits.
500General server error.
put/customFields/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "display_order": 0,
  • "service": "string",
  • "name": "string",
  • "form_prompt": "string",
  • "type": "text",
  • "acceptable_values": [
    ],
  • "textbox_options": {
    },
  • "rating_options": {
    },
  • "complex_requirement_rules": {
    },
  • "enable_parent_field_mapping": true,
  • "parent_child_options": {
    },
  • "use_curated_dataset": true,
  • "curated_dataset": "string",
  • "enable_default_value": true,
  • "default_value": { },
  • "can_enter_new_values": true,
  • "portal_accessibility": "write",
  • "custom_object_id": "string",
  • "use_first_value_as_default": true,
  • "sort_values_alphabetically": true,
  • "required": true,
  • "optional_in_console": true,
  • "number_of_decimal_places": 0,
  • "maximum_number_of_words": 0,
  • "help_text": "string",
  • "reference_type": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "display_order": 0,
  • "service": "string",
  • "name": "string",
  • "form_prompt": "string",
  • "type": "text",
  • "acceptable_values": [
    ],
  • "textbox_options": {
    },
  • "rating_options": {
    },
  • "complex_requirement_rules": {
    },
  • "enable_parent_field_mapping": true,
  • "parent_child_options": {
    },
  • "use_curated_dataset": true,
  • "curated_dataset": "string",
  • "enable_default_value": true,
  • "default_value": { },
  • "can_enter_new_values": true,
  • "portal_accessibility": "write",
  • "custom_object_id": "string",
  • "use_first_value_as_default": true,
  • "sort_values_alphabetically": true,
  • "required": true,
  • "optional_in_console": true,
  • "number_of_decimal_places": 0,
  • "maximum_number_of_words": 0,
  • "help_text": "string",
  • "reference_type": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a custom field with the specified ID.

This method will patch an existing custom field with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the custom field to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The custom field was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The custom field could not be found.
409The custom field could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve custom field based on tenant limits.
500General server error.
patch/customFields/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "display_order": 0,
  • "service": "string",
  • "name": "string",
  • "form_prompt": "string",
  • "type": "text",
  • "acceptable_values": [
    ],
  • "textbox_options": {
    },
  • "rating_options": {
    },
  • "complex_requirement_rules": {
    },
  • "enable_parent_field_mapping": true,
  • "parent_child_options": {
    },
  • "use_curated_dataset": true,
  • "curated_dataset": "string",
  • "enable_default_value": true,
  • "default_value": { },
  • "can_enter_new_values": true,
  • "portal_accessibility": "write",
  • "custom_object_id": "string",
  • "use_first_value_as_default": true,
  • "sort_values_alphabetically": true,
  • "required": true,
  • "optional_in_console": true,
  • "number_of_decimal_places": 0,
  • "maximum_number_of_words": 0,
  • "help_text": "string",
  • "reference_type": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a custom field from the system by its ID.

This method will delete a custom field with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the custom field to delete.

Responses
200The custom field was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The custom field could not be found.
409The custom field could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete custom field based on tenant limits.
500General server error.
delete/customFields/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://platform.api.756794052567.rhythmsoftware.com/customFields/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Returns a list of records with the specified service

Returns a list of records with the specified service

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

service
required
string

The service to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/customFields/{tenantId}/service/{service}
Request samples
curl -i -X GET \
  'https://platform.api.756794052567.rhythmsoftware.com/customFields/:tenantId/service/:service?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The custom field could not be found.
429Limit exceeded... unable to retrieve custom field based on tenant limits.
500General server error.
post/customFields/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}