Abstract Settings

Abstract Settings

Creates a new abstract setting record that does not already exist.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The abstract setting that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this abstract settings

enable_online_abstract_submission
boolean (Enable Online Abstract Submission)

Whether or not abstract submission is enabled

required
object (Abstract Submission Options)
abstract_instructions
string (Abstract Instructions)

Show instructions to those submitting abstracts

presenter_instructions
string (Presenter Instructions)

Show instructions to those presenters

allow_speakers_to_modify_their_profiles
boolean (Allow Speakers To Modify Their Profiles)

If true, speakers can modify their profile information

allow_presenters_to_modify_their_sessions
boolean (Allow Presenters To Modify Their Sessions)

If true, presenters are able to modify their session

required
object (Speaker Profile Modification Options)
required
object (Session Modification Options)
allow_presenters_to_manage_documents
boolean (Allow Presenters To Manage Documents)

If true, presents can manage documents

required
object (Document Management Options)
enable_hide_status
boolean (Enable Hide Status)

Whether or not to hide abstract status in portal

show_status_date
required
string <date-time> (Show Status Date)

The date to show abstract status in the portal

notes
string (Notes)
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 abstract setting was saved successfully.
400The abstract setting you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The abstract setting could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add abstract setting based on tenant limits.
500General server error.
post/abstractSettings/{tenantId}
Request samples
application/json
{
  • "id": "string",
  • "enable_online_abstract_submission": true,
  • "abstract_submission_options": {
    },
  • "abstract_instructions": "string",
  • "presenter_instructions": "string",
  • "allow_speakers_to_modify_their_profiles": true,
  • "allow_presenters_to_modify_their_sessions": true,
  • "speaker_profile_modification_options": {
    },
  • "session_modification_options": {
    },
  • "allow_presenters_to_manage_documents": true,
  • "document_management_options": {
    },
  • "enable_hide_status": true,
  • "show_status_date": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "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",
  • "enable_online_abstract_submission": true,
  • "abstract_submission_options": {
    },
  • "abstract_instructions": "string",
  • "presenter_instructions": "string",
  • "allow_speakers_to_modify_their_profiles": true,
  • "allow_presenters_to_modify_their_sessions": true,
  • "speaker_profile_modification_options": {
    },
  • "session_modification_options": {
    },
  • "allow_presenters_to_manage_documents": true,
  • "document_management_options": {
    },
  • "enable_hide_status": true,
  • "show_status_date": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "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 abstract settings in the system.

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

Request
Security:
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 abstract settingswere 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/abstractSettings/{tenantId}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/abstractSettings/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a abstract setting from the system by its ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the abstract setting 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 abstract setting was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The abstract setting could not be found.
429Limit exceeded... unable to retrieve abstract setting based on tenant limits.
500General server error.
get/abstractSettings/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/abstractSettings/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "enable_online_abstract_submission": true,
  • "abstract_submission_options": {
    },
  • "abstract_instructions": "string",
  • "presenter_instructions": "string",
  • "allow_speakers_to_modify_their_profiles": true,
  • "allow_presenters_to_modify_their_sessions": true,
  • "speaker_profile_modification_options": {
    },
  • "session_modification_options": {
    },
  • "allow_presenters_to_manage_documents": true,
  • "document_management_options": {
    },
  • "enable_hide_status": true,
  • "show_status_date": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "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 abstract setting with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the abstract setting to update.

Request Body schema: application/json

The updated abstract setting that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this abstract settings

enable_online_abstract_submission
boolean (Enable Online Abstract Submission)

Whether or not abstract submission is enabled

required
object (Abstract Submission Options)
abstract_instructions
string (Abstract Instructions)

Show instructions to those submitting abstracts

presenter_instructions
string (Presenter Instructions)

Show instructions to those presenters

allow_speakers_to_modify_their_profiles
boolean (Allow Speakers To Modify Their Profiles)

If true, speakers can modify their profile information

allow_presenters_to_modify_their_sessions
boolean (Allow Presenters To Modify Their Sessions)

If true, presenters are able to modify their session

required
object (Speaker Profile Modification Options)
required
object (Session Modification Options)
allow_presenters_to_manage_documents
boolean (Allow Presenters To Manage Documents)

If true, presents can manage documents

required
object (Document Management Options)
enable_hide_status
boolean (Enable Hide Status)

Whether or not to hide abstract status in portal

show_status_date
required
string <date-time> (Show Status Date)

The date to show abstract status in the portal

notes
string (Notes)
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 abstract setting was updated successfully.
400The abstract setting supplied was not valid.
401Unauthorized.
403Forbidden.
404The abstract setting could not be found.
409The abstract setting could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve abstract setting based on tenant limits.
500General server error.
put/abstractSettings/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "enable_online_abstract_submission": true,
  • "abstract_submission_options": {
    },
  • "abstract_instructions": "string",
  • "presenter_instructions": "string",
  • "allow_speakers_to_modify_their_profiles": true,
  • "allow_presenters_to_modify_their_sessions": true,
  • "speaker_profile_modification_options": {
    },
  • "session_modification_options": {
    },
  • "allow_presenters_to_manage_documents": true,
  • "document_management_options": {
    },
  • "enable_hide_status": true,
  • "show_status_date": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "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",
  • "enable_online_abstract_submission": true,
  • "abstract_submission_options": {
    },
  • "abstract_instructions": "string",
  • "presenter_instructions": "string",
  • "allow_speakers_to_modify_their_profiles": true,
  • "allow_presenters_to_modify_their_sessions": true,
  • "speaker_profile_modification_options": {
    },
  • "session_modification_options": {
    },
  • "allow_presenters_to_manage_documents": true,
  • "document_management_options": {
    },
  • "enable_hide_status": true,
  • "show_status_date": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "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 abstract setting with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the abstract setting 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 abstract setting was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The abstract setting could not be found.
409The abstract setting could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve abstract setting based on tenant limits.
500General server error.
patch/abstractSettings/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "enable_online_abstract_submission": true,
  • "abstract_submission_options": {
    },
  • "abstract_instructions": "string",
  • "presenter_instructions": "string",
  • "allow_speakers_to_modify_their_profiles": true,
  • "allow_presenters_to_modify_their_sessions": true,
  • "speaker_profile_modification_options": {
    },
  • "session_modification_options": {
    },
  • "allow_presenters_to_manage_documents": true,
  • "document_management_options": {
    },
  • "enable_hide_status": true,
  • "show_status_date": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "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 abstract setting from the system by its ID.

This method will delete a abstract setting with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the abstract setting to delete.

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

Execute Batch Operations

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

Request
Security:
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 abstract setting could not be found.
429Limit exceeded... unable to retrieve abstract setting based on tenant limits.
500General server error.
post/abstractSettings/{tenantId}/batch
Request samples
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}