Reviews

Reviews

Creates a new review record that does not already exist.

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

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

The unique, string identifier of this award application reviews

award_id
required
string (Award)

ID associating the review to the event

application_id
required
string (Application)

Abstract associated to this review

status
required
string (Status)

Status for this review: not started, draft, completed

Enum: "not started" "draft" "completed"
score
string (Score)

The score for this review

comments_to_submitter
string (Comments To Submitter)

Comments displayed to abstract submitter

comments_to_staff
string (Comments To Staff)

Comments displayed to the association staff

process_id
required
string (Process)

ID of review process

review_round_id
required
string (Review Round)

ID of review round

required
object (Assignee)

User who to which the review has been assigned

date
string <date-time> (Date)

The date the review was generated

display_in_portal
boolean (Display In Portal)

Should we display the process in the portal

is_active
boolean (Is Active)

Whether or not this abstract review is active

Array of objects (Custom Field Values)
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 review was saved successfully.
400The review you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The review could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add review based on tenant limits.
500General server error.
post/reviews/{tenantId}
Request samples
application/json
{
  • "id": "string",
  • "award_id": "string",
  • "application_id": "string",
  • "status": "not started",
  • "score": "string",
  • "comments_to_submitter": "string",
  • "comments_to_staff": "string",
  • "process_id": "string",
  • "review_round_id": "string",
  • "assignee": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "display_in_portal": true,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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",
  • "award_id": "string",
  • "application_id": "string",
  • "status": "not started",
  • "score": "string",
  • "comments_to_submitter": "string",
  • "comments_to_staff": "string",
  • "process_id": "string",
  • "review_round_id": "string",
  • "assignee": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "display_in_portal": true,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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 review from the system by its ID.

This method will look up a review 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 review 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 review was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The review could not be found.
429Limit exceeded... unable to retrieve review based on tenant limits.
500General server error.
get/reviews/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://awards.api.756794052567.rhythmsoftware.com/reviews/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "award_id": "string",
  • "application_id": "string",
  • "status": "not started",
  • "score": "string",
  • "comments_to_submitter": "string",
  • "comments_to_staff": "string",
  • "process_id": "string",
  • "review_round_id": "string",
  • "assignee": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "display_in_portal": true,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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 review with the specified ID.

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

Request Body schema: application/json

The updated review that will be saved.

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

The unique, string identifier of this award application reviews

award_id
required
string (Award)

ID associating the review to the event

application_id
required
string (Application)

Abstract associated to this review

status
required
string (Status)

Status for this review: not started, draft, completed

Enum: "not started" "draft" "completed"
score
string (Score)

The score for this review

comments_to_submitter
string (Comments To Submitter)

Comments displayed to abstract submitter

comments_to_staff
string (Comments To Staff)

Comments displayed to the association staff

process_id
required
string (Process)

ID of review process

review_round_id
required
string (Review Round)

ID of review round

required
object (Assignee)

User who to which the review has been assigned

date
string <date-time> (Date)

The date the review was generated

display_in_portal
boolean (Display In Portal)

Should we display the process in the portal

is_active
boolean (Is Active)

Whether or not this abstract review is active

Array of objects (Custom Field Values)
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 review was updated successfully.
400The review supplied was not valid.
401Unauthorized.
403Forbidden.
404The review could not be found.
409The review could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve review based on tenant limits.
500General server error.
put/reviews/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "award_id": "string",
  • "application_id": "string",
  • "status": "not started",
  • "score": "string",
  • "comments_to_submitter": "string",
  • "comments_to_staff": "string",
  • "process_id": "string",
  • "review_round_id": "string",
  • "assignee": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "display_in_portal": true,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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",
  • "award_id": "string",
  • "application_id": "string",
  • "status": "not started",
  • "score": "string",
  • "comments_to_submitter": "string",
  • "comments_to_staff": "string",
  • "process_id": "string",
  • "review_round_id": "string",
  • "assignee": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "display_in_portal": true,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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 review with the specified ID.

This method will patch an existing review 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 review 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 review was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The review could not be found.
409The review could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve review based on tenant limits.
500General server error.
patch/reviews/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "award_id": "string",
  • "application_id": "string",
  • "status": "not started",
  • "score": "string",
  • "comments_to_submitter": "string",
  • "comments_to_staff": "string",
  • "process_id": "string",
  • "review_round_id": "string",
  • "assignee": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "display_in_portal": true,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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 review from the system by its ID.

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

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

Returns a list of records with the specified award_id

Returns a list of records with the specified award_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

award_id
required
string

The award_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/reviews/{tenantId}/award/{award_id}
Request samples
curl -i -X GET \
  'https://awards.api.756794052567.rhythmsoftware.com/reviews/:tenantId/award/:award_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 review_round_id

Returns a list of records with the specified review_round_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

review_round_id
required
string

The review_round_id to use to for record lookup

status
required
string

The status of the review

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

Searches for reviews using predefined parameters

Searches for reviews using predefined parameters

Request
Security:
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 review that you would like to be saved.

id
string (ID)
award_id
required
string (Award)
application_id
string (Application)
status
string (Status)
date
Array of strings <date-time> (Date) 2 items
required
object (Assignee)
Responses
200The review search was saved successfully.
400The review you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The review could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add review based on tenant limits.
500General server error.
post/reviews/{tenantId}/search
Request samples
application/json
{
  • "id": "string",
  • "award_id": "string",
  • "application_id": "string",
  • "status": "string",
  • "date": [
    ],
  • "assignee": {
    }
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Submit a review

Request
Security:
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

Object definition of review

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

The unique, string identifier of this award application reviews

award_id
required
string (Award)

ID associating the review to the event

application_id
required
string (Application)

Abstract associated to this review

status
required
string (Status)

Status for this review: not started, draft, completed

Enum: "not started" "draft" "completed"
score
string (Score)

The score for this review

comments_to_submitter
string (Comments To Submitter)

Comments displayed to abstract submitter

comments_to_staff
string (Comments To Staff)

Comments displayed to the association staff

process_id
required
string (Process)

ID of review process

review_round_id
required
string (Review Round)

ID of review round

required
object (Assignee)

User who to which the review has been assigned

date
string <date-time> (Date)

The date the review was generated

display_in_portal
boolean (Display In Portal)

Should we display the process in the portal

is_active
boolean (Is Active)

Whether or not this abstract review is active

Array of objects (Custom Field Values)
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/reviews/{tenantId}/submit
Request samples
application/json
{
  • "id": "string",
  • "award_id": "string",
  • "application_id": "string",
  • "status": "not started",
  • "score": "string",
  • "comments_to_submitter": "string",
  • "comments_to_staff": "string",
  • "process_id": "string",
  • "review_round_id": "string",
  • "assignee": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "display_in_portal": true,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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 contact_id

Returns a list of records with the specified contact_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

contact_id
required
string

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

Execute Batch Operations

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

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