Awards

Awards (Awards & Nominations) (v1-2025-04-18)

Service providing access to Awards (Awards & Nominations) resources and features

Download OpenAPI description

awards-v1.json

awards-v1.yaml

Servers

Mock server

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

https://awards.api.rhythmsoftware.com/

Application Fees

Operations

Application Processes

Operations

Application Status Reasons

Operations

Applications

Operations

Creates a new application record that does not already exist.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The application that you would like to be saved.

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

award_idstring(Award)required

The id of the award

award_type_idstring(Award Type)required

The type of the award

bucket_idstring(Bucket)required

The review bucket

citystring(City)

The member city

contact_idstring(Contact)required

The contact for this application

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

datestring(Date)required

The date of application

email_addressstring(Email Address)

The member's email address

fee_idstring(Fee)

Id of the application fee

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

namestring(Name)required

The member's name

nominee_idstring(Nominee)

The nominee to which this application is linked

notesstring(Notes)

Notes on the application

number_of_missing_referencesnumber(float)(Number Of Missing References)

The number of references missing on the application

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization for this application

override_bucket_assignmentboolean(Override Bucket Assignment)

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

owner_typestring(Owner Type)required

Contact or an organization

Enum"contact""organization"

pending_console_reviewboolean(Pending Console Review)

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

process_idstring(Process)

The id of the application process

recipient_categoriesArray of objects

referencesArray of objectsnon-empty

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"

reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

statestring(State)

The state

statusstring(Status)

The status of the application

Enum"approved""complete""declined""missing references""withdrawn"

status_reason_idstring(Status Reason)

The reason for the status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/applications/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "average_score": 0.1,
    "award_id": "string",
    "award_type_id": "string",
    "bucket_id": "string",
    "city": "string",
    "contact_id": "string",
    "country": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "date": "string",
    "email_address": "string",
    "fee_id": "string",
    "first_name": "string",
    "id": "string",
    "job_title": "string",
    "last_name": "string",
    "last_review_status_change": "2019-08-24T14:15:22Z",
    "name": "string",
    "nominee_id": "string",
    "notes": "string",
    "number_of_missing_references": 0.1,
    "order_id": "string",
    "order_line_item_id": "string",
    "organization_id": "string",
    "override_bucket_assignment": true,
    "owner_type": "contact",
    "pending_console_review": true,
    "process_id": "string",
    "recipient_categories": [
      {
        "category_id": "string"
      }
    ],
    "references": [
      {
        "id": "string",
        "reference_contact_info": {},
        "reference_type_id": "string"
      }
    ],
    "review_status": "accepted",
    "reviewer_recommendation": "string",
    "round_id": "string",
    "state": "string",
    "status": "approved",
    "status_reason_id": "string",
    "submission_space_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_score": 0.1
  }'

Responses

The application was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

award_idstring(Award)required

The id of the award

award_type_idstring(Award Type)required

The type of the award

bucket_idstring(Bucket)required

The review bucket

citystring(City)

The member city

contact_idstring(Contact)required

The contact for this application

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

datestring(Date)required

The date of application

email_addressstring(Email Address)

The member's email address

fee_idstring(Fee)

Id of the application fee

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

namestring(Name)required

The member's name

nominee_idstring(Nominee)

The nominee to which this application is linked

notesstring(Notes)

Notes on the application

number_of_missing_referencesnumber(float)(Number Of Missing References)

The number of references missing on the application

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization for this application

override_bucket_assignmentboolean(Override Bucket Assignment)

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

owner_typestring(Owner Type)required

Contact or an organization

Enum"contact""organization"

pending_console_reviewboolean(Pending Console Review)

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

process_idstring(Process)

The id of the application process

recipient_categoriesArray of objects

referencesArray of objectsnon-empty

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"

reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

statestring(State)

The state

statusstring(Status)

The status of the application

Enum"approved""complete""declined""missing references""withdrawn"

status_reason_idstring(Status Reason)

The reason for the status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

Response

application/json

{
  "average_score": 0.1,
  "award_id": "string",
  "award_type_id": "string",
  "bucket_id": "string",
  "city": "string",
  "contact_id": "string",
  "country": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "string",
  "email_address": "string",
  "fee_id": "string",
  "first_name": "string",
  "id": "string",
  "job_title": "string",
  "last_name": "string",
  "last_review_status_change": "2019-08-24T14:15:22Z",
  "name": "string",
  "nominee_id": "string",
  "notes": "string",
  "number_of_missing_references": 0.1,
  "order_id": "string",
  "order_line_item_id": "string",
  "organization_id": "string",
  "override_bucket_assignment": true,
  "owner_type": "contact",
  "pending_console_review": true,
  "process_id": "string",
  "recipient_categories": [
    { … }
  ],
  "references": [
    { … }
  ],
  "review_status": "accepted",
  "reviewer_recommendation": "string",
  "round_id": "string",
  "state": "string",
  "status": "approved",
  "status_reason_id": "string",
  "submission_space_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_score": 0.1
}

Returns a list of records with the specified award_id

Request

Returns a list of records with the specified award_id

Path

tenantIdstringrequired

The tenant

award_idstringrequired

The award_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

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

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Application)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Execute Batch Operations

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/applications/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

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

Returns a list of records with the specified owner_type and id

Request

Returns a list of records with the specified owner_type and id

Path

tenantIdstringrequired

The tenant

ownerTypestringrequired

The owner_type to use to for record lookup

contactOrOrgIdstringrequired

The contact_id or organization_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

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

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Application)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Generates an order from an awards application

Request

This method will examine an awards application and generate an appropriate order

Path

tenantIdstringrequired

The id of the tenant being accessed

Bodyapplication/jsonrequired

The application to generate an order

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

award_idstring(Award)required

The id of the award

award_type_idstring(Award Type)required

The type of the award

bucket_idstring(Bucket)required

The review bucket

citystring(City)

The member city

contact_idstring(Contact)required

The contact for this application

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

datestring(Date)required

The date of application

email_addressstring(Email Address)

The member's email address

fee_idstring(Fee)

Id of the application fee

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

namestring(Name)required

The member's name

nominee_idstring(Nominee)

The nominee to which this application is linked

notesstring(Notes)

Notes on the application

number_of_missing_referencesnumber(float)(Number Of Missing References)

The number of references missing on the application

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization for this application

override_bucket_assignmentboolean(Override Bucket Assignment)

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

owner_typestring(Owner Type)required

Contact or an organization

Enum"contact""organization"

pending_console_reviewboolean(Pending Console Review)

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

process_idstring(Process)

The id of the application process

recipient_categoriesArray of objects

referencesArray of objectsnon-empty

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"

reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

statestring(State)

The state

statusstring(Status)

The status of the application

Enum"approved""complete""declined""missing references""withdrawn"

status_reason_idstring(Status Reason)

The reason for the status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/applications/{tenantId}/generateOrder' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "average_score": 0.1,
    "award_id": "string",
    "award_type_id": "string",
    "bucket_id": "string",
    "city": "string",
    "contact_id": "string",
    "country": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "date": "string",
    "email_address": "string",
    "fee_id": "string",
    "first_name": "string",
    "id": "string",
    "job_title": "string",
    "last_name": "string",
    "last_review_status_change": "2019-08-24T14:15:22Z",
    "name": "string",
    "nominee_id": "string",
    "notes": "string",
    "number_of_missing_references": 0.1,
    "order_id": "string",
    "order_line_item_id": "string",
    "organization_id": "string",
    "override_bucket_assignment": true,
    "owner_type": "contact",
    "pending_console_review": true,
    "process_id": "string",
    "recipient_categories": [
      {
        "category_id": "string"
      }
    ],
    "references": [
      {
        "id": "string",
        "reference_contact_info": {},
        "reference_type_id": "string"
      }
    ],
    "review_status": "accepted",
    "reviewer_recommendation": "string",
    "round_id": "string",
    "state": "string",
    "status": "approved",
    "status_reason_id": "string",
    "submission_space_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_score": 0.1
  }'

Responses

Conflicts were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

object

Response

application/json

{}

Sends out a preview of the CRC notification email

Request

Sends out a preview of the CRC notification email

Path

tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

application_idstring(Application)

destination_email_addressstring(Destination Email Address)required

email_templateobject(Email Template)

nomination_idstring(Nomination)

reference_idstring(Reference)required

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/applications/{tenantId}/previewEmail' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application_id": "string",
    "destination_email_address": "string",
    "email_template": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "nomination_id": "string",
    "reference_id": "string"
  }'

Responses

The record was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Sends out a preview of the CRC notification email

Request

Sends out a preview of the CRC notification email

Path

tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

award_idstring(Award)required

The id of the award

award_type_idstring(Award Type)required

The type of the award

bucket_idstring(Bucket)required

The review bucket

citystring(City)

The member city

contact_idstring(Contact)required

The contact for this application

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

datestring(Date)required

The date of application

email_addressstring(Email Address)

The member's email address

fee_idstring(Fee)

Id of the application fee

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

namestring(Name)required

The member's name

nominee_idstring(Nominee)

The nominee to which this application is linked

notesstring(Notes)

Notes on the application

number_of_missing_referencesnumber(float)(Number Of Missing References)

The number of references missing on the application

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization for this application

override_bucket_assignmentboolean(Override Bucket Assignment)

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

owner_typestring(Owner Type)required

Contact or an organization

Enum"contact""organization"

pending_console_reviewboolean(Pending Console Review)

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

process_idstring(Process)

The id of the application process

recipient_categoriesArray of objects

referencesArray of objectsnon-empty

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"

reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

statestring(State)

The state

statusstring(Status)

The status of the application

Enum"approved""complete""declined""missing references""withdrawn"

status_reason_idstring(Status Reason)

The reason for the status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/applications/{tenantId}/process' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "average_score": 0.1,
    "award_id": "string",
    "award_type_id": "string",
    "bucket_id": "string",
    "city": "string",
    "contact_id": "string",
    "country": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "date": "string",
    "email_address": "string",
    "fee_id": "string",
    "first_name": "string",
    "id": "string",
    "job_title": "string",
    "last_name": "string",
    "last_review_status_change": "2019-08-24T14:15:22Z",
    "name": "string",
    "nominee_id": "string",
    "notes": "string",
    "number_of_missing_references": 0.1,
    "order_id": "string",
    "order_line_item_id": "string",
    "organization_id": "string",
    "override_bucket_assignment": true,
    "owner_type": "contact",
    "pending_console_review": true,
    "process_id": "string",
    "recipient_categories": [
      {
        "category_id": "string"
      }
    ],
    "references": [
      {
        "id": "string",
        "reference_contact_info": {},
        "reference_type_id": "string"
      }
    ],
    "review_status": "accepted",
    "reviewer_recommendation": "string",
    "round_id": "string",
    "state": "string",
    "status": "approved",
    "status_reason_id": "string",
    "submission_space_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_score": 0.1
  }'

Responses

The record was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Searches for applications using predefined parameters

Request

Searches for applications using predefined parameters

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

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

Bodyapplication/jsonrequired

The application that you would like to be saved.

award_idsArray of strings(Awards)

IDs of the awards to search

category_idsArray of strings(Categories)

IDs of the award categories

citystring(City)

City to search

contact_idsArray of strings(Contacts)

The contact ids of the applications

datestring(Date)

Date

email_addressstring(Email Address)

first_namestring(First Name)

idsArray of strings(Ids)

IDs to search

job_titlestring(Job Title)

last_namestring(Last Name)

namestring(Name)

nicknamestring(Nickname)

organization_idArray of strings(Organization)

owner_typestring(Owner Type)

statestring(State)

The state

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/applications/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "award_ids": [
      "string"
    ],
    "category_ids": [
      "string"
    ],
    "city": "string",
    "contact_ids": [
      "string"
    ],
    "date": "string",
    "email_address": "string",
    "first_name": "string",
    "ids": [
      "string"
    ],
    "job_title": "string",
    "last_name": "string",
    "name": "string",
    "nickname": "string",
    "organization_id": [
      "string"
    ],
    "owner_type": "string",
    "state": "string"
  }'

Responses

The application search was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

ItemsArray of objects(ApplicationSearchResults)

LastEvaluatedKeystring

Response

application/json

{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a application from the system by its ID.

Request

This method will delete a application with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the application to delete.

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

Responses

The application was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a application from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the application to return.

Query

fieldsstring

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

consistentReadstring

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

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

Responses

The application was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

award_idstring(Award)required

The id of the award

award_type_idstring(Award Type)required

The type of the award

bucket_idstring(Bucket)required

The review bucket

citystring(City)

The member city

contact_idstring(Contact)required

The contact for this application

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

datestring(Date)required

The date of application

email_addressstring(Email Address)

The member's email address

fee_idstring(Fee)

Id of the application fee

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

namestring(Name)required

The member's name

nominee_idstring(Nominee)

The nominee to which this application is linked

notesstring(Notes)

Notes on the application

number_of_missing_referencesnumber(float)(Number Of Missing References)

The number of references missing on the application

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization for this application

override_bucket_assignmentboolean(Override Bucket Assignment)

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

owner_typestring(Owner Type)required

Contact or an organization

Enum"contact""organization"

pending_console_reviewboolean(Pending Console Review)

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

process_idstring(Process)

The id of the application process

recipient_categoriesArray of objects

referencesArray of objectsnon-empty

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"

reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

statestring(State)

The state

statusstring(Status)

The status of the application

Enum"approved""complete""declined""missing references""withdrawn"

status_reason_idstring(Status Reason)

The reason for the status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

Response

application/json

{
  "average_score": 0.1,
  "award_id": "string",
  "award_type_id": "string",
  "bucket_id": "string",
  "city": "string",
  "contact_id": "string",
  "country": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "string",
  "email_address": "string",
  "fee_id": "string",
  "first_name": "string",
  "id": "string",
  "job_title": "string",
  "last_name": "string",
  "last_review_status_change": "2019-08-24T14:15:22Z",
  "name": "string",
  "nominee_id": "string",
  "notes": "string",
  "number_of_missing_references": 0.1,
  "order_id": "string",
  "order_line_item_id": "string",
  "organization_id": "string",
  "override_bucket_assignment": true,
  "owner_type": "contact",
  "pending_console_review": true,
  "process_id": "string",
  "recipient_categories": [
    { … }
  ],
  "references": [
    { … }
  ],
  "review_status": "accepted",
  "reviewer_recommendation": "string",
  "round_id": "string",
  "state": "string",
  "status": "approved",
  "status_reason_id": "string",
  "submission_space_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_score": 0.1
}

Partially updates a application with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the application to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

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

pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]

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

Responses

The application was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

award_idstring(Award)required

The id of the award

award_type_idstring(Award Type)required

The type of the award

bucket_idstring(Bucket)required

The review bucket

citystring(City)

The member city

contact_idstring(Contact)required

The contact for this application

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

datestring(Date)required

The date of application

email_addressstring(Email Address)

The member's email address

fee_idstring(Fee)

Id of the application fee

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

namestring(Name)required

The member's name

nominee_idstring(Nominee)

The nominee to which this application is linked

notesstring(Notes)

Notes on the application

number_of_missing_referencesnumber(float)(Number Of Missing References)

The number of references missing on the application

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization for this application

override_bucket_assignmentboolean(Override Bucket Assignment)

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

owner_typestring(Owner Type)required

Contact or an organization

Enum"contact""organization"

pending_console_reviewboolean(Pending Console Review)

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

process_idstring(Process)

The id of the application process

recipient_categoriesArray of objects

referencesArray of objectsnon-empty

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"

reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

statestring(State)

The state

statusstring(Status)

The status of the application

Enum"approved""complete""declined""missing references""withdrawn"

status_reason_idstring(Status Reason)

The reason for the status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

Response

application/json

{
  "average_score": 0.1,
  "award_id": "string",
  "award_type_id": "string",
  "bucket_id": "string",
  "city": "string",
  "contact_id": "string",
  "country": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "string",
  "email_address": "string",
  "fee_id": "string",
  "first_name": "string",
  "id": "string",
  "job_title": "string",
  "last_name": "string",
  "last_review_status_change": "2019-08-24T14:15:22Z",
  "name": "string",
  "nominee_id": "string",
  "notes": "string",
  "number_of_missing_references": 0.1,
  "order_id": "string",
  "order_line_item_id": "string",
  "organization_id": "string",
  "override_bucket_assignment": true,
  "owner_type": "contact",
  "pending_console_review": true,
  "process_id": "string",
  "recipient_categories": [
    { … }
  ],
  "references": [
    { … }
  ],
  "review_status": "accepted",
  "reviewer_recommendation": "string",
  "round_id": "string",
  "state": "string",
  "status": "approved",
  "status_reason_id": "string",
  "submission_space_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_score": 0.1
}

Updates a application with the specified ID.

Request

This method will update an existing application with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the application to update.

Bodyapplication/jsonrequired

The updated application that will be saved.

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

award_idstring(Award)required

The id of the award

award_type_idstring(Award Type)required

The type of the award

bucket_idstring(Bucket)required

The review bucket

citystring(City)

The member city

contact_idstring(Contact)required

The contact for this application

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

datestring(Date)required

The date of application

email_addressstring(Email Address)

The member's email address

fee_idstring(Fee)

Id of the application fee

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

namestring(Name)required

The member's name

nominee_idstring(Nominee)

The nominee to which this application is linked

notesstring(Notes)

Notes on the application

number_of_missing_referencesnumber(float)(Number Of Missing References)

The number of references missing on the application

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization for this application

override_bucket_assignmentboolean(Override Bucket Assignment)

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

owner_typestring(Owner Type)required

Contact or an organization

Enum"contact""organization"

pending_console_reviewboolean(Pending Console Review)

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

process_idstring(Process)

The id of the application process

recipient_categoriesArray of objects

referencesArray of objectsnon-empty

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"

reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

statestring(State)

The state

statusstring(Status)

The status of the application

Enum"approved""complete""declined""missing references""withdrawn"

status_reason_idstring(Status Reason)

The reason for the status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/applications/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "average_score": 0.1,
    "award_id": "string",
    "award_type_id": "string",
    "bucket_id": "string",
    "city": "string",
    "contact_id": "string",
    "country": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "date": "string",
    "email_address": "string",
    "fee_id": "string",
    "first_name": "string",
    "id": "string",
    "job_title": "string",
    "last_name": "string",
    "last_review_status_change": "2019-08-24T14:15:22Z",
    "name": "string",
    "nominee_id": "string",
    "notes": "string",
    "number_of_missing_references": 0.1,
    "order_id": "string",
    "order_line_item_id": "string",
    "organization_id": "string",
    "override_bucket_assignment": true,
    "owner_type": "contact",
    "pending_console_review": true,
    "process_id": "string",
    "recipient_categories": [
      {
        "category_id": "string"
      }
    ],
    "references": [
      {
        "id": "string",
        "reference_contact_info": {},
        "reference_type_id": "string"
      }
    ],
    "review_status": "accepted",
    "reviewer_recommendation": "string",
    "round_id": "string",
    "state": "string",
    "status": "approved",
    "status_reason_id": "string",
    "submission_space_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_score": 0.1
  }'

Responses

The application was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

average_scorenumber(float)(Average Score)

The average score for this submission in the most recent round

award_idstring(Award)required

The id of the award

award_type_idstring(Award Type)required

The type of the award

bucket_idstring(Bucket)required

The review bucket

citystring(City)

The member city

contact_idstring(Contact)required

The contact for this application

countrystring(Country)

The member country

custom_field_valuesArray of objects(Custom Field Values)

datestring(Date)required

The date of application

email_addressstring(Email Address)

The member's email address

fee_idstring(Fee)

Id of the application fee

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this application

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_review_status_changestring(date-time)(Last Review Status Change)

The date that the review status was last changed

namestring(Name)required

The member's name

nominee_idstring(Nominee)

The nominee to which this application is linked

notesstring(Notes)

Notes on the application

number_of_missing_referencesnumber(float)(Number Of Missing References)

The number of references missing on the application

order_idstring(Order)

The order that last touched this application

order_line_item_idstring(Order Line Item)

The order line item touched this application

organization_idstring(Organization)required

The organization for this application

override_bucket_assignmentboolean(Override Bucket Assignment)

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

owner_typestring(Owner Type)required

Contact or an organization

Enum"contact""organization"

pending_console_reviewboolean(Pending Console Review)

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

process_idstring(Process)

The id of the application process

recipient_categoriesArray of objects

referencesArray of objectsnon-empty

review_statusstring(Review Status)

The review status of this application

Enum"accepted""alternate""declined""pending review"

reviewer_recommendationstring(Reviewer Recommendation)

Aggregate recommendation across all reviewers

round_idstring(Round)

The review round

statestring(State)

The state

statusstring(Status)

The status of the application

Enum"approved""complete""declined""missing references""withdrawn"

status_reason_idstring(Status Reason)

The reason for the status

submission_space_idstring(Submission Space)

The submission space to which this object belongs

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_scorenumber(float)(Total Score)

The total score for this submission in the most recent round

Response

application/json

{
  "average_score": 0.1,
  "award_id": "string",
  "award_type_id": "string",
  "bucket_id": "string",
  "city": "string",
  "contact_id": "string",
  "country": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "string",
  "email_address": "string",
  "fee_id": "string",
  "first_name": "string",
  "id": "string",
  "job_title": "string",
  "last_name": "string",
  "last_review_status_change": "2019-08-24T14:15:22Z",
  "name": "string",
  "nominee_id": "string",
  "notes": "string",
  "number_of_missing_references": 0.1,
  "order_id": "string",
  "order_line_item_id": "string",
  "organization_id": "string",
  "override_bucket_assignment": true,
  "owner_type": "contact",
  "pending_console_review": true,
  "process_id": "string",
  "recipient_categories": [
    { … }
  ],
  "references": [
    { … }
  ],
  "review_status": "accepted",
  "reviewer_recommendation": "string",
  "round_id": "string",
  "state": "string",
  "status": "approved",
  "status_reason_id": "string",
  "submission_space_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_score": 0.1
}

Awards

Operations

Coupons

Operations

Nomination Processes

Operations

Nominations

Operations

Nominees

Operations

Query Definitions

Operations

Recipient Categories

Operations

Recipients

Operations

Reference Processes

Operations

Reference Types

Operations

References

Operations

Review Processes

Operations

Review Rounds

Operations

Reviews

Operations

Settings

Operations

Statistics

Operations

Types

Operations

Awards (Awards & Nominations) (v1-2025-04-18)

Application Fees

Application Processes

Application Status Reasons

Applications

Creates a new application record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified award_id

Request

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified owner_type and id

Request

Responses

Was this helpful?

Generates an order from an awards application

RequestExpand all

Responses

Was this helpful?

Sends out a preview of the CRC notification email

RequestExpand all

Responses

Was this helpful?

Sends out a preview of the CRC notification email

RequestExpand all

Responses

Was this helpful?

Searches for applications using predefined parameters

Request

Responses

Was this helpful?

Returns a application from the system by its ID.

Request

Responses

Was this helpful?

Returns a application from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a application with the specified ID.

Request

Responses

Was this helpful?

Updates a application with the specified ID.

RequestExpand all

Responses

Was this helpful?

Awards

Categories

Coupons

Nomination Processes

Nominations

Nominees

Query Definitions

Recipient Categories

Recipients

Reference Processes

Reference Types

References

Review Processes

Review Rounds

Reviews

Settings

Statistics

Types

Request

Request

Request

Request

Request

Request