System
/
Queries
/
Starts a new query and returns the query id and info

System (v1-2025-04-18)

The System API is different from the other Rhythm apps because it is not focused on a specific area of association management. Instead, this API provides endpoints that are useful across all the other areas of the platform. It is most commonly used to execute Queries which may combine data points from several apps.

Download OpenAPI description
system-v1.json
system-v1.yaml
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/system/system-v1/
https://system.api.rhythmsoftware.com/

Queries

Queries

Operations

Gets the current status and results for a query that has previously been started

Request

Gets the current status and results for a query that has previously been started

Path
tenantIdstringrequired

Parameters to the query

idstringrequired

The ID of a previously started query

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/system/system-v1/queries/{tenantId}/describe/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The query details were located successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
durationnumber(float)(Duration)

The query execution time

has_result_setboolean(Has Result Set)

Did this query return data?

idstring(ID)

The id of the query

metadata_uristring(Metadata Uri)

The location where you can download the metadata for this query

rowsnumber(float)(Rows)

The number of rows returned by this query

schedule_idstring(Schedule)

The ID of the query delivery schedule that initiated this query

sizenumber(float)(Size)

The size of the data returned by this query

statusstring(Status)

The current status of the query

sys_created_atstring(date-time)(Sys Created At)

The date/time that this query was started

sys_created_by_idstring(Sys Created By)

The ID of the user that created this record

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

The date/time that this query status was last updated

sys_last_modified_by_idstring(Sys Last Modified By)

The ID of the user that last modified this record

uristring(Uri)

The location where you can download the results of this query

Response
application/json
{
  "duration": 0.1,
  "has_result_set": true,
  "id": "string",
  "metadata_uri": "string",
  "rows": 0.1,
  "schedule_id": "string",
  "size": 0.1,
  "status": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "uri": "string"
}

Gets the definition for a specific type of query including the available fields

Request

Gets the definition for a specific type of query including the available fields

Path
tenantIdstringrequired

Parameters to the query

queryTypestringrequired

The type of query

Query
contextIdstring

Optional query type

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/system/system-v1/queries/{tenantId}/public/description/{queryType}?contextId=string'

Responses

The contact was merged successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
common_table_expressionsArray of objects
contextobject(Context)
default_output_fieldsArray of objectsnon-emptyrequired
default_output_fields[].​applies_when_contextstring(Applies When Context)
Enum"both""is given""is not given"
default_output_fields[].​labelstring(Label)
default_output_fields[].​namestring(Name)required
default_sort_fieldsArray of objectsnon-emptyrequired
default_sort_fields[].​applies_when_contextstring(Applies When Context)
Enum"both""is given""is not given"
default_sort_fields[].​descendingboolean(Descending)
default_sort_fields[].​namestring(Name)required
descriptionstring(Description)
fieldsArray of objects
idstring(ID)
namestring(Name)
perform_custom_resolution_logicboolean(Perform Custom Resolution Logic)

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

primary_tablestring(Primary Table)required
servicesArray of objects
Response
application/json
{
  "common_table_expressions": [
    { … }
  ],
  "context": {
    "display_name": "string",
    "field": "string",
    "help_text": "string",
    "required": true,
    "service": "string"
  },
  "default_output_fields": [
    { … }
  ],
  "default_sort_fields": [
    { … }
  ],
  "description": "string",
  "fields": [
    { … }
  ],
  "id": "string",
  "name": "string",
  "perform_custom_resolution_logic": true,
  "primary_table": "string",
  "services": [
    { … }
  ]
}

Starts a new query and returns the query id and info

Request

Starts a new query and returns the query id and info

Path
tenantIdstringrequired

The current tenant

queryTypestringrequired

The type of query

outputFormatstringrequired

The output format of the query

Bodyapplication/jsonrequired

The query

context_idstring(Context)
criteriaobject(Criteria)
limitnumber(float)(Limit)

The maximum number of rows to return

namestring(Name)

Optional name of the query

offsetnumber(float)(Offset)

The starting rows

output_fieldsArray of objectsnon-emptyrequired
output_fields[].​aliasstring(Alias)
output_fields[].​labelstring(Label)
output_fields[].​namestring(Name)required
sort_fieldsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/system/system-v1/queries/{tenantId}/start/{queryType}/{outputFormat}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "context_id": "string",
    "criteria": {},
    "limit": 0.1,
    "name": "string",
    "offset": 0.1,
    "output_fields": [
      {
        "alias": "string",
        "label": "string",
        "name": "string"
      }
    ],
    "sort_fields": [
      {
        "descending": true,
        "name": "string"
      }
    ]
  }'

Responses

The query was started successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
idstring(ID)

The id of the query

Response
application/json
{
  "id": "string"
}

Step Functions

Step Functions

Operations