Platform

Platform (v1-2025-04-18)

The Platform API contains tenant level configuration and settings used throughout Rhythm. This includes Saved Queries, Custom Fields, and Forms.

Download OpenAPI description

platform-v1.json

platform-v1.yaml

Servers

Mock server

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

https://platform.api.rhythmsoftware.com/

360 Screens

Operations

Custom Fields

Operations

Custom Objects

Operations

Custom Query Definitions

Operations

Custom Record Actions

Operations

Customization Config Settings

Operations

Directory Entry Comments

Operations

Email Activities

Operations

Email Integrations

Operations

File Uploads

Operations

Page Layouts

Operations

Query Delivery Schedules

Operations

Creates a new query delivery schedule record that does not already exist.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The query delivery schedule that you would like to be saved.

applicationstring(Application)required

The application of the saved query

context_idstring(Context)

If applicable, the context of the saved query

do_not_send_empty_resultsboolean(Do Not Send Empty Results)

Dont send this email if there are no rows

emailobject(Email)

The optional HTML body of the email

email_addressesArray of strings(email)(Email Addresses)non-emptyrequired

The email addresses that should receive the schedule query

end_datestring(date-time)(End Date)

The end date of the delivery

errors_since_last_runnumber(float)(Errors Since Last Run)

The number of errors that have occurred since the last successful run of this schedule

human_readable_schedulestring(Human Readable Schedule)

A human readable schedule for display

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

The unique, string identifier of this query delivery schedule

is_activeboolean(Is Active)

Whether or not this query delivery schedule is active

last_errorstring(Last Error)

The last error on this process

last_error_datestring(date-time)(Last Error Date)

The last time this process encountered an error

last_run_datestring(date-time)(Last Run Date)

The last time this process was run

namestring(Name)required

The name of the query delivery schedule

output_formatstring(Output Format)

The format for the report

Enum"csv""excel""excelUnformatted""json"

saved_query_idstring(Saved Query)required

The saved query being run

schedulestring(Schedule)required

The schedule which defines how often the batch should be created

start_datestring(date-time)(Start Date)

The start date of the delivery

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_next_processing_datestring(date-time)(Sys Next Processing Date)

Internal system field, do not modify

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

typestring(Type)required

The query type

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/queryDeliverySchedules/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application": "string",
    "context_id": "string",
    "do_not_send_empty_results": true,
    "email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "email_addresses": [
      "user@example.com"
    ],
    "end_date": "2019-08-24T14:15:22Z",
    "errors_since_last_run": 0.1,
    "human_readable_schedule": "string",
    "id": "string",
    "is_active": true,
    "last_error": "string",
    "last_error_date": "2019-08-24T14:15:22Z",
    "last_run_date": "2019-08-24T14:15:22Z",
    "name": "string",
    "output_format": "csv",
    "saved_query_id": "string",
    "schedule": "string",
    "start_date": "2019-08-24T14:15:22Z",
    "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_next_processing_date": "2019-08-24T14:15:22Z",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "string"
  }'

Responses

The query delivery schedule was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)required

The application of the saved query

context_idstring(Context)

If applicable, the context of the saved query

do_not_send_empty_resultsboolean(Do Not Send Empty Results)

Dont send this email if there are no rows

emailobject(Email)

The optional HTML body of the email

email_addressesArray of strings(email)(Email Addresses)non-emptyrequired

The email addresses that should receive the schedule query

end_datestring(date-time)(End Date)

The end date of the delivery

errors_since_last_runnumber(float)(Errors Since Last Run)

The number of errors that have occurred since the last successful run of this schedule

human_readable_schedulestring(Human Readable Schedule)

A human readable schedule for display

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

The unique, string identifier of this query delivery schedule

is_activeboolean(Is Active)

Whether or not this query delivery schedule is active

last_errorstring(Last Error)

The last error on this process

last_error_datestring(date-time)(Last Error Date)

The last time this process encountered an error

last_run_datestring(date-time)(Last Run Date)

The last time this process was run

namestring(Name)required

The name of the query delivery schedule

output_formatstring(Output Format)

The format for the report

Enum"csv""excel""excelUnformatted""json"

saved_query_idstring(Saved Query)required

The saved query being run

schedulestring(Schedule)required

The schedule which defines how often the batch should be created

start_datestring(date-time)(Start Date)

The start date of the delivery

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_next_processing_datestring(date-time)(Sys Next Processing Date)

Internal system field, do not modify

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

typestring(Type)required

The query type

Response

application/json

{
  "application": "string",
  "context_id": "string",
  "do_not_send_empty_results": true,
  "email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "email_addresses": [
    "user@example.com"
  ],
  "end_date": "2019-08-24T14:15:22Z",
  "errors_since_last_run": 0.1,
  "human_readable_schedule": "string",
  "id": "string",
  "is_active": true,
  "last_error": "string",
  "last_error_date": "2019-08-24T14:15:22Z",
  "last_run_date": "2019-08-24T14:15:22Z",
  "name": "string",
  "output_format": "csv",
  "saved_query_id": "string",
  "schedule": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "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_next_processing_date": "2019-08-24T14:15:22Z",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "string"
}

Returns a list of records with the specified application_context_id

Request

Returns a list of records with the specified application_context_id

Path

tenantIdstringrequired

The tenant

applicationstringrequired

The application to use to for record lookup

contextIdstringrequired

The context ID; use "all" if no context

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/platform/platform-v1/queryDeliverySchedules/{tenantId}/applicationContext/{application}/{contextId}?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(QueryDeliverySchedule)

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/platform/platform-v1/queryDeliverySchedules/{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
}

Immediately processes a delivery schedule

Request

Immediately processes a delivery schedule

Path

tenantIdstringrequired

The tenant

scheduleIdstringrequired

The application to use to for record lookup

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/queryDeliverySchedules/{tenantId}/process/{scheduleId}' \
  -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

Immediately processes a delivery schedule

Request

Immediately processes a delivery schedule

Path

tenantIdstringrequired

The tenant

scheduleIdstringrequired

The application to use to for record lookup

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/queryDeliverySchedules/{tenantId}/processWithStepFunction/{scheduleId}' \
  -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

Returns a query delivery schedule from the system by its ID.

Request

This method will delete a query delivery schedule with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the query delivery schedule to delete.

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

Responses

The query delivery schedule 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 query delivery schedule from the system by its ID.

Request

This method will look up a query delivery schedule by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the query delivery schedule 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/platform/platform-v1/queryDeliverySchedules/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The query delivery schedule was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)required

The application of the saved query

context_idstring(Context)

If applicable, the context of the saved query

do_not_send_empty_resultsboolean(Do Not Send Empty Results)

Dont send this email if there are no rows

emailobject(Email)

The optional HTML body of the email

email_addressesArray of strings(email)(Email Addresses)non-emptyrequired

The email addresses that should receive the schedule query

end_datestring(date-time)(End Date)

The end date of the delivery

errors_since_last_runnumber(float)(Errors Since Last Run)

The number of errors that have occurred since the last successful run of this schedule

human_readable_schedulestring(Human Readable Schedule)

A human readable schedule for display

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

The unique, string identifier of this query delivery schedule

is_activeboolean(Is Active)

Whether or not this query delivery schedule is active

last_errorstring(Last Error)

The last error on this process

last_error_datestring(date-time)(Last Error Date)

The last time this process encountered an error

last_run_datestring(date-time)(Last Run Date)

The last time this process was run

namestring(Name)required

The name of the query delivery schedule

output_formatstring(Output Format)

The format for the report

Enum"csv""excel""excelUnformatted""json"

saved_query_idstring(Saved Query)required

The saved query being run

schedulestring(Schedule)required

The schedule which defines how often the batch should be created

start_datestring(date-time)(Start Date)

The start date of the delivery

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_next_processing_datestring(date-time)(Sys Next Processing Date)

Internal system field, do not modify

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

typestring(Type)required

The query type

Response

application/json

{
  "application": "string",
  "context_id": "string",
  "do_not_send_empty_results": true,
  "email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "email_addresses": [
    "user@example.com"
  ],
  "end_date": "2019-08-24T14:15:22Z",
  "errors_since_last_run": 0.1,
  "human_readable_schedule": "string",
  "id": "string",
  "is_active": true,
  "last_error": "string",
  "last_error_date": "2019-08-24T14:15:22Z",
  "last_run_date": "2019-08-24T14:15:22Z",
  "name": "string",
  "output_format": "csv",
  "saved_query_id": "string",
  "schedule": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "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_next_processing_date": "2019-08-24T14:15:22Z",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "string"
}

Partially updates a query delivery schedule with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The query delivery schedule was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)required

The application of the saved query

context_idstring(Context)

If applicable, the context of the saved query

do_not_send_empty_resultsboolean(Do Not Send Empty Results)

Dont send this email if there are no rows

emailobject(Email)

The optional HTML body of the email

email_addressesArray of strings(email)(Email Addresses)non-emptyrequired

The email addresses that should receive the schedule query

end_datestring(date-time)(End Date)

The end date of the delivery

errors_since_last_runnumber(float)(Errors Since Last Run)

The number of errors that have occurred since the last successful run of this schedule

human_readable_schedulestring(Human Readable Schedule)

A human readable schedule for display

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

The unique, string identifier of this query delivery schedule

is_activeboolean(Is Active)

Whether or not this query delivery schedule is active

last_errorstring(Last Error)

The last error on this process

last_error_datestring(date-time)(Last Error Date)

The last time this process encountered an error

last_run_datestring(date-time)(Last Run Date)

The last time this process was run

namestring(Name)required

The name of the query delivery schedule

output_formatstring(Output Format)

The format for the report

Enum"csv""excel""excelUnformatted""json"

saved_query_idstring(Saved Query)required

The saved query being run

schedulestring(Schedule)required

The schedule which defines how often the batch should be created

start_datestring(date-time)(Start Date)

The start date of the delivery

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_next_processing_datestring(date-time)(Sys Next Processing Date)

Internal system field, do not modify

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

typestring(Type)required

The query type

Response

application/json

{
  "application": "string",
  "context_id": "string",
  "do_not_send_empty_results": true,
  "email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "email_addresses": [
    "user@example.com"
  ],
  "end_date": "2019-08-24T14:15:22Z",
  "errors_since_last_run": 0.1,
  "human_readable_schedule": "string",
  "id": "string",
  "is_active": true,
  "last_error": "string",
  "last_error_date": "2019-08-24T14:15:22Z",
  "last_run_date": "2019-08-24T14:15:22Z",
  "name": "string",
  "output_format": "csv",
  "saved_query_id": "string",
  "schedule": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "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_next_processing_date": "2019-08-24T14:15:22Z",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "string"
}

Updates a query delivery schedule with the specified ID.

Request

This method will update an existing query delivery schedule with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the query delivery schedule to update.

Bodyapplication/jsonrequired

The updated query delivery schedule that will be saved.

applicationstring(Application)required

The application of the saved query

context_idstring(Context)

If applicable, the context of the saved query

do_not_send_empty_resultsboolean(Do Not Send Empty Results)

Dont send this email if there are no rows

emailobject(Email)

The optional HTML body of the email

email_addressesArray of strings(email)(Email Addresses)non-emptyrequired

The email addresses that should receive the schedule query

end_datestring(date-time)(End Date)

The end date of the delivery

errors_since_last_runnumber(float)(Errors Since Last Run)

The number of errors that have occurred since the last successful run of this schedule

human_readable_schedulestring(Human Readable Schedule)

A human readable schedule for display

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

The unique, string identifier of this query delivery schedule

is_activeboolean(Is Active)

Whether or not this query delivery schedule is active

last_errorstring(Last Error)

The last error on this process

last_error_datestring(date-time)(Last Error Date)

The last time this process encountered an error

last_run_datestring(date-time)(Last Run Date)

The last time this process was run

namestring(Name)required

The name of the query delivery schedule

output_formatstring(Output Format)

The format for the report

Enum"csv""excel""excelUnformatted""json"

saved_query_idstring(Saved Query)required

The saved query being run

schedulestring(Schedule)required

The schedule which defines how often the batch should be created

start_datestring(date-time)(Start Date)

The start date of the delivery

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_next_processing_datestring(date-time)(Sys Next Processing Date)

Internal system field, do not modify

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

typestring(Type)required

The query type

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/queryDeliverySchedules/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application": "string",
    "context_id": "string",
    "do_not_send_empty_results": true,
    "email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "email_addresses": [
      "user@example.com"
    ],
    "end_date": "2019-08-24T14:15:22Z",
    "errors_since_last_run": 0.1,
    "human_readable_schedule": "string",
    "id": "string",
    "is_active": true,
    "last_error": "string",
    "last_error_date": "2019-08-24T14:15:22Z",
    "last_run_date": "2019-08-24T14:15:22Z",
    "name": "string",
    "output_format": "csv",
    "saved_query_id": "string",
    "schedule": "string",
    "start_date": "2019-08-24T14:15:22Z",
    "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_next_processing_date": "2019-08-24T14:15:22Z",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "string"
  }'

Responses

The query delivery schedule was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)required

The application of the saved query

context_idstring(Context)

If applicable, the context of the saved query

do_not_send_empty_resultsboolean(Do Not Send Empty Results)

Dont send this email if there are no rows

emailobject(Email)

The optional HTML body of the email

email_addressesArray of strings(email)(Email Addresses)non-emptyrequired

The email addresses that should receive the schedule query

end_datestring(date-time)(End Date)

The end date of the delivery

errors_since_last_runnumber(float)(Errors Since Last Run)

The number of errors that have occurred since the last successful run of this schedule

human_readable_schedulestring(Human Readable Schedule)

A human readable schedule for display

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

The unique, string identifier of this query delivery schedule

is_activeboolean(Is Active)

Whether or not this query delivery schedule is active

last_errorstring(Last Error)

The last error on this process

last_error_datestring(date-time)(Last Error Date)

The last time this process encountered an error

last_run_datestring(date-time)(Last Run Date)

The last time this process was run

namestring(Name)required

The name of the query delivery schedule

output_formatstring(Output Format)

The format for the report

Enum"csv""excel""excelUnformatted""json"

saved_query_idstring(Saved Query)required

The saved query being run

schedulestring(Schedule)required

The schedule which defines how often the batch should be created

start_datestring(date-time)(Start Date)

The start date of the delivery

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_next_processing_datestring(date-time)(Sys Next Processing Date)

Internal system field, do not modify

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

typestring(Type)required

The query type

Response

application/json

{
  "application": "string",
  "context_id": "string",
  "do_not_send_empty_results": true,
  "email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "email_addresses": [
    "user@example.com"
  ],
  "end_date": "2019-08-24T14:15:22Z",
  "errors_since_last_run": 0.1,
  "human_readable_schedule": "string",
  "id": "string",
  "is_active": true,
  "last_error": "string",
  "last_error_date": "2019-08-24T14:15:22Z",
  "last_run_date": "2019-08-24T14:15:22Z",
  "name": "string",
  "output_format": "csv",
  "saved_query_id": "string",
  "schedule": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "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_next_processing_date": "2019-08-24T14:15:22Z",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "string"
}

Query User Profiles

Operations

Record Alert Rule Sets

Operations

Record Alerts

Operations

Saved Queries

Operations

Saved Reports

Operations

Saved Searches

Operations

Service Configurations

Operations

Service Metadata

Operations

Task Assignment Roles

Operations

Task Queues

Operations

Task Types

Operations

Tasks

Operations

Web Form Drafts

Operations

Web Forms

Operations

Workflows

Operations

Platform (v1-2025-04-18)

360 Screens

Custom Fields

Custom Objects

Custom Query Definitions

Custom Record Actions

Customization Config Settings

Directory Entry Comments

Email Activities

Email Integrations

File Uploads

Page Layouts

Query Delivery Schedules

Creates a new query delivery schedule record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified application_context_id

Request

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Immediately processes a delivery schedule

Request

Responses

Was this helpful?

Immediately processes a delivery schedule

Request

Responses

Was this helpful?

Returns a query delivery schedule from the system by its ID.

Request

Responses

Was this helpful?

Returns a query delivery schedule from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a query delivery schedule with the specified ID.

Request

Responses

Was this helpful?

Updates a query delivery schedule with the specified ID.

RequestExpand all

Responses

Was this helpful?

Query User Profiles

Record Alert Rule Sets

Record Alerts

Saved Queries

Saved Reports

Saved Searches

Service Configurations

Service Metadata

Task Assignment Roles

Task Queues

Task Types

Tasks

Web Form Drafts

Web Forms

Workflows

Request

Request

Request