Recurring Batches

Recurring Batches

Creates a new recurring batch record that does not already exist.

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

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

The unique, string identifier of this recurring batch

name
required
string (Name)

The name of the recurring batch

description
string (Description)

The name of the recurring batch

business_unit_id
required
string (Business Unit)

The business unit that this batch is tied to

active_batch_id
string (Active Batch)

The current active batch for this recurrence

batch_id_template
string (Batch Id Template)

The optional pattern for IDs for batches generated

batch_name_template
required
string (Batch Name Template)

The naming pattern for batches generated

Array of objects (Custom Field Values)
sys_suppress_new_batch_creation
boolean (Sys Suppress New Batch Creation)

If true, a new batch is not created

schedule
required
string (Schedule)

The schedule which defines how often the batch should be created

human_readable_schedule
string (Human Readable Schedule)

A human readable schedule for display

sys_next_processing_date
string <date-time> (Sys Next Processing Date)

Internal system field, do not modify

last_run_date
string <date-time> (Last Run Date)

The last time this process was run

last_error
string (Last Error)

The last error on this process

is_active
boolean (Is Active)

Whether this process is active

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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

Responses
200The recurring batch was saved successfully.
400The recurring batch you supplied was invalid.
401Unauthorized.
403Forbidden.
409The recurring batch could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add recurring batch based on tenant limits.
500General server error.
post/recurringBatches/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "business_unit_id": "string",
  • "active_batch_id": "string",
  • "batch_id_template": "string",
  • "batch_name_template": "string",
  • "custom_field_values": [
    ],
  • "sys_suppress_new_batch_creation": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "is_active": true,
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "business_unit_id": "string",
  • "active_batch_id": "string",
  • "batch_id_template": "string",
  • "batch_name_template": "string",
  • "custom_field_values": [
    ],
  • "sys_suppress_new_batch_creation": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "is_active": true,
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Gets all of the recurring batches in the system.

This method will scan all recurring batches 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 recurring batcheswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/recurringBatches/{tenantId}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/recurringBatches/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a recurring batch from the system by its ID.

This method will look up a recurring batch 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 recurring batch 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 recurring batch was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The recurring batch could not be found.
429Limit exceeded... unable to retrieve recurring batch based on tenant limits.
500General server error.
get/recurringBatches/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/recurringBatches/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "business_unit_id": "string",
  • "active_batch_id": "string",
  • "batch_id_template": "string",
  • "batch_name_template": "string",
  • "custom_field_values": [
    ],
  • "sys_suppress_new_batch_creation": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "is_active": true,
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Updates a recurring batch with the specified ID.

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

Request Body schema: application/json

The updated recurring batch that will be saved.

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

The unique, string identifier of this recurring batch

name
required
string (Name)

The name of the recurring batch

description
string (Description)

The name of the recurring batch

business_unit_id
required
string (Business Unit)

The business unit that this batch is tied to

active_batch_id
string (Active Batch)

The current active batch for this recurrence

batch_id_template
string (Batch Id Template)

The optional pattern for IDs for batches generated

batch_name_template
required
string (Batch Name Template)

The naming pattern for batches generated

Array of objects (Custom Field Values)
sys_suppress_new_batch_creation
boolean (Sys Suppress New Batch Creation)

If true, a new batch is not created

schedule
required
string (Schedule)

The schedule which defines how often the batch should be created

human_readable_schedule
string (Human Readable Schedule)

A human readable schedule for display

sys_next_processing_date
string <date-time> (Sys Next Processing Date)

Internal system field, do not modify

last_run_date
string <date-time> (Last Run Date)

The last time this process was run

last_error
string (Last Error)

The last error on this process

is_active
boolean (Is Active)

Whether this process is active

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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

Responses
200The recurring batch was updated successfully.
400The recurring batch supplied was not valid.
401Unauthorized.
403Forbidden.
404The recurring batch could not be found.
409The recurring batch could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve recurring batch based on tenant limits.
500General server error.
put/recurringBatches/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "business_unit_id": "string",
  • "active_batch_id": "string",
  • "batch_id_template": "string",
  • "batch_name_template": "string",
  • "custom_field_values": [
    ],
  • "sys_suppress_new_batch_creation": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "is_active": true,
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "business_unit_id": "string",
  • "active_batch_id": "string",
  • "batch_id_template": "string",
  • "batch_name_template": "string",
  • "custom_field_values": [
    ],
  • "sys_suppress_new_batch_creation": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "is_active": true,
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Partially updates a recurring batch with the specified ID.

This method will patch an existing recurring batch 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 recurring batch 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 recurring batch was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The recurring batch could not be found.
409The recurring batch could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve recurring batch based on tenant limits.
500General server error.
patch/recurringBatches/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "business_unit_id": "string",
  • "active_batch_id": "string",
  • "batch_id_template": "string",
  • "batch_name_template": "string",
  • "custom_field_values": [
    ],
  • "sys_suppress_new_batch_creation": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "is_active": true,
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Returns a recurring batch from the system by its ID.

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

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