Platform

Gets all of the custom query definitions in the system.

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

Gets all of the custom query definitions in the system.

Request

This method will scan all custom query definitions and and return them to the caller.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

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

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customQueryDefinitions/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The custom query definitionswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

applicationstring(Application)required

custom_field_valuesArray of objects(Custom Field Values)

definitionobject(Definition)required

The query definition

definition.common_table_expressionsArray of objects

definition.contextobject(Context)

definition.default_output_fieldsArray of objectsnon-emptyrequired

definition.default_output_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_output_fields[].labelstring(Label)

definition.default_output_fields[].namestring(Name)required

definition.default_sort_fieldsArray of objectsnon-emptyrequired

definition.default_sort_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_sort_fields[].descendingboolean(Descending)

definition.default_sort_fields[].namestring(Name)required

definition.descriptionstring(Description)

definition.fieldsArray of objects

definition.idstring(ID)

definition.namestring(Name)

definition.perform_custom_resolution_logicboolean(Perform Custom Resolution Logic)

If set, the microservice must post process the query before it is completely resolves

definition.primary_tablestring(Primary Table)required

definition.servicesArray of objects

descriptionstring(Description)

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

The unique, string identifier of this custom query definition

is_activeboolean(Is Active)

Whether or not this custom query definition is active

namestring(Name)required

The name of the custom query definition

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

]

Response

application/json

[
  {
    "application": "string",
    "custom_field_values": [ … ],
    "definition": { … },
    "description": "string",
    "id": "string",
    "is_active": true,
    "name": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }
]

Creates a new custom query definition record that does not already exist.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The custom query definition that you would like to be saved.

applicationstring(Application)required

custom_field_valuesArray of objects(Custom Field Values)

definitionobject(Definition)required

The query definition

definition.common_table_expressionsArray of objects

definition.contextobject(Context)

definition.default_output_fieldsArray of objectsnon-emptyrequired

definition.default_output_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_output_fields[].labelstring(Label)

definition.default_output_fields[].namestring(Name)required

definition.default_sort_fieldsArray of objectsnon-emptyrequired

definition.default_sort_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_sort_fields[].descendingboolean(Descending)

definition.default_sort_fields[].namestring(Name)required

definition.descriptionstring(Description)

definition.fieldsArray of objects

definition.idstring(ID)

definition.namestring(Name)

definition.perform_custom_resolution_logicboolean(Perform Custom Resolution Logic)

If set, the microservice must post process the query before it is completely resolves

definition.primary_tablestring(Primary Table)required

definition.servicesArray of objects

descriptionstring(Description)

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

The unique, string identifier of this custom query definition

is_activeboolean(Is Active)

Whether or not this custom query definition is active

namestring(Name)required

The name of the custom query definition

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customQueryDefinitions/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "definition": {
      "common_table_expressions": [
        {
          "alias": "string",
          "sql": "string"
        }
      ],
      "context": {
        "display_name": "string",
        "field": "string",
        "help_text": "string",
        "required": true,
        "service": "string"
      },
      "default_output_fields": [
        {
          "applies_when_context": "both",
          "label": "string",
          "name": "string"
        }
      ],
      "default_sort_fields": [
        {
          "applies_when_context": "both",
          "descending": true,
          "name": "string"
        }
      ],
      "description": "string",
      "fields": [
        {
          "acceptable_values": [
            {
              "hide_from_portal": true,
              "label": "string",
              "value": "string"
            }
          ],
          "custom_sql": "string",
          "database_column": "string",
          "group_name": "string",
          "label": "string",
          "name": "string",
          "reference_service": "string",
          "service": "string",
          "table_alias": "string",
          "type": "string"
        }
      ],
      "id": "string",
      "name": "string",
      "perform_custom_resolution_logic": true,
      "primary_table": "string",
      "services": [
        {
          "group_name": "string",
          "hints": {},
          "id_column": "string",
          "join_fragment": null,
          "service": "string",
          "table": "string",
          "table_alias": "string"
        }
      ]
    },
    "description": "string",
    "id": "string",
    "is_active": true,
    "name": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The custom query definition was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)required

custom_field_valuesArray of objects(Custom Field Values)

definitionobject(Definition)required

The query definition

definition.common_table_expressionsArray of objects

definition.contextobject(Context)

definition.default_output_fieldsArray of objectsnon-emptyrequired

definition.default_output_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_output_fields[].labelstring(Label)

definition.default_output_fields[].namestring(Name)required

definition.default_sort_fieldsArray of objectsnon-emptyrequired

definition.default_sort_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_sort_fields[].descendingboolean(Descending)

definition.default_sort_fields[].namestring(Name)required

definition.descriptionstring(Description)

definition.fieldsArray of objects

definition.idstring(ID)

definition.namestring(Name)

definition.perform_custom_resolution_logicboolean(Perform Custom Resolution Logic)

If set, the microservice must post process the query before it is completely resolves

definition.primary_tablestring(Primary Table)required

definition.servicesArray of objects

descriptionstring(Description)

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

The unique, string identifier of this custom query definition

is_activeboolean(Is Active)

Whether or not this custom query definition is active

namestring(Name)required

The name of the custom query definition

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "application": "string",
  "custom_field_values": [
    { … }
  ],
  "definition": {
    "common_table_expressions": [ … ],
    "context": { … },
    "default_output_fields": [ … ],
    "default_sort_fields": [ … ],
    "description": "string",
    "fields": [ … ],
    "id": "string",
    "name": "string",
    "perform_custom_resolution_logic": true,
    "primary_table": "string",
    "services": [ … ]
  },
  "description": "string",
  "id": "string",
  "is_active": true,
  "name": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

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/customQueryDefinitions/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a custom query definition from the system by its ID.

Request

This method will delete a custom query definition with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the custom query definition to delete.

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

Responses

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

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The custom query definition was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)required

custom_field_valuesArray of objects(Custom Field Values)

definitionobject(Definition)required

The query definition

definition.common_table_expressionsArray of objects

definition.contextobject(Context)

definition.default_output_fieldsArray of objectsnon-emptyrequired

definition.default_output_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_output_fields[].labelstring(Label)

definition.default_output_fields[].namestring(Name)required

definition.default_sort_fieldsArray of objectsnon-emptyrequired

definition.default_sort_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_sort_fields[].descendingboolean(Descending)

definition.default_sort_fields[].namestring(Name)required

definition.descriptionstring(Description)

definition.fieldsArray of objects

definition.idstring(ID)

definition.namestring(Name)

definition.perform_custom_resolution_logicboolean(Perform Custom Resolution Logic)

If set, the microservice must post process the query before it is completely resolves

definition.primary_tablestring(Primary Table)required

definition.servicesArray of objects

descriptionstring(Description)

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

The unique, string identifier of this custom query definition

is_activeboolean(Is Active)

Whether or not this custom query definition is active

namestring(Name)required

The name of the custom query definition

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "application": "string",
  "custom_field_values": [
    { … }
  ],
  "definition": {
    "common_table_expressions": [ … ],
    "context": { … },
    "default_output_fields": [ … ],
    "default_sort_fields": [ … ],
    "description": "string",
    "fields": [ … ],
    "id": "string",
    "name": "string",
    "perform_custom_resolution_logic": true,
    "primary_table": "string",
    "services": [ … ]
  },
  "description": "string",
  "id": "string",
  "is_active": true,
  "name": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Partially updates a custom query definition with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The custom query definition was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)required

custom_field_valuesArray of objects(Custom Field Values)

definitionobject(Definition)required

The query definition

definition.common_table_expressionsArray of objects

definition.contextobject(Context)

definition.default_output_fieldsArray of objectsnon-emptyrequired

definition.default_output_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_output_fields[].labelstring(Label)

definition.default_output_fields[].namestring(Name)required

definition.default_sort_fieldsArray of objectsnon-emptyrequired

definition.default_sort_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_sort_fields[].descendingboolean(Descending)

definition.default_sort_fields[].namestring(Name)required

definition.descriptionstring(Description)

definition.fieldsArray of objects

definition.idstring(ID)

definition.namestring(Name)

definition.perform_custom_resolution_logicboolean(Perform Custom Resolution Logic)

If set, the microservice must post process the query before it is completely resolves

definition.primary_tablestring(Primary Table)required

definition.servicesArray of objects

descriptionstring(Description)

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

The unique, string identifier of this custom query definition

is_activeboolean(Is Active)

Whether or not this custom query definition is active

namestring(Name)required

The name of the custom query definition

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "application": "string",
  "custom_field_values": [
    { … }
  ],
  "definition": {
    "common_table_expressions": [ … ],
    "context": { … },
    "default_output_fields": [ … ],
    "default_sort_fields": [ … ],
    "description": "string",
    "fields": [ … ],
    "id": "string",
    "name": "string",
    "perform_custom_resolution_logic": true,
    "primary_table": "string",
    "services": [ … ]
  },
  "description": "string",
  "id": "string",
  "is_active": true,
  "name": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Updates a custom query definition with the specified ID.

Request

This method will update an existing custom query definition with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the custom query definition to update.

Bodyapplication/jsonrequired

The updated custom query definition that will be saved.

applicationstring(Application)required

custom_field_valuesArray of objects(Custom Field Values)

definitionobject(Definition)required

The query definition

definition.common_table_expressionsArray of objects

definition.contextobject(Context)

definition.default_output_fieldsArray of objectsnon-emptyrequired

definition.default_output_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_output_fields[].labelstring(Label)

definition.default_output_fields[].namestring(Name)required

definition.default_sort_fieldsArray of objectsnon-emptyrequired

definition.default_sort_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_sort_fields[].descendingboolean(Descending)

definition.default_sort_fields[].namestring(Name)required

definition.descriptionstring(Description)

definition.fieldsArray of objects

definition.idstring(ID)

definition.namestring(Name)

definition.perform_custom_resolution_logicboolean(Perform Custom Resolution Logic)

If set, the microservice must post process the query before it is completely resolves

definition.primary_tablestring(Primary Table)required

definition.servicesArray of objects

descriptionstring(Description)

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

The unique, string identifier of this custom query definition

is_activeboolean(Is Active)

Whether or not this custom query definition is active

namestring(Name)required

The name of the custom query definition

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/customQueryDefinitions/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "definition": {
      "common_table_expressions": [
        {
          "alias": "string",
          "sql": "string"
        }
      ],
      "context": {
        "display_name": "string",
        "field": "string",
        "help_text": "string",
        "required": true,
        "service": "string"
      },
      "default_output_fields": [
        {
          "applies_when_context": "both",
          "label": "string",
          "name": "string"
        }
      ],
      "default_sort_fields": [
        {
          "applies_when_context": "both",
          "descending": true,
          "name": "string"
        }
      ],
      "description": "string",
      "fields": [
        {
          "acceptable_values": [
            {
              "hide_from_portal": true,
              "label": "string",
              "value": "string"
            }
          ],
          "custom_sql": "string",
          "database_column": "string",
          "group_name": "string",
          "label": "string",
          "name": "string",
          "reference_service": "string",
          "service": "string",
          "table_alias": "string",
          "type": "string"
        }
      ],
      "id": "string",
      "name": "string",
      "perform_custom_resolution_logic": true,
      "primary_table": "string",
      "services": [
        {
          "group_name": "string",
          "hints": {},
          "id_column": "string",
          "join_fragment": null,
          "service": "string",
          "table": "string",
          "table_alias": "string"
        }
      ]
    },
    "description": "string",
    "id": "string",
    "is_active": true,
    "name": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The custom query definition was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

applicationstring(Application)required

custom_field_valuesArray of objects(Custom Field Values)

definitionobject(Definition)required

The query definition

definition.common_table_expressionsArray of objects

definition.contextobject(Context)

definition.default_output_fieldsArray of objectsnon-emptyrequired

definition.default_output_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_output_fields[].labelstring(Label)

definition.default_output_fields[].namestring(Name)required

definition.default_sort_fieldsArray of objectsnon-emptyrequired

definition.default_sort_fields[].applies_when_contextstring(Applies When Context)

Enum"both""is given""is not given"

definition.default_sort_fields[].descendingboolean(Descending)

definition.default_sort_fields[].namestring(Name)required

definition.descriptionstring(Description)

definition.fieldsArray of objects

definition.idstring(ID)

definition.namestring(Name)

definition.perform_custom_resolution_logicboolean(Perform Custom Resolution Logic)

If set, the microservice must post process the query before it is completely resolves

definition.primary_tablestring(Primary Table)required

definition.servicesArray of objects

descriptionstring(Description)

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

The unique, string identifier of this custom query definition

is_activeboolean(Is Active)

Whether or not this custom query definition is active

namestring(Name)required

The name of the custom query definition

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "application": "string",
  "custom_field_values": [
    { … }
  ],
  "definition": {
    "common_table_expressions": [ … ],
    "context": { … },
    "default_output_fields": [ … ],
    "default_sort_fields": [ … ],
    "description": "string",
    "fields": [ … ],
    "id": "string",
    "name": "string",
    "perform_custom_resolution_logic": true,
    "primary_table": "string",
    "services": [ … ]
  },
  "description": "string",
  "id": "string",
  "is_active": true,
  "name": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

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

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

Gets all of the custom query definitions in the system.

Request

Responses

Was this helpful?

Creates a new custom query definition record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a custom query definition from the system by its ID.

Request

Responses

Was this helpful?

Returns a custom query definition from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a custom query definition with the specified ID.

Request

Responses

Was this helpful?

Updates a custom query definition with the specified ID.

RequestExpand all

Responses

Was this helpful?

Custom Record Actions

Customization Config Settings

Directory Entry Comments

Email Activities

Email Integrations

File Uploads

Page Layouts

Query Delivery Schedules

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