Activities

Creates a new activity record that does not already exist.

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

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this activity
contact_id required	string (Contact) The owner of the activity
name required	string (Name) Name of the activity
type_id required	string (Type) The type of activity
additional_details	string (Additional Details) Additional details
file_upload_uri	string (File Upload Uri) File upload for supporting documentation of the activity
quantity	number <float> (Quantity) If applicable, quantity associated with the activity
	Array of objects
total_number_of_credits	number <double> (Total Number Of Credits) The total # of credits
date required	string (Date) Date of the activity
process_id	string (Process) The reporting process
status	string (Status) Enum: "draft" "processed" "under review" "verified"
processed_date	string <date-time> (Processed Date) The date the activity was processed
	Array of objects (Custom Field Values)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The activity was saved successfully.

400The activity you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The activity could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add activity based on tenant limits.

500General server error.

post/activities/{tenantId}

Request samples

application/json

{"id": "string",
"contact_id": "string",
"name": "string",
"type_id": "string",
"additional_details": "string",
"file_upload_uri": "string",
"quantity": 0,
"credits": [{"credit_type_id": "string",
"quantity": 0
}
],
"total_number_of_credits": 0,
"date": "string",
"process_id": "string",
"status": "draft",
"processed_date": "2019-08-24T14:15:22Z",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"contact_id": "string",
"name": "string",
"type_id": "string",
"additional_details": "string",
"file_upload_uri": "string",
"quantity": 0,
"credits": [{"credit_type_id": "string",
"quantity": 0
}
],
"total_number_of_credits": 0,
"date": "string",
"process_id": "string",
"status": "draft",
"processed_date": "2019-08-24T14:15:22Z",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Gets all of the activities in the system.

This method will scan all activities and and return them to the caller.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
exclusiveStartKey	string The start key, if you're making a subsequent request

Responses

200The activitieswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

429Limit exceeded... unable to add contact role based on tenant limits.

500General server error.

get/activities/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/activities/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"contact_id": "string",
"name": "string",
"type_id": "string",
"additional_details": "string",
"file_upload_uri": "string",
"quantity": 0,
"credits": [{"credit_type_id": "string",
"quantity": 0
}
],
"total_number_of_credits": 0,
"date": "string",
"process_id": "string",
"status": "draft",
"processed_date": "2019-08-24T14:15:22Z",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
]

Returns a activity from the system by its ID.

This method will look up a activity 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 activity 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 activity was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The activity could not be found.

429Limit exceeded... unable to retrieve activity based on tenant limits.

500General server error.

get/activities/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/activities/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"contact_id": "string",
"name": "string",
"type_id": "string",
"additional_details": "string",
"file_upload_uri": "string",
"quantity": 0,
"credits": [{"credit_type_id": "string",
"quantity": 0
}
],
"total_number_of_credits": 0,
"date": "string",
"process_id": "string",
"status": "draft",
"processed_date": "2019-08-24T14:15:22Z",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Updates a activity with the specified ID.

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

Request Body schema: application/json

The updated activity that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this activity
contact_id required	string (Contact) The owner of the activity
name required	string (Name) Name of the activity
type_id required	string (Type) The type of activity
additional_details	string (Additional Details) Additional details
file_upload_uri	string (File Upload Uri) File upload for supporting documentation of the activity
quantity	number <float> (Quantity) If applicable, quantity associated with the activity
	Array of objects
total_number_of_credits	number <double> (Total Number Of Credits) The total # of credits
date required	string (Date) Date of the activity
process_id	string (Process) The reporting process
status	string (Status) Enum: "draft" "processed" "under review" "verified"
processed_date	string <date-time> (Processed Date) The date the activity was processed
	Array of objects (Custom Field Values)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The activity was updated successfully.

400The activity supplied was not valid.

401Unauthorized.

403Forbidden.

404The activity could not be found.

409The activity could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve activity based on tenant limits.

500General server error.

put/activities/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"contact_id": "string",
"name": "string",
"type_id": "string",
"additional_details": "string",
"file_upload_uri": "string",
"quantity": 0,
"credits": [{"credit_type_id": "string",
"quantity": 0
}
],
"total_number_of_credits": 0,
"date": "string",
"process_id": "string",
"status": "draft",
"processed_date": "2019-08-24T14:15:22Z",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"contact_id": "string",
"name": "string",
"type_id": "string",
"additional_details": "string",
"file_upload_uri": "string",
"quantity": 0,
"credits": [{"credit_type_id": "string",
"quantity": 0
}
],
"total_number_of_credits": 0,
"date": "string",
"process_id": "string",
"status": "draft",
"processed_date": "2019-08-24T14:15:22Z",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Partially updates a activity with the specified ID.

This method will patch an existing activity 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 activity 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 activity was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The activity could not be found.

409The activity could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve activity based on tenant limits.

500General server error.

patch/activities/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"contact_id": "string",
"name": "string",
"type_id": "string",
"additional_details": "string",
"file_upload_uri": "string",
"quantity": 0,
"credits": [{"credit_type_id": "string",
"quantity": 0
}
],
"total_number_of_credits": 0,
"date": "string",
"process_id": "string",
"status": "draft",
"processed_date": "2019-08-24T14:15:22Z",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}

Returns a activity from the system by its ID.

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

Responses

200The activity was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The activity could not be found.

409The activity could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete activity based on tenant limits.

500General server error.

delete/activities/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://certifications.api.756794052567.rhythmsoftware.com/activities/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Returns a list of records with the specified contact_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
contact_id required	string The contact_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/activities/{tenantId}/contact/{contact_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/activities/:tenantId/contact/:contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"contact_id": "string",
"name": "string",
"type_id": "string",
"additional_details": "string",
"file_upload_uri": "string",
"quantity": 0,
"credits": [{"credit_type_id": "string",
"quantity": 0
}
],
"total_number_of_credits": 0,
"date": "string",
"process_id": "string",
"status": "draft",
"processed_date": "2019-08-24T14:15:22Z",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Processes an existing acitivty

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The id of the activity to process

Responses

200The members was retrieved successfully

400The members supplied was not valid.

401Unauthorized

403Forbidden

404The members could not be found.

429Request limit exceeded... please try your request again in a few seconds

500General server error.

put/activities/{tenantId}/process/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X PUT \
  https://certifications.api.756794052567.rhythmsoftware.com/activities/:tenantId/process/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Searches for activities using predefined parameters

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

exclusiveStartKey	string The start key for the search, for paging support
fieldsToReturn	string The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The activity that you would like to be saved.

ids	Array of strings (Ids) IDs to search
name	string (Name)
type_id	Array of strings (Type)
quantity	Array of numbers <float> (Quantity) 2 items
total_number_of_credits	Array of numbers <float> (Total Number Of Credits) 2 items
date	Array of strings <date-time> (Date) 2 items
status	Array of strings (Status) 2 items
processed_date	Array of strings <date-time> (Processed Date)
sys_created_at	Array of strings <date-time> (Sys Created At) 2 items

Responses

200The activity search was saved successfully.

400The activity you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The activity could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add activity based on tenant limits.

500General server error.

post/activities/{tenantId}/search

Request samples

application/json

{"ids": ["string"
],
"name": "string",
"type_id": ["string"
],
"quantity": [0,
0
],
"total_number_of_credits": [0,
0
],
"date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"status": ["string",
"string"
],
"processed_date": ["2019-08-24T14:15:22Z"
],
"sys_created_at": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
]
}

Response samples

application/json

{"Items": [{"id": "string",
"contact_id": "string",
"name": "string",
"type_id": "string",
"additional_details": "string",
"file_upload_uri": "string",
"quantity": 0,
"credits": [{"credit_type_id": "string",
"quantity": 0
}
],
"total_number_of_credits": 0,
"date": "string",
"process_id": "string",
"status": "draft",
"processed_date": "2019-08-24T14:15:22Z",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Sends out a preview of the CRC notification email

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

activity_id	string (Activity)
	object (Email Template)
destination_email_address required	string (Destination Email Address)
reference_id	string (Reference)
application_id	string (Application)
certification_id	string (Certification)
registration_id required	string (Registration)

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

post/activities/{tenantId}/previewEmail

Request samples

application/json

{"activity_id": "string",
"email_template": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"destination_email_address": "string",
"reference_id": "string",
"application_id": "string",
"certification_id": "string",
"registration_id": "string"
}

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 activity could not be found.

429Limit exceeded... unable to retrieve activity based on tenant limits.

500General server error.

post/activities/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}