Abstracts

Abstracts

Creates a new abstract record that does not already exist.

This method will auto-generate an ID and create a new abstract. If an ID is specified for the abstract, 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 abstract that you would like to be saved.

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

The unique, string identifier of this abstract

event_id
required
string (Event)

The ID of the event

main_presenter_id
string (Main Presenter)

Id of the presenter of the abstract

process_id
string (Process)

The process associated with this abstract

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

review_status
string (Review Status)

The review status of this application

Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change
string <date-time> (Last Review Status Change)

The date that the review status was last changed

pending_console_review
boolean (Pending Console Review)

If true, then this record has been reviewed and now needs action by the staff

submission_space_id
string (Submission Space)

The submission space to which this object belongs

override_bucket_assignment
boolean (Override Bucket Assignment)

If set, the bucket is not calculated automatically, and instead manually assigned

round_id
string (Round)

The review round

bucket_id
required
string (Bucket)

The review bucket

average_score
number <float> (Average Score)

The average score for this submission in the most recent round

total_score
number <float> (Total Score)

The total score for this submission in the most recent round

reviewer_recommendation
string (Reviewer Recommendation)

Aggregate recommendation across all reviewers

organization_id
string (Organization)

The organization of the submitter

submitter_id
required
string (Submitter)

Id of the contact that submitted the abstract

has_co_authors
boolean (Has Co Authors)

This abstract has co-authors

required
Array of objects non-empty
status
required
string (Status)
Enum: "draft" "submitted" "under review" "more information needed" "withdrawn" "declined" "accepted" "alternate" "confirmed" "approved/pending presenter acceptance" "approved/accepted by presenter" "approved/declined by presenter"
session_has_been_generated
boolean (Session Has Been Generated)

Boolean flag indicating whether or not a session has been been generated for this abstract

title
required
string (Title)

The title of the abstract

body
required
string (Body)

The body of the abstract

type_id
required
string (Type)

The id for the type of abstract

Array of objects (Custom Field Values)
date
string <date-time> (Date)

The date of abstract submission

session_track_ids
Array of strings (Session Tracks)

Session tracks associations for the abstract

number
number <float> (Number)

The abstract number

max_contact_submissions
number <float> (Max Contact Submissions)

The max number of abstracts per contact for an event

submitting_on_behalf_of_presenter
boolean (Submitting On Behalf Of Presenter)

Bool that identifies if the submitter is different than the presenter

required
object (Presenter Info)
review_process_id
string (Review Process)

Review process for which this abstract is assigned

reviews_assigned
boolean (Reviews Assigned)

Have reviews been assigned for this abstract

review_round_id
required
string (Review Round)

Current review round for this abstract

notes
string (Notes)
approval_process_id
string (Approval Process)

The approval process for this abstract

Array of objects
object (Co Author 1)
object (Co Author 2)
object (Co Author 3)
object (Co Author 4)
object (Co Author 5)
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 was saved successfully.
400The abstract you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The abstract could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add abstract based on tenant limits.
500General server error.
post/abstracts/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "event_id": "string",
  • "main_presenter_id": "string",
  • "process_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "organization_id": "string",
  • "submitter_id": "string",
  • "has_co_authors": true,
  • "co_authors": [
    ],
  • "status": "draft",
  • "session_has_been_generated": true,
  • "title": "string",
  • "body": "string",
  • "type_id": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "session_track_ids": [
    ],
  • "number": 0,
  • "max_contact_submissions": 0,
  • "submitting_on_behalf_of_presenter": true,
  • "presenter_info": {
    },
  • "review_process_id": "string",
  • "reviews_assigned": true,
  • "review_round_id": "string",
  • "notes": "string",
  • "approval_process_id": "string",
  • "round_scores": [
    ],
  • "co_author_1": {
    },
  • "co_author_2": {
    },
  • "co_author_3": {
    },
  • "co_author_4": {
    },
  • "co_author_5": {
    },
  • "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",
  • "event_id": "string",
  • "main_presenter_id": "string",
  • "process_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "organization_id": "string",
  • "submitter_id": "string",
  • "has_co_authors": true,
  • "co_authors": [
    ],
  • "status": "draft",
  • "session_has_been_generated": true,
  • "title": "string",
  • "body": "string",
  • "type_id": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "session_track_ids": [
    ],
  • "number": 0,
  • "max_contact_submissions": 0,
  • "submitting_on_behalf_of_presenter": true,
  • "presenter_info": {
    },
  • "review_process_id": "string",
  • "reviews_assigned": true,
  • "review_round_id": "string",
  • "notes": "string",
  • "approval_process_id": "string",
  • "round_scores": [
    ],
  • "co_author_1": {
    },
  • "co_author_2": {
    },
  • "co_author_3": {
    },
  • "co_author_4": {
    },
  • "co_author_5": {
    },
  • "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 from the system by its ID.

This method will look up a abstract 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 abstract 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 was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The abstract could not be found.
429Limit exceeded... unable to retrieve abstract based on tenant limits.
500General server error.
get/abstracts/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "event_id": "string",
  • "main_presenter_id": "string",
  • "process_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "organization_id": "string",
  • "submitter_id": "string",
  • "has_co_authors": true,
  • "co_authors": [
    ],
  • "status": "draft",
  • "session_has_been_generated": true,
  • "title": "string",
  • "body": "string",
  • "type_id": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "session_track_ids": [
    ],
  • "number": 0,
  • "max_contact_submissions": 0,
  • "submitting_on_behalf_of_presenter": true,
  • "presenter_info": {
    },
  • "review_process_id": "string",
  • "reviews_assigned": true,
  • "review_round_id": "string",
  • "notes": "string",
  • "approval_process_id": "string",
  • "round_scores": [
    ],
  • "co_author_1": {
    },
  • "co_author_2": {
    },
  • "co_author_3": {
    },
  • "co_author_4": {
    },
  • "co_author_5": {
    },
  • "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 with the specified ID.

This method will update an existing abstract 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 abstract to update.

Request Body schema: application/json

The updated abstract that will be saved.

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

The unique, string identifier of this abstract

event_id
required
string (Event)

The ID of the event

main_presenter_id
string (Main Presenter)

Id of the presenter of the abstract

process_id
string (Process)

The process associated with this abstract

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

review_status
string (Review Status)

The review status of this application

Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change
string <date-time> (Last Review Status Change)

The date that the review status was last changed

pending_console_review
boolean (Pending Console Review)

If true, then this record has been reviewed and now needs action by the staff

submission_space_id
string (Submission Space)

The submission space to which this object belongs

override_bucket_assignment
boolean (Override Bucket Assignment)

If set, the bucket is not calculated automatically, and instead manually assigned

round_id
string (Round)

The review round

bucket_id
required
string (Bucket)

The review bucket

average_score
number <float> (Average Score)

The average score for this submission in the most recent round

total_score
number <float> (Total Score)

The total score for this submission in the most recent round

reviewer_recommendation
string (Reviewer Recommendation)

Aggregate recommendation across all reviewers

organization_id
string (Organization)

The organization of the submitter

submitter_id
required
string (Submitter)

Id of the contact that submitted the abstract

has_co_authors
boolean (Has Co Authors)

This abstract has co-authors

required
Array of objects non-empty
status
required
string (Status)
Enum: "draft" "submitted" "under review" "more information needed" "withdrawn" "declined" "accepted" "alternate" "confirmed" "approved/pending presenter acceptance" "approved/accepted by presenter" "approved/declined by presenter"
session_has_been_generated
boolean (Session Has Been Generated)

Boolean flag indicating whether or not a session has been been generated for this abstract

title
required
string (Title)

The title of the abstract

body
required
string (Body)

The body of the abstract

type_id
required
string (Type)

The id for the type of abstract

Array of objects (Custom Field Values)
date
string <date-time> (Date)

The date of abstract submission

session_track_ids
Array of strings (Session Tracks)

Session tracks associations for the abstract

number
number <float> (Number)

The abstract number

max_contact_submissions
number <float> (Max Contact Submissions)

The max number of abstracts per contact for an event

submitting_on_behalf_of_presenter
boolean (Submitting On Behalf Of Presenter)

Bool that identifies if the submitter is different than the presenter

required
object (Presenter Info)
review_process_id
string (Review Process)

Review process for which this abstract is assigned

reviews_assigned
boolean (Reviews Assigned)

Have reviews been assigned for this abstract

review_round_id
required
string (Review Round)

Current review round for this abstract

notes
string (Notes)
approval_process_id
string (Approval Process)

The approval process for this abstract

Array of objects
object (Co Author 1)
object (Co Author 2)
object (Co Author 3)
object (Co Author 4)
object (Co Author 5)
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 was updated successfully.
400The abstract supplied was not valid.
401Unauthorized.
403Forbidden.
404The abstract could not be found.
409The abstract could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve abstract based on tenant limits.
500General server error.
put/abstracts/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "event_id": "string",
  • "main_presenter_id": "string",
  • "process_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "organization_id": "string",
  • "submitter_id": "string",
  • "has_co_authors": true,
  • "co_authors": [
    ],
  • "status": "draft",
  • "session_has_been_generated": true,
  • "title": "string",
  • "body": "string",
  • "type_id": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "session_track_ids": [
    ],
  • "number": 0,
  • "max_contact_submissions": 0,
  • "submitting_on_behalf_of_presenter": true,
  • "presenter_info": {
    },
  • "review_process_id": "string",
  • "reviews_assigned": true,
  • "review_round_id": "string",
  • "notes": "string",
  • "approval_process_id": "string",
  • "round_scores": [
    ],
  • "co_author_1": {
    },
  • "co_author_2": {
    },
  • "co_author_3": {
    },
  • "co_author_4": {
    },
  • "co_author_5": {
    },
  • "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",
  • "event_id": "string",
  • "main_presenter_id": "string",
  • "process_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "organization_id": "string",
  • "submitter_id": "string",
  • "has_co_authors": true,
  • "co_authors": [
    ],
  • "status": "draft",
  • "session_has_been_generated": true,
  • "title": "string",
  • "body": "string",
  • "type_id": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "session_track_ids": [
    ],
  • "number": 0,
  • "max_contact_submissions": 0,
  • "submitting_on_behalf_of_presenter": true,
  • "presenter_info": {
    },
  • "review_process_id": "string",
  • "reviews_assigned": true,
  • "review_round_id": "string",
  • "notes": "string",
  • "approval_process_id": "string",
  • "round_scores": [
    ],
  • "co_author_1": {
    },
  • "co_author_2": {
    },
  • "co_author_3": {
    },
  • "co_author_4": {
    },
  • "co_author_5": {
    },
  • "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 with the specified ID.

This method will patch an existing abstract 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 abstract 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 was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The abstract could not be found.
409The abstract could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve abstract based on tenant limits.
500General server error.
patch/abstracts/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "event_id": "string",
  • "main_presenter_id": "string",
  • "process_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "organization_id": "string",
  • "submitter_id": "string",
  • "has_co_authors": true,
  • "co_authors": [
    ],
  • "status": "draft",
  • "session_has_been_generated": true,
  • "title": "string",
  • "body": "string",
  • "type_id": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "session_track_ids": [
    ],
  • "number": 0,
  • "max_contact_submissions": 0,
  • "submitting_on_behalf_of_presenter": true,
  • "presenter_info": {
    },
  • "review_process_id": "string",
  • "reviews_assigned": true,
  • "review_round_id": "string",
  • "notes": "string",
  • "approval_process_id": "string",
  • "round_scores": [
    ],
  • "co_author_1": {
    },
  • "co_author_2": {
    },
  • "co_author_3": {
    },
  • "co_author_4": {
    },
  • "co_author_5": {
    },
  • "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 from the system by its ID.

This method will delete a abstract 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 abstract to delete.

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

Returns a list of records with the specified submitter_id

Returns a list of records with the specified submitter_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

submitter_id
required
string

The submitter_id 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/abstracts/{tenantId}/submitter/{submitter_id}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/submitter/:submitter_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified event_contact_id

Returns a list of records with the specified event_contact_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

eventId
required
string

The event

contactId
required
string

The contact

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/abstracts/{tenantId}/eventContact/{eventId}/{contactId}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/eventContact/:eventId/:contactId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified event_presenter_id

Returns a list of records with the specified event_presenter_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

eventId
required
string

The event

contactId
required
string

The contact

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/abstracts/{tenantId}/eventPresenter/{eventId}/{contactId}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/eventPresenter/:eventId/:contactId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Submit an abstract

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

Object definition of abstract

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

The unique, string identifier of this abstract

event_id
required
string (Event)

The ID of the event

main_presenter_id
string (Main Presenter)

Id of the presenter of the abstract

process_id
string (Process)

The process associated with this abstract

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

review_status
string (Review Status)

The review status of this application

Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change
string <date-time> (Last Review Status Change)

The date that the review status was last changed

pending_console_review
boolean (Pending Console Review)

If true, then this record has been reviewed and now needs action by the staff

submission_space_id
string (Submission Space)

The submission space to which this object belongs

override_bucket_assignment
boolean (Override Bucket Assignment)

If set, the bucket is not calculated automatically, and instead manually assigned

round_id
string (Round)

The review round

bucket_id
required
string (Bucket)

The review bucket

average_score
number <float> (Average Score)

The average score for this submission in the most recent round

total_score
number <float> (Total Score)

The total score for this submission in the most recent round

reviewer_recommendation
string (Reviewer Recommendation)

Aggregate recommendation across all reviewers

organization_id
string (Organization)

The organization of the submitter

submitter_id
required
string (Submitter)

Id of the contact that submitted the abstract

has_co_authors
boolean (Has Co Authors)

This abstract has co-authors

required
Array of objects non-empty
status
required
string (Status)
Enum: "draft" "submitted" "under review" "more information needed" "withdrawn" "declined" "accepted" "alternate" "confirmed" "approved/pending presenter acceptance" "approved/accepted by presenter" "approved/declined by presenter"
session_has_been_generated
boolean (Session Has Been Generated)

Boolean flag indicating whether or not a session has been been generated for this abstract

title
required
string (Title)

The title of the abstract

body
required
string (Body)

The body of the abstract

type_id
required
string (Type)

The id for the type of abstract

Array of objects (Custom Field Values)
date
string <date-time> (Date)

The date of abstract submission

session_track_ids
Array of strings (Session Tracks)

Session tracks associations for the abstract

number
number <float> (Number)

The abstract number

max_contact_submissions
number <float> (Max Contact Submissions)

The max number of abstracts per contact for an event

submitting_on_behalf_of_presenter
boolean (Submitting On Behalf Of Presenter)

Bool that identifies if the submitter is different than the presenter

required
object (Presenter Info)
review_process_id
string (Review Process)

Review process for which this abstract is assigned

reviews_assigned
boolean (Reviews Assigned)

Have reviews been assigned for this abstract

review_round_id
required
string (Review Round)

Current review round for this abstract

notes
string (Notes)
approval_process_id
string (Approval Process)

The approval process for this abstract

Array of objects
object (Co Author 1)
object (Co Author 2)
object (Co Author 3)
object (Co Author 4)
object (Co Author 5)
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 record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/abstracts/{tenantId}/submit
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "event_id": "string",
  • "main_presenter_id": "string",
  • "process_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "organization_id": "string",
  • "submitter_id": "string",
  • "has_co_authors": true,
  • "co_authors": [
    ],
  • "status": "draft",
  • "session_has_been_generated": true,
  • "title": "string",
  • "body": "string",
  • "type_id": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "session_track_ids": [
    ],
  • "number": 0,
  • "max_contact_submissions": 0,
  • "submitting_on_behalf_of_presenter": true,
  • "presenter_info": {
    },
  • "review_process_id": "string",
  • "reviews_assigned": true,
  • "review_round_id": "string",
  • "notes": "string",
  • "approval_process_id": "string",
  • "round_scores": [
    ],
  • "co_author_1": {
    },
  • "co_author_2": {
    },
  • "co_author_3": {
    },
  • "co_author_4": {
    },
  • "co_author_5": {
    },
  • "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": [
    ]
}

Process a Status Change Request

Updates the status and sends out the appropriate email

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

id
required
string

The ID of the abstract

Request Body schema: application/json

Object definition of abstract

new_status
required
string (New Status)
Enum: "draft" "submitted" "under review" "more information needed" "withdrawn" "declined" "accepted" "alternate" "confirmed" "approved/pending presenter acceptance" "approved/accepted by presenter" "approved/declined by presenter"
suppress_email_notifications
boolean (Suppress Email Notifications)

If true, no email goes out

object (Abstract)

Updated abstract

Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
put/abstracts/{tenantId}/status/{id}
Request samples
    1 more
    Python
application/json
{
  • "new_status": "draft",
  • "suppress_email_notifications": true,
  • "abstract": {
    }
}
Response samples
application/json
{
  • "results": [
    ]
}

Resends the confirmation email for an abstract submission

Resends the confirmation email for an abstract submission

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

id
required
string

The abstract

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/abstracts/{tenantId}/resendConfirmationEmail/{id}
Request samples
curl -i -X GET \
  https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/resendConfirmationEmail/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Searches for abstracts using predefined parameters

Searches for abstracts using predefined parameters

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
exclusiveStartKey
string

The start key for the search, for paging support

fieldsToReturn
string

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

Request Body schema: application/json

The abstract that you would like to be saved.

id
string (ID)
event_id
required
string (Event)
first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

co_author_ids
string (Co Authors)
title
string (Title)
body
string (Body)
type_id
Array of strings (Type)
date
Array of strings <date-time> (Date) 2 items
status
string (Status)
Responses
200The abstract search was saved successfully.
400The abstract you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The abstract could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add abstract based on tenant limits.
500General server error.
post/abstracts/{tenantId}/search
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "event_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "co_author_ids": "string",
  • "title": "string",
  • "body": "string",
  • "type_id": [
    ],
  • "date": [
    ],
  • "status": "string"
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Sends out a preview of the CRC notification email

Sends out a preview of the CRC notification email

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

review_id
string (Review)
type
string (Type)
object (Email Template)
destination_email_address
required
string (Destination Email Address)
abstract_id
string (Abstract)
registration_id
required
string (Registration)
Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/abstracts/{tenantId}/previewEmail
Request samples
    1 more
    Python
application/json
{
  • "review_id": "string",
  • "type": "string",
  • "email_template": {
    },
  • "destination_email_address": "string",
  • "abstract_id": "string",
  • "registration_id": "string"
}

Returns a list of records with the specified co_author_id

Returns a list of records with the specified co_author_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

co_author_contact_id
required
string

The co_author_contact_id 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/abstracts/{tenantId}/coAuthor/{co_author_contact_id}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/coAuthor/:co_author_contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Get CoAuthor info for Abstracts

Get CoAuthor info for Abstracts

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

contactId
required
string

The coAuthor contact ID

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/abstracts/{tenantId}/getCoAuthorInfo/{contactId}
Request samples
curl -i -X GET \
  https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/getCoAuthorInfo/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "name": "string",
  • "email_address": "string"
}

Returns a list of records with the specified review_round_id

Returns a list of records with the specified review_round_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

id
required
string

The review round

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

Request Body schema: application/json

The options for filtering the result set

status
string
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
post/abstracts/{tenantId}/reviewRound/{id}
Request samples
    1 more
    Python
application/json
{
  • "status": "string"
}
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified review_process_id

Returns a list of records with the specified review_process_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

review_process_id
required
string

The review_process_id 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/abstracts/{tenantId}/reviewProcess/{review_process_id}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/reviewProcess/:review_process_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Bulk update abstract statuses

Allows for bulk update of abstract statuses

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

status
required
string

The status to set

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

Request Body schema: application/json

Array of abstract ids

Array
string
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
post/abstracts/{tenantId}/updateStatus/{status}
Request samples
    1 more
    Python
application/json
[
  • "string"
]

End user abstract confirmation form submission endpoint

Allows a portal user to submit an abstract confirmation-approval form with additional information

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

id
required
string

The id of the abstract

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

Request Body schema: application/json

Abstract approval form payload

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

The unique, string identifier of this abstract

event_id
required
string (Event)

The ID of the event

main_presenter_id
string (Main Presenter)

Id of the presenter of the abstract

process_id
string (Process)

The process associated with this abstract

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

review_status
string (Review Status)

The review status of this application

Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change
string <date-time> (Last Review Status Change)

The date that the review status was last changed

pending_console_review
boolean (Pending Console Review)

If true, then this record has been reviewed and now needs action by the staff

submission_space_id
string (Submission Space)

The submission space to which this object belongs

override_bucket_assignment
boolean (Override Bucket Assignment)

If set, the bucket is not calculated automatically, and instead manually assigned

round_id
string (Round)

The review round

bucket_id
required
string (Bucket)

The review bucket

average_score
number <float> (Average Score)

The average score for this submission in the most recent round

total_score
number <float> (Total Score)

The total score for this submission in the most recent round

reviewer_recommendation
string (Reviewer Recommendation)

Aggregate recommendation across all reviewers

organization_id
string (Organization)

The organization of the submitter

submitter_id
required
string (Submitter)

Id of the contact that submitted the abstract

has_co_authors
boolean (Has Co Authors)

This abstract has co-authors

required
Array of objects non-empty
status
required
string (Status)
Enum: "draft" "submitted" "under review" "more information needed" "withdrawn" "declined" "accepted" "alternate" "confirmed" "approved/pending presenter acceptance" "approved/accepted by presenter" "approved/declined by presenter"
session_has_been_generated
boolean (Session Has Been Generated)

Boolean flag indicating whether or not a session has been been generated for this abstract

title
required
string (Title)

The title of the abstract

body
required
string (Body)

The body of the abstract

type_id
required
string (Type)

The id for the type of abstract

Array of objects (Custom Field Values)
date
string <date-time> (Date)

The date of abstract submission

session_track_ids
Array of strings (Session Tracks)

Session tracks associations for the abstract

number
number <float> (Number)

The abstract number

max_contact_submissions
number <float> (Max Contact Submissions)

The max number of abstracts per contact for an event

submitting_on_behalf_of_presenter
boolean (Submitting On Behalf Of Presenter)

Bool that identifies if the submitter is different than the presenter

required
object (Presenter Info)
review_process_id
string (Review Process)

Review process for which this abstract is assigned

reviews_assigned
boolean (Reviews Assigned)

Have reviews been assigned for this abstract

review_round_id
required
string (Review Round)

Current review round for this abstract

notes
string (Notes)
approval_process_id
string (Approval Process)

The approval process for this abstract

Array of objects
object (Co Author 1)
object (Co Author 2)
object (Co Author 3)
object (Co Author 4)
object (Co Author 5)
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 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
post/abstracts/{tenantId}/confirm/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "event_id": "string",
  • "main_presenter_id": "string",
  • "process_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "organization_id": "string",
  • "submitter_id": "string",
  • "has_co_authors": true,
  • "co_authors": [
    ],
  • "status": "draft",
  • "session_has_been_generated": true,
  • "title": "string",
  • "body": "string",
  • "type_id": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "session_track_ids": [
    ],
  • "number": 0,
  • "max_contact_submissions": 0,
  • "submitting_on_behalf_of_presenter": true,
  • "presenter_info": {
    },
  • "review_process_id": "string",
  • "reviews_assigned": true,
  • "review_round_id": "string",
  • "notes": "string",
  • "approval_process_id": "string",
  • "round_scores": [
    ],
  • "co_author_1": {
    },
  • "co_author_2": {
    },
  • "co_author_3": {
    },
  • "co_author_4": {
    },
  • "co_author_5": {
    },
  • "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 list of records with the specified type_id

Returns a list of records with the specified type_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

type_id
required
string

The type_id 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/abstracts/{tenantId}/type/{type_id}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/type/:type_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Bulk update abstract statuses

Allows for bulk update of abstract statuses

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

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

Request Body schema: application/json

AbstractIDs and FormData for sessions step function

abstractIds
required
Array of strings (Abstractids)

Array of ids for the abstracts that will become breakout sessions

sessionData
object (Sessiondata)
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
post/abstracts/{tenantId}/breakoutSessions
Request samples
    1 more
    Python
application/json
{
  • "abstractIds": [
    ],
  • "sessionData": { }
}

Calculations for the reviews for an abstract

Return the set of totals and calculations for an abstract based on the reviews and grouped by the rounds

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

abstractId
required
string

The abstract

Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/abstracts/{tenantId}/calculateScore/{abstractId}
Request samples
curl -i -X POST \
  https://events.api.756794052567.rhythmsoftware.com/abstracts/:tenantId/calculateScore/:abstractId \
  -H 'Authorization: YOUR_API_KEY_HERE'

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