Awards

Partially updates a reference process with the specified ID.

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

Awards

Operations

Coupons

Operations

Nomination Processes

Operations

Nominations

Operations

Nominees

Operations

Query Definitions

Operations

Recipient Categories

Operations

Recipients

Operations

Reference Processes

Operations

Creates a new reference process record that does not already exist.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The reference process that you would like to be saved.

application_notice_emailobject(Application Notice Email)required

application_notice_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

application_notice_email.bodystring(Body)required

The email body

application_notice_email.ccstring(Cc)

Anyone that should be cc'ed on the email

application_notice_email.fromstring(From)

From email address

application_notice_email.from_namestring(From Name)

From name

application_notice_email.reply_tostring(Reply To)

The reply to

application_notice_email.subjectstring(Subject)required

The email subject

award_idstring(Award)required

The id of the award

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

display_in_portalboolean(Display In Portal)

Whether or not to hide in the portal

display_in_portal_asstring(Display In Portal As)

How to display this process in the portal

enable_application_notice_emailboolean(Enable Application Notice Email)

If true, an email is sent to the applicant notifying them that their application still requires a reference

enable_reference_notification_emailboolean(Enable Reference Notification Email)

If true, an email is sent to the reference once the application is processes

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

The unique, string identifier of this reference

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

reference_form_idstring(Reference Form)^awards-references__.*required

The form the reference should use

reference_notification_emailobject(Reference Notification Email)required

reference_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

reference_notification_email.bodystring(Body)required

The email body

reference_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

reference_notification_email.fromstring(From)

From email address

reference_notification_email.from_namestring(From Name)

From name

reference_notification_email.reply_tostring(Reply To)

The reply to

reference_notification_email.subjectstring(Subject)required

The email subject

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

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

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/referenceProcesses/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application_notice_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "award_id": "string",
    "contact_form_options": {
      "contact_form_id": "string",
      "html": "string"
    },
    "display_in_portal": true,
    "display_in_portal_as": "string",
    "enable_application_notice_email": true,
    "enable_reference_notification_email": true,
    "id": "string",
    "is_active": true,
    "name": "string",
    "organization_form_options": {
      "html": "string",
      "organization_form_id": "string"
    },
    "reference_form_id": "string",
    "reference_notification_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "show_contact_form": true,
    "show_organization_form": true,
    "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
  }'

Responses

The reference process was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

application_notice_emailobject(Application Notice Email)required

application_notice_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

application_notice_email.bodystring(Body)required

The email body

application_notice_email.ccstring(Cc)

Anyone that should be cc'ed on the email

application_notice_email.fromstring(From)

From email address

application_notice_email.from_namestring(From Name)

From name

application_notice_email.reply_tostring(Reply To)

The reply to

application_notice_email.subjectstring(Subject)required

The email subject

award_idstring(Award)required

The id of the award

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

display_in_portalboolean(Display In Portal)

Whether or not to hide in the portal

display_in_portal_asstring(Display In Portal As)

How to display this process in the portal

enable_application_notice_emailboolean(Enable Application Notice Email)

If true, an email is sent to the applicant notifying them that their application still requires a reference

enable_reference_notification_emailboolean(Enable Reference Notification Email)

If true, an email is sent to the reference once the application is processes

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

The unique, string identifier of this reference

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

reference_form_idstring(Reference Form)^awards-references__.*required

The form the reference should use

reference_notification_emailobject(Reference Notification Email)required

reference_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

reference_notification_email.bodystring(Body)required

The email body

reference_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

reference_notification_email.fromstring(From)

From email address

reference_notification_email.from_namestring(From Name)

From name

reference_notification_email.reply_tostring(Reply To)

The reply to

reference_notification_email.subjectstring(Subject)required

The email subject

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

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

Response

application/json

{
  "application_notice_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "award_id": "string",
  "contact_form_options": {
    "contact_form_id": "string",
    "html": "string"
  },
  "display_in_portal": true,
  "display_in_portal_as": "string",
  "enable_application_notice_email": true,
  "enable_reference_notification_email": true,
  "id": "string",
  "is_active": true,
  "name": "string",
  "organization_form_options": {
    "html": "string",
    "organization_form_id": "string"
  },
  "reference_form_id": "string",
  "reference_notification_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "show_contact_form": true,
  "show_organization_form": true,
  "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
}

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/referenceProcesses/{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(ReferenceProcess)

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/referenceProcesses/{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 reference process from the system by its ID.

Request

This method will delete a reference process with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the reference process to delete.

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

Responses

The reference process 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 reference process from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the reference process 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/referenceProcesses/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The reference process was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

application_notice_emailobject(Application Notice Email)required

application_notice_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

application_notice_email.bodystring(Body)required

The email body

application_notice_email.ccstring(Cc)

Anyone that should be cc'ed on the email

application_notice_email.fromstring(From)

From email address

application_notice_email.from_namestring(From Name)

From name

application_notice_email.reply_tostring(Reply To)

The reply to

application_notice_email.subjectstring(Subject)required

The email subject

award_idstring(Award)required

The id of the award

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

display_in_portalboolean(Display In Portal)

Whether or not to hide in the portal

display_in_portal_asstring(Display In Portal As)

How to display this process in the portal

enable_application_notice_emailboolean(Enable Application Notice Email)

If true, an email is sent to the applicant notifying them that their application still requires a reference

enable_reference_notification_emailboolean(Enable Reference Notification Email)

If true, an email is sent to the reference once the application is processes

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

The unique, string identifier of this reference

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

reference_form_idstring(Reference Form)^awards-references__.*required

The form the reference should use

reference_notification_emailobject(Reference Notification Email)required

reference_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

reference_notification_email.bodystring(Body)required

The email body

reference_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

reference_notification_email.fromstring(From)

From email address

reference_notification_email.from_namestring(From Name)

From name

reference_notification_email.reply_tostring(Reply To)

The reply to

reference_notification_email.subjectstring(Subject)required

The email subject

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

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

Response

application/json

{
  "application_notice_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "award_id": "string",
  "contact_form_options": {
    "contact_form_id": "string",
    "html": "string"
  },
  "display_in_portal": true,
  "display_in_portal_as": "string",
  "enable_application_notice_email": true,
  "enable_reference_notification_email": true,
  "id": "string",
  "is_active": true,
  "name": "string",
  "organization_form_options": {
    "html": "string",
    "organization_form_id": "string"
  },
  "reference_form_id": "string",
  "reference_notification_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "show_contact_form": true,
  "show_organization_form": true,
  "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
}

Partially updates a reference process with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the reference process 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/referenceProcesses/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The reference process was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

application_notice_emailobject(Application Notice Email)required

application_notice_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

application_notice_email.bodystring(Body)required

The email body

application_notice_email.ccstring(Cc)

Anyone that should be cc'ed on the email

application_notice_email.fromstring(From)

From email address

application_notice_email.from_namestring(From Name)

From name

application_notice_email.reply_tostring(Reply To)

The reply to

application_notice_email.subjectstring(Subject)required

The email subject

award_idstring(Award)required

The id of the award

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

display_in_portalboolean(Display In Portal)

Whether or not to hide in the portal

display_in_portal_asstring(Display In Portal As)

How to display this process in the portal

enable_application_notice_emailboolean(Enable Application Notice Email)

If true, an email is sent to the applicant notifying them that their application still requires a reference

enable_reference_notification_emailboolean(Enable Reference Notification Email)

If true, an email is sent to the reference once the application is processes

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

The unique, string identifier of this reference

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

reference_form_idstring(Reference Form)^awards-references__.*required

The form the reference should use

reference_notification_emailobject(Reference Notification Email)required

reference_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

reference_notification_email.bodystring(Body)required

The email body

reference_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

reference_notification_email.fromstring(From)

From email address

reference_notification_email.from_namestring(From Name)

From name

reference_notification_email.reply_tostring(Reply To)

The reply to

reference_notification_email.subjectstring(Subject)required

The email subject

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

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

Response

application/json

{
  "application_notice_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "award_id": "string",
  "contact_form_options": {
    "contact_form_id": "string",
    "html": "string"
  },
  "display_in_portal": true,
  "display_in_portal_as": "string",
  "enable_application_notice_email": true,
  "enable_reference_notification_email": true,
  "id": "string",
  "is_active": true,
  "name": "string",
  "organization_form_options": {
    "html": "string",
    "organization_form_id": "string"
  },
  "reference_form_id": "string",
  "reference_notification_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "show_contact_form": true,
  "show_organization_form": true,
  "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
}

Updates a reference process with the specified ID.

Request

This method will update an existing reference process with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the reference process to update.

Bodyapplication/jsonrequired

The updated reference process that will be saved.

application_notice_emailobject(Application Notice Email)required

application_notice_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

application_notice_email.bodystring(Body)required

The email body

application_notice_email.ccstring(Cc)

Anyone that should be cc'ed on the email

application_notice_email.fromstring(From)

From email address

application_notice_email.from_namestring(From Name)

From name

application_notice_email.reply_tostring(Reply To)

The reply to

application_notice_email.subjectstring(Subject)required

The email subject

award_idstring(Award)required

The id of the award

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

display_in_portalboolean(Display In Portal)

Whether or not to hide in the portal

display_in_portal_asstring(Display In Portal As)

How to display this process in the portal

enable_application_notice_emailboolean(Enable Application Notice Email)

If true, an email is sent to the applicant notifying them that their application still requires a reference

enable_reference_notification_emailboolean(Enable Reference Notification Email)

If true, an email is sent to the reference once the application is processes

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

The unique, string identifier of this reference

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

reference_form_idstring(Reference Form)^awards-references__.*required

The form the reference should use

reference_notification_emailobject(Reference Notification Email)required

reference_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

reference_notification_email.bodystring(Body)required

The email body

reference_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

reference_notification_email.fromstring(From)

From email address

reference_notification_email.from_namestring(From Name)

From name

reference_notification_email.reply_tostring(Reply To)

The reply to

reference_notification_email.subjectstring(Subject)required

The email subject

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

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

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/referenceProcesses/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application_notice_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "award_id": "string",
    "contact_form_options": {
      "contact_form_id": "string",
      "html": "string"
    },
    "display_in_portal": true,
    "display_in_portal_as": "string",
    "enable_application_notice_email": true,
    "enable_reference_notification_email": true,
    "id": "string",
    "is_active": true,
    "name": "string",
    "organization_form_options": {
      "html": "string",
      "organization_form_id": "string"
    },
    "reference_form_id": "string",
    "reference_notification_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "show_contact_form": true,
    "show_organization_form": true,
    "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
  }'

Responses

The reference process was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

application_notice_emailobject(Application Notice Email)required

application_notice_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

application_notice_email.bodystring(Body)required

The email body

application_notice_email.ccstring(Cc)

Anyone that should be cc'ed on the email

application_notice_email.fromstring(From)

From email address

application_notice_email.from_namestring(From Name)

From name

application_notice_email.reply_tostring(Reply To)

The reply to

application_notice_email.subjectstring(Subject)required

The email subject

award_idstring(Award)required

The id of the award

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

display_in_portalboolean(Display In Portal)

Whether or not to hide in the portal

display_in_portal_asstring(Display In Portal As)

How to display this process in the portal

enable_application_notice_emailboolean(Enable Application Notice Email)

If true, an email is sent to the applicant notifying them that their application still requires a reference

enable_reference_notification_emailboolean(Enable Reference Notification Email)

If true, an email is sent to the reference once the application is processes

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

The unique, string identifier of this reference

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

reference_form_idstring(Reference Form)^awards-references__.*required

The form the reference should use

reference_notification_emailobject(Reference Notification Email)required

reference_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

reference_notification_email.bodystring(Body)required

The email body

reference_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

reference_notification_email.fromstring(From)

From email address

reference_notification_email.from_namestring(From Name)

From name

reference_notification_email.reply_tostring(Reply To)

The reply to

reference_notification_email.subjectstring(Subject)required

The email subject

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

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

Response

application/json

{
  "application_notice_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "award_id": "string",
  "contact_form_options": {
    "contact_form_id": "string",
    "html": "string"
  },
  "display_in_portal": true,
  "display_in_portal_as": "string",
  "enable_application_notice_email": true,
  "enable_reference_notification_email": true,
  "id": "string",
  "is_active": true,
  "name": "string",
  "organization_form_options": {
    "html": "string",
    "organization_form_id": "string"
  },
  "reference_form_id": "string",
  "reference_notification_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "show_contact_form": true,
  "show_organization_form": true,
  "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
}

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

Awards

Categories

Coupons

Nomination Processes

Nominations

Nominees

Query Definitions

Recipient Categories

Recipients

Reference Processes

Creates a new reference process 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 reference process from the system by its ID.

Request

Responses

Was this helpful?

Returns a reference process from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a reference process with the specified ID.

Request

Responses

Was this helpful?

Updates a reference process with the specified ID.

RequestExpand all

Responses

Was this helpful?

Reference Types

References

Review Processes

Review Rounds

Reviews

Settings

Statistics

Types

Request

Request

Request