Gets the current status and results for a query that has previously been started
curl -i -X GET \ https://system.api.rhythmsoftware.com/queries/:tenantId/describe/:id \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "duration": 0,
- "has_result_set": true,
- "id": "string",
- "metadata_uri": "string",
- "rows": 0,
- "schedule_id": "string",
- "size": 0,
- "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
curl -i -X GET \ 'https://system.api.rhythmsoftware.com/queries/:tenantId/public/description/:queryType?contextId=string'
{- "common_table_expressions": [
- {
- "alias": "string",
- "materialized": true,
- "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",
- "path": "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"
}
]
}
Starts a new query and returns the query id and info
The query
{- "context_id": "string",
- "criteria": { },
- "limit": 0,
- "name": "string",
- "offset": 0,
- "output_fields": [
- {
- "alias": "string",
- "label": "string",
- "name": "string"
}
], - "sort_fields": [
- {
- "descending": true,
- "name": "string"
}
]
}
{- "id": "string"
}