Platform

Execute Batch Operations

Platform (v1-2025-04-18)

The Platform API contains tenant level configuration and settings used throughout Rhythm. This includes Saved Queries, Custom Fields, and Forms.

Download OpenAPI description

platform-v1.json

platform-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/

https://platform.api.rhythmsoftware.com/

360 Screens

Operations

Custom Fields

Operations

Custom Objects

Operations

Custom Query Definitions

Operations

Custom Record Actions

Operations

Customization Config Settings

Operations

Gets all of the customization config settings in the system.

Request

This method will scan all customization config settings and and return them to the caller.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customizationConfigSettings/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The customization config settingswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

abbreviated_namestring(Abbreviated Name)required

The short, abbreviated name of the setting

acceptable_valuesArray of objectsnon-emptyrequired

acceptable_values[].namestring(Name)required

acceptable_values[].valuestring(Value)required

boolean_valueboolean(Boolean Value)required

categorystring(Category)required

A category for the configuration setting

date_valuestring(Date Value)required

descriptionstring(Description)required

A description of this configuration setting

email_valueobject(Email Value)required

email_value.bccstring(Bcc)

Anyone that should be bcc'ed on the email

email_value.bodystring(Body)required

The email body

email_value.ccstring(Cc)

Anyone that should be cc'ed on the email

email_value.fromstring(From)

From email address

email_value.from_namestring(From Name)

From name

email_value.reply_tostring(Reply To)

The reply to

email_value.subjectstring(Subject)required

The email subject

help_textstring(Help Text)

Any applicable help text

html_valuestring(Html Value)required

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this customization config setting

json_valueobject(Json Value)required

merge_fieldsArray of objects

For emails, allows for designation of merge fields

namestring(Name)required

The name of the customization config setting

numeric_valuestring(Numeric Value)required

reference_servicestring(Reference Service)required

reference_valuestring(Reference Value)required

relative_date_valueobject(Relative Date Value)required

relative_date_value.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

The unit of time

relative_date_value.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

relative_date_value.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

relative_date_value.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

string_list_valueArray of strings(String List Value)non-emptyrequired

string_valuestring(String Value)required

subcategorystring(Subcategory)

A subcategory of the setting, if this is necessary

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

technical_detailsstring(Technical Details)required

A description of what microservices use this setting and how

typestring(Type)required

The type of field

Enum"boolean""date""email""html""json""multi select picklist""number""picklist""reference""relative date"

]

Response

application/json

[
  {
    "abbreviated_name": "string",
    "acceptable_values": [ … ],
    "boolean_value": true,
    "category": "string",
    "date_value": "string",
    "description": "string",
    "email_value": { … },
    "help_text": "string",
    "html_value": "string",
    "id": "string",
    "json_value": {},
    "merge_fields": [ … ],
    "name": "string",
    "numeric_value": "string",
    "reference_service": "string",
    "reference_value": "string",
    "relative_date_value": { … },
    "string_list_value": [ … ],
    "string_value": "string",
    "subcategory": "string",
    "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,
    "technical_details": "string",
    "type": "boolean"
  }
]

Creates a new customization config setting record that does not already exist.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The customization config setting that you would like to be saved.

abbreviated_namestring(Abbreviated Name)required

The short, abbreviated name of the setting

acceptable_valuesArray of objectsnon-emptyrequired

acceptable_values[].namestring(Name)required

acceptable_values[].valuestring(Value)required

boolean_valueboolean(Boolean Value)required

categorystring(Category)required

A category for the configuration setting

date_valuestring(Date Value)required

descriptionstring(Description)required

A description of this configuration setting

email_valueobject(Email Value)required

email_value.bccstring(Bcc)

Anyone that should be bcc'ed on the email

email_value.bodystring(Body)required

The email body

email_value.ccstring(Cc)

Anyone that should be cc'ed on the email

email_value.fromstring(From)

From email address

email_value.from_namestring(From Name)

From name

email_value.reply_tostring(Reply To)

The reply to

email_value.subjectstring(Subject)required

The email subject

help_textstring(Help Text)

Any applicable help text

html_valuestring(Html Value)required

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this customization config setting

json_valueobject(Json Value)required

merge_fieldsArray of objects

For emails, allows for designation of merge fields

namestring(Name)required

The name of the customization config setting

numeric_valuestring(Numeric Value)required

reference_servicestring(Reference Service)required

reference_valuestring(Reference Value)required

relative_date_valueobject(Relative Date Value)required

relative_date_value.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

The unit of time

relative_date_value.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

relative_date_value.relative_tostring(Relative To)required

relative_date_value.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

string_list_valueArray of strings(String List Value)non-emptyrequired

string_valuestring(String Value)required

subcategorystring(Subcategory)

A subcategory of the setting, if this is necessary

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

technical_detailsstring(Technical Details)required

A description of what microservices use this setting and how

typestring(Type)required

The type of field

Enum"boolean""date""email""html""json""multi select picklist""number""picklist""reference""relative date"

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customizationConfigSettings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "abbreviated_name": "string",
    "acceptable_values": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "boolean_value": true,
    "category": "string",
    "date_value": "string",
    "description": "string",
    "email_value": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "help_text": "string",
    "html_value": "string",
    "id": "string",
    "json_value": {},
    "merge_fields": [
      {
        "application": "accreditation",
        "group_id": "string",
        "group_name": "string",
        "nameOfObject": "string",
        "service": "string"
      }
    ],
    "name": "string",
    "numeric_value": "string",
    "reference_service": "string",
    "reference_value": "string",
    "relative_date_value": {
      "number": null,
      "position": "after",
      "relative_to": "the beginning of the month",
      "unit_of_time": "days"
    },
    "string_list_value": [
      "string"
    ],
    "string_value": "string",
    "subcategory": "string",
    "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,
    "technical_details": "string",
    "type": "boolean"
  }'

Responses

The customization config setting was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

abbreviated_namestring(Abbreviated Name)required

The short, abbreviated name of the setting

acceptable_valuesArray of objectsnon-emptyrequired

acceptable_values[].namestring(Name)required

acceptable_values[].valuestring(Value)required

boolean_valueboolean(Boolean Value)required

categorystring(Category)required

A category for the configuration setting

date_valuestring(Date Value)required

descriptionstring(Description)required

A description of this configuration setting

email_valueobject(Email Value)required

email_value.bccstring(Bcc)

Anyone that should be bcc'ed on the email

email_value.bodystring(Body)required

The email body

email_value.ccstring(Cc)

Anyone that should be cc'ed on the email

email_value.fromstring(From)

From email address

email_value.from_namestring(From Name)

From name

email_value.reply_tostring(Reply To)

The reply to

email_value.subjectstring(Subject)required

The email subject

help_textstring(Help Text)

Any applicable help text

html_valuestring(Html Value)required

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this customization config setting

json_valueobject(Json Value)required

merge_fieldsArray of objects

For emails, allows for designation of merge fields

namestring(Name)required

The name of the customization config setting

numeric_valuestring(Numeric Value)required

reference_servicestring(Reference Service)required

reference_valuestring(Reference Value)required

relative_date_valueobject(Relative Date Value)required

relative_date_value.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

The unit of time

relative_date_value.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

relative_date_value.relative_tostring(Relative To)required

relative_date_value.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

string_list_valueArray of strings(String List Value)non-emptyrequired

string_valuestring(String Value)required

subcategorystring(Subcategory)

A subcategory of the setting, if this is necessary

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

technical_detailsstring(Technical Details)required

A description of what microservices use this setting and how

typestring(Type)required

The type of field

Enum"boolean""date""email""html""json""multi select picklist""number""picklist""reference""relative date"

Response

application/json

{
  "abbreviated_name": "string",
  "acceptable_values": [
    { … }
  ],
  "boolean_value": true,
  "category": "string",
  "date_value": "string",
  "description": "string",
  "email_value": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "help_text": "string",
  "html_value": "string",
  "id": "string",
  "json_value": {},
  "merge_fields": [
    { … }
  ],
  "name": "string",
  "numeric_value": "string",
  "reference_service": "string",
  "reference_value": "string",
  "relative_date_value": {
    "number": null,
    "position": "after",
    "relative_to": "the beginning of the month",
    "unit_of_time": "days"
  },
  "string_list_value": [
    "string"
  ],
  "string_value": "string",
  "subcategory": "string",
  "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,
  "technical_details": "string",
  "type": "boolean"
}

Execute Batch Operations

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customizationConfigSettings/{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"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a customization config setting from the system by its ID.

Request

This method will delete a customization config setting with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the customization config setting to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customizationConfigSettings/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The customization config setting was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a customization config setting from the system by its ID.

Request

This method will look up a customization config setting by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the customization config setting to return.

Query

fieldsstring

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

consistentReadstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customizationConfigSettings/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The customization config setting was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

abbreviated_namestring(Abbreviated Name)required

The short, abbreviated name of the setting

acceptable_valuesArray of objectsnon-emptyrequired

acceptable_values[].namestring(Name)required

acceptable_values[].valuestring(Value)required

boolean_valueboolean(Boolean Value)required

categorystring(Category)required

A category for the configuration setting

date_valuestring(Date Value)required

descriptionstring(Description)required

A description of this configuration setting

email_valueobject(Email Value)required

email_value.bccstring(Bcc)

Anyone that should be bcc'ed on the email

email_value.bodystring(Body)required

The email body

email_value.ccstring(Cc)

Anyone that should be cc'ed on the email

email_value.fromstring(From)

From email address

email_value.from_namestring(From Name)

From name

email_value.reply_tostring(Reply To)

The reply to

email_value.subjectstring(Subject)required

The email subject

help_textstring(Help Text)

Any applicable help text

html_valuestring(Html Value)required

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this customization config setting

json_valueobject(Json Value)required

merge_fieldsArray of objects

For emails, allows for designation of merge fields

namestring(Name)required

The name of the customization config setting

numeric_valuestring(Numeric Value)required

reference_servicestring(Reference Service)required

reference_valuestring(Reference Value)required

relative_date_valueobject(Relative Date Value)required

relative_date_value.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

The unit of time

relative_date_value.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

relative_date_value.relative_tostring(Relative To)required

relative_date_value.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

string_list_valueArray of strings(String List Value)non-emptyrequired

string_valuestring(String Value)required

subcategorystring(Subcategory)

A subcategory of the setting, if this is necessary

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

technical_detailsstring(Technical Details)required

A description of what microservices use this setting and how

typestring(Type)required

The type of field

Enum"boolean""date""email""html""json""multi select picklist""number""picklist""reference""relative date"

Response

application/json

{
  "abbreviated_name": "string",
  "acceptable_values": [
    { … }
  ],
  "boolean_value": true,
  "category": "string",
  "date_value": "string",
  "description": "string",
  "email_value": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "help_text": "string",
  "html_value": "string",
  "id": "string",
  "json_value": {},
  "merge_fields": [
    { … }
  ],
  "name": "string",
  "numeric_value": "string",
  "reference_service": "string",
  "reference_value": "string",
  "relative_date_value": {
    "number": null,
    "position": "after",
    "relative_to": "the beginning of the month",
    "unit_of_time": "days"
  },
  "string_list_value": [
    "string"
  ],
  "string_value": "string",
  "subcategory": "string",
  "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,
  "technical_details": "string",
  "type": "boolean"
}

Partially updates a customization config setting with the specified ID.

Request

This method will patch an existing customization config setting with the specified ID, using the HTTP PATCH specification.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the customization config setting to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customizationConfigSettings/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The customization config setting was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

abbreviated_namestring(Abbreviated Name)required

The short, abbreviated name of the setting

acceptable_valuesArray of objectsnon-emptyrequired

acceptable_values[].namestring(Name)required

acceptable_values[].valuestring(Value)required

boolean_valueboolean(Boolean Value)required

categorystring(Category)required

A category for the configuration setting

date_valuestring(Date Value)required

descriptionstring(Description)required

A description of this configuration setting

email_valueobject(Email Value)required

email_value.bccstring(Bcc)

Anyone that should be bcc'ed on the email

email_value.bodystring(Body)required

The email body

email_value.ccstring(Cc)

Anyone that should be cc'ed on the email

email_value.fromstring(From)

From email address

email_value.from_namestring(From Name)

From name

email_value.reply_tostring(Reply To)

The reply to

email_value.subjectstring(Subject)required

The email subject

help_textstring(Help Text)

Any applicable help text

html_valuestring(Html Value)required

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this customization config setting

json_valueobject(Json Value)required

merge_fieldsArray of objects

For emails, allows for designation of merge fields

namestring(Name)required

The name of the customization config setting

numeric_valuestring(Numeric Value)required

reference_servicestring(Reference Service)required

reference_valuestring(Reference Value)required

relative_date_valueobject(Relative Date Value)required

relative_date_value.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

The unit of time

relative_date_value.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

relative_date_value.relative_tostring(Relative To)required

relative_date_value.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

string_list_valueArray of strings(String List Value)non-emptyrequired

string_valuestring(String Value)required

subcategorystring(Subcategory)

A subcategory of the setting, if this is necessary

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

technical_detailsstring(Technical Details)required

A description of what microservices use this setting and how

typestring(Type)required

The type of field

Enum"boolean""date""email""html""json""multi select picklist""number""picklist""reference""relative date"

Response

application/json

{
  "abbreviated_name": "string",
  "acceptable_values": [
    { … }
  ],
  "boolean_value": true,
  "category": "string",
  "date_value": "string",
  "description": "string",
  "email_value": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "help_text": "string",
  "html_value": "string",
  "id": "string",
  "json_value": {},
  "merge_fields": [
    { … }
  ],
  "name": "string",
  "numeric_value": "string",
  "reference_service": "string",
  "reference_value": "string",
  "relative_date_value": {
    "number": null,
    "position": "after",
    "relative_to": "the beginning of the month",
    "unit_of_time": "days"
  },
  "string_list_value": [
    "string"
  ],
  "string_value": "string",
  "subcategory": "string",
  "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,
  "technical_details": "string",
  "type": "boolean"
}

Updates a customization config setting with the specified ID.

Request

This method will update an existing customization config setting with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the customization config setting to update.

Bodyapplication/jsonrequired

The updated customization config setting that will be saved.

abbreviated_namestring(Abbreviated Name)required

The short, abbreviated name of the setting

acceptable_valuesArray of objectsnon-emptyrequired

acceptable_values[].namestring(Name)required

acceptable_values[].valuestring(Value)required

boolean_valueboolean(Boolean Value)required

categorystring(Category)required

A category for the configuration setting

date_valuestring(Date Value)required

descriptionstring(Description)required

A description of this configuration setting

email_valueobject(Email Value)required

email_value.bccstring(Bcc)

Anyone that should be bcc'ed on the email

email_value.bodystring(Body)required

The email body

email_value.ccstring(Cc)

Anyone that should be cc'ed on the email

email_value.fromstring(From)

From email address

email_value.from_namestring(From Name)

From name

email_value.reply_tostring(Reply To)

The reply to

email_value.subjectstring(Subject)required

The email subject

help_textstring(Help Text)

Any applicable help text

html_valuestring(Html Value)required

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this customization config setting

json_valueobject(Json Value)required

merge_fieldsArray of objects

For emails, allows for designation of merge fields

namestring(Name)required

The name of the customization config setting

numeric_valuestring(Numeric Value)required

reference_servicestring(Reference Service)required

reference_valuestring(Reference Value)required

relative_date_valueobject(Relative Date Value)required

relative_date_value.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

The unit of time

relative_date_value.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

relative_date_value.relative_tostring(Relative To)required

relative_date_value.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

string_list_valueArray of strings(String List Value)non-emptyrequired

string_valuestring(String Value)required

subcategorystring(Subcategory)

A subcategory of the setting, if this is necessary

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

technical_detailsstring(Technical Details)required

A description of what microservices use this setting and how

typestring(Type)required

The type of field

Enum"boolean""date""email""html""json""multi select picklist""number""picklist""reference""relative date"

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customizationConfigSettings/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "abbreviated_name": "string",
    "acceptable_values": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "boolean_value": true,
    "category": "string",
    "date_value": "string",
    "description": "string",
    "email_value": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "help_text": "string",
    "html_value": "string",
    "id": "string",
    "json_value": {},
    "merge_fields": [
      {
        "application": "accreditation",
        "group_id": "string",
        "group_name": "string",
        "nameOfObject": "string",
        "service": "string"
      }
    ],
    "name": "string",
    "numeric_value": "string",
    "reference_service": "string",
    "reference_value": "string",
    "relative_date_value": {
      "number": null,
      "position": "after",
      "relative_to": "the beginning of the month",
      "unit_of_time": "days"
    },
    "string_list_value": [
      "string"
    ],
    "string_value": "string",
    "subcategory": "string",
    "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,
    "technical_details": "string",
    "type": "boolean"
  }'

Responses

The customization config setting was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

abbreviated_namestring(Abbreviated Name)required

The short, abbreviated name of the setting

acceptable_valuesArray of objectsnon-emptyrequired

acceptable_values[].namestring(Name)required

acceptable_values[].valuestring(Value)required

boolean_valueboolean(Boolean Value)required

categorystring(Category)required

A category for the configuration setting

date_valuestring(Date Value)required

descriptionstring(Description)required

A description of this configuration setting

email_valueobject(Email Value)required

email_value.bccstring(Bcc)

Anyone that should be bcc'ed on the email

email_value.bodystring(Body)required

The email body

email_value.ccstring(Cc)

Anyone that should be cc'ed on the email

email_value.fromstring(From)

From email address

email_value.from_namestring(From Name)

From name

email_value.reply_tostring(Reply To)

The reply to

email_value.subjectstring(Subject)required

The email subject

help_textstring(Help Text)

Any applicable help text

html_valuestring(Html Value)required

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this customization config setting

json_valueobject(Json Value)required

merge_fieldsArray of objects

For emails, allows for designation of merge fields

namestring(Name)required

The name of the customization config setting

numeric_valuestring(Numeric Value)required

reference_servicestring(Reference Service)required

reference_valuestring(Reference Value)required

relative_date_valueobject(Relative Date Value)required

relative_date_value.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

The unit of time

relative_date_value.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

relative_date_value.relative_tostring(Relative To)required

relative_date_value.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

string_list_valueArray of strings(String List Value)non-emptyrequired

string_valuestring(String Value)required

subcategorystring(Subcategory)

A subcategory of the setting, if this is necessary

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

technical_detailsstring(Technical Details)required

A description of what microservices use this setting and how

typestring(Type)required

The type of field

Enum"boolean""date""email""html""json""multi select picklist""number""picklist""reference""relative date"

Response

application/json

{
  "abbreviated_name": "string",
  "acceptable_values": [
    { … }
  ],
  "boolean_value": true,
  "category": "string",
  "date_value": "string",
  "description": "string",
  "email_value": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "help_text": "string",
  "html_value": "string",
  "id": "string",
  "json_value": {},
  "merge_fields": [
    { … }
  ],
  "name": "string",
  "numeric_value": "string",
  "reference_service": "string",
  "reference_value": "string",
  "relative_date_value": {
    "number": null,
    "position": "after",
    "relative_to": "the beginning of the month",
    "unit_of_time": "days"
  },
  "string_list_value": [
    "string"
  ],
  "string_value": "string",
  "subcategory": "string",
  "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,
  "technical_details": "string",
  "type": "boolean"
}

Directory Entry Comments

Operations

Email Activities

Operations

Email Integrations

Operations

File Uploads

Operations

Page Layouts

Operations

Query Delivery Schedules

Operations

Query User Profiles

Operations

Record Alert Rule Sets

Operations

Record Alerts

Operations

Saved Queries

Operations

Saved Reports

Operations

Saved Searches

Operations

Service Configurations

Operations

Service Metadata

Operations

Task Assignment Roles

Operations

Task Queues

Operations

Task Types

Operations

Tasks

Operations

Web Form Drafts

Operations

Web Forms

Operations

Workflows

Operations

Platform (v1-2025-04-18)

360 Screens

Custom Fields

Custom Objects

Custom Query Definitions

Custom Record Actions

Customization Config Settings

Gets all of the customization config settings in the system.

Request

Responses

Was this helpful?

Creates a new customization config setting record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a customization config setting from the system by its ID.

Request

Responses

Was this helpful?

Returns a customization config setting from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a customization config setting with the specified ID.

Request

Responses

Was this helpful?

Updates a customization config setting with the specified ID.

RequestExpand all

Responses

Was this helpful?

Directory Entry Comments

Email Activities

Email Integrations

File Uploads

Page Layouts

Query Delivery Schedules

Query User Profiles

Record Alert Rule Sets

Record Alerts

Saved Queries

Saved Reports

Saved Searches

Service Configurations

Service Metadata

Task Assignment Roles

Task Queues

Task Types

Tasks

Web Form Drafts

Web Forms

Workflows

Request

Request

Request