Application Processes

Application Processes

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

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The application process that you would like to be saved.

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

The unique, string identifier of this application process

name
required
string (Name)

The name of the application process

award_id
required
string (Award)

The id of the award

customer_type
required
string (Customer Type)

The type of customer that can complete this process

Enum: "contact" "organization"
requires_nomination
boolean (Requires Nomination)

If set, a contact/organization must be nominated before submitting an application for this process

application_form_id
required
string (Application Form) /awards-applications__.*/

The application form

requires_fee
boolean (Requires Fee)

If true, then this process requires a fee and is associated with an order

fee_id
required
string (Fee)

The id of the associated fee

enable_references
boolean (Enable References)

If true, the references are enabled on this process

required
Array of objects non-empty

The reference requirements for this process

allow_applicants_to_update_information
boolean (Allow Applicants To Update Information)

If true, applicants can modify their applications in the portal

required
object (Application Update Options)
available_from
string <date-time> (Available From)

The date to start showing the process in the portal

available_until
string <date-time> (Available Until)

The date to stop showing the process in the portal

display_order
number <float> (Display Order)

The order to display

restrict_categories
boolean (Restrict Categories)

Should processes be restricted to specific categories

category_ids
required
Array of strings (Categories) non-empty

The categories to which the process is restricted

show_contact_form
boolean (Show Contact Form)

Whether or not to show a contact form

required
object (Contact Form Options)
show_organization_form
boolean (Show Organization Form)

Whether or not to show an organization form

required
object (Organization Form Options)
display_in_portal
boolean (Display In Portal)

Whether or not to hide in the portal

display_in_portal_as
string (Display In Portal As)

How to display this process in the portal

is_active
boolean (Is Active)

Whether or not this process is active

override_checkout_settings
boolean (Override Checkout Settings)

Whether or not to override POC settings

required
object (Checkout Settings)
enable_confirmation_email
boolean (Enable Confirmation Email)

Should the process send out confirmation emails

required
object (Confirmation Email)

The email to send

enable_eligibility_criteria
boolean (Enable Eligibility Criteria)

Should allow eligibility criteria

eligibility_criteria
required
object (Eligibility Criteria)

The criteria for eligibility

sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

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

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

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

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

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

sys_has_files_in_s3
boolean (Sys Has Files In S3)

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

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The application process was saved successfully.
400The application process you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The application process could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add application process based on tenant limits.
500General server error.
post/applicationProcesses/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "award_id": "string",
  • "customer_type": "contact",
  • "requires_nomination": true,
  • "application_form_id": "string",
  • "requires_fee": true,
  • "fee_id": "string",
  • "enable_references": true,
  • "reference_requirements": [
    ],
  • "allow_applicants_to_update_information": true,
  • "application_update_options": {
    },
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "display_order": 0,
  • "restrict_categories": true,
  • "category_ids": [
    ],
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "display_in_portal": true,
  • "display_in_portal_as": "string",
  • "is_active": true,
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "enable_eligibility_criteria": true,
  • "eligibility_criteria": { },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "award_id": "string",
  • "customer_type": "contact",
  • "requires_nomination": true,
  • "application_form_id": "string",
  • "requires_fee": true,
  • "fee_id": "string",
  • "enable_references": true,
  • "reference_requirements": [
    ],
  • "allow_applicants_to_update_information": true,
  • "application_update_options": {
    },
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "display_order": 0,
  • "restrict_categories": true,
  • "category_ids": [
    ],
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "display_in_portal": true,
  • "display_in_portal_as": "string",
  • "is_active": true,
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "enable_eligibility_criteria": true,
  • "eligibility_criteria": { },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a application process from the system by its ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application process to return.

query Parameters
fields
string

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

consistentRead
string

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

Responses
200The application process was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The application process could not be found.
429Limit exceeded... unable to retrieve application process based on tenant limits.
500General server error.
get/applicationProcesses/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://awards.api.756794052567.rhythmsoftware.com/applicationProcesses/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "award_id": "string",
  • "customer_type": "contact",
  • "requires_nomination": true,
  • "application_form_id": "string",
  • "requires_fee": true,
  • "fee_id": "string",
  • "enable_references": true,
  • "reference_requirements": [
    ],
  • "allow_applicants_to_update_information": true,
  • "application_update_options": {
    },
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "display_order": 0,
  • "restrict_categories": true,
  • "category_ids": [
    ],
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "display_in_portal": true,
  • "display_in_portal_as": "string",
  • "is_active": true,
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "enable_eligibility_criteria": true,
  • "eligibility_criteria": { },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a application process with the specified ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application process to update.

Request Body schema: application/json

The updated application process that will be saved.

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

The unique, string identifier of this application process

name
required
string (Name)

The name of the application process

award_id
required
string (Award)

The id of the award

customer_type
required
string (Customer Type)

The type of customer that can complete this process

Enum: "contact" "organization"
requires_nomination
boolean (Requires Nomination)

If set, a contact/organization must be nominated before submitting an application for this process

application_form_id
required
string (Application Form) /awards-applications__.*/

The application form

requires_fee
boolean (Requires Fee)

If true, then this process requires a fee and is associated with an order

fee_id
required
string (Fee)

The id of the associated fee

enable_references
boolean (Enable References)

If true, the references are enabled on this process

required
Array of objects non-empty

The reference requirements for this process

allow_applicants_to_update_information
boolean (Allow Applicants To Update Information)

If true, applicants can modify their applications in the portal

required
object (Application Update Options)
available_from
string <date-time> (Available From)

The date to start showing the process in the portal

available_until
string <date-time> (Available Until)

The date to stop showing the process in the portal

display_order
number <float> (Display Order)

The order to display

restrict_categories
boolean (Restrict Categories)

Should processes be restricted to specific categories

category_ids
required
Array of strings (Categories) non-empty

The categories to which the process is restricted

show_contact_form
boolean (Show Contact Form)

Whether or not to show a contact form

required
object (Contact Form Options)
show_organization_form
boolean (Show Organization Form)

Whether or not to show an organization form

required
object (Organization Form Options)
display_in_portal
boolean (Display In Portal)

Whether or not to hide in the portal

display_in_portal_as
string (Display In Portal As)

How to display this process in the portal

is_active
boolean (Is Active)

Whether or not this process is active

override_checkout_settings
boolean (Override Checkout Settings)

Whether or not to override POC settings

required
object (Checkout Settings)
enable_confirmation_email
boolean (Enable Confirmation Email)

Should the process send out confirmation emails

required
object (Confirmation Email)

The email to send

enable_eligibility_criteria
boolean (Enable Eligibility Criteria)

Should allow eligibility criteria

eligibility_criteria
required
object (Eligibility Criteria)

The criteria for eligibility

sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

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

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

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

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

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

sys_has_files_in_s3
boolean (Sys Has Files In S3)

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

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The application process was updated successfully.
400The application process supplied was not valid.
401Unauthorized.
403Forbidden.
404The application process could not be found.
409The application process could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve application process based on tenant limits.
500General server error.
put/applicationProcesses/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "award_id": "string",
  • "customer_type": "contact",
  • "requires_nomination": true,
  • "application_form_id": "string",
  • "requires_fee": true,
  • "fee_id": "string",
  • "enable_references": true,
  • "reference_requirements": [
    ],
  • "allow_applicants_to_update_information": true,
  • "application_update_options": {
    },
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "display_order": 0,
  • "restrict_categories": true,
  • "category_ids": [
    ],
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "display_in_portal": true,
  • "display_in_portal_as": "string",
  • "is_active": true,
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "enable_eligibility_criteria": true,
  • "eligibility_criteria": { },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "award_id": "string",
  • "customer_type": "contact",
  • "requires_nomination": true,
  • "application_form_id": "string",
  • "requires_fee": true,
  • "fee_id": "string",
  • "enable_references": true,
  • "reference_requirements": [
    ],
  • "allow_applicants_to_update_information": true,
  • "application_update_options": {
    },
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "display_order": 0,
  • "restrict_categories": true,
  • "category_ids": [
    ],
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "display_in_portal": true,
  • "display_in_portal_as": "string",
  • "is_active": true,
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "enable_eligibility_criteria": true,
  • "eligibility_criteria": { },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a application process with the specified ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application process to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The application process was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The application process could not be found.
409The application process could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve application process based on tenant limits.
500General server error.
patch/applicationProcesses/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "award_id": "string",
  • "customer_type": "contact",
  • "requires_nomination": true,
  • "application_form_id": "string",
  • "requires_fee": true,
  • "fee_id": "string",
  • "enable_references": true,
  • "reference_requirements": [
    ],
  • "allow_applicants_to_update_information": true,
  • "application_update_options": {
    },
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "display_order": 0,
  • "restrict_categories": true,
  • "category_ids": [
    ],
  • "show_contact_form": true,
  • "contact_form_options": {
    },
  • "show_organization_form": true,
  • "organization_form_options": {
    },
  • "display_in_portal": true,
  • "display_in_portal_as": "string",
  • "is_active": true,
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_confirmation_email": true,
  • "confirmation_email": {
    },
  • "enable_eligibility_criteria": true,
  • "eligibility_criteria": { },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a application process from the system by its ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application process to delete.

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

Returns a list of records with the specified award_id

Returns a list of records with the specified award_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

award_id
required
string

The award_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/applicationProcesses/{tenantId}/award/{award_id}
Request samples
curl -i -X GET \
  'https://awards.api.756794052567.rhythmsoftware.com/applicationProcesses/:tenantId/award/:award_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Gets all of the processes a contact/org is eligible to use

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

awardId
required
string

The award

customerType
required
string

The contact or organization type

Enum: "contact" "organization"
contactOrOrganizationId
required
string

The contact or organization id

Responses
200Processes were retrieved successfully
400The request was not valid
401Unauthorized
403Forbidden
404The resource could not be found
429Request limit exceeded... please try your request again in a few seconds
500An internal server error occured.
get/applicationProcesses/{tenantId}/eligible/{awardId}/{customerType}/{contactOrOrganizationId}
Request samples
curl -i -X GET \
  https://awards.api.756794052567.rhythmsoftware.com/applicationProcesses/:tenantId/eligible/:awardId/:customerType/:contactOrOrganizationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Execute Batch Operations

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The application process could not be found.
429Limit exceeded... unable to retrieve application process based on tenant limits.
500General server error.
post/applicationProcesses/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}