Class | Field | Type | Comment | ||
---|---|---|---|---|---|
QueryRequest | 0..1 |
page | PageInformation | optional page number and size if the client is looking for paged results | |
0..1 |
textSearch | xsd:string | If a free text search is part of the query | ||
0..* |
argument | Argument | arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs | ||
1..1 or |
1..1 |
query | Query | The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach | |
1..1 |
queryIri | sh:IRI | The IRI of a predefined query in the information model. i.e. request the system to run query X | ||
0..1 |
referenceDate | [1] | reference date for date ranges that use reference date. Note that it could be passed in as an argeument | ||
PageInformation | 1..1 |
pageNumber | [2] | Page number (starting at 1) | |
1..1 |
pageSize | [3] | number of entries per page | ||
Argument | 1..1 |
parameter | [4] | Parameter name for a function or the parameter name for an argument | |
1..1 or |
1..1 |
valueData | [5] | Vaue that is a literal such as a string or number | |
1..1 |
valueVariable | [6] | argumetn value which is a variable name to be resolved at run time | ||
1..1 |
valueSelect | SelectClause | Argument value that is the result of a select query | ||
1..1 |
valueIri | [7] | Argument value that is an iri | ||
Query (subtype of ModelHeading) |
0..1 |
resultFormat | [8] | Whether the result set is required flat select style json or a nested graphql json object style 'RELATIONAL' or 'OBJECT. Default is OBJECT | |
0..1 |
usePrefixes | [9] | true if you want the results to use IRI prefixes | ||
0..1 |
activeOnly | [10] | Whether only active entities are included in the match clauses or select clauses | ||
1..1 or |
1..1 |
select | SelectClause | Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability | |
0..1 |
ask | MatchClause | If the query is a boolean true or false use match clauses as an ask | ||
0..1 |
mainEntity | [11] | The main entity to which all matches must be related e.g. Patient or organisation. | ||
SelectClause | 0..* |
subselect | SelectClause | For a query with column groups such as a list report, the select query for each group | |
ModelHeading (subtype of Entity) |
1..1 |
alias | [12] | An alias or reference term that can be used throughout a query as shorthand for the result set | |
MatchClause | |||||
Entity | 1..1 |
label | [13] | the name of the entity | |
0..1 |
comment | [14] | the description of the entity | ||
1..1 |
type | [15] | the base type of the entity i.e. one of the high level entity types | ||
1..1 |
status | [16] | the status of the entity being active, inactive, draft or unassigned | ||
1..1 |
scheme | [17] | The code scheme or graph which the entity belongs to |