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 | im:DateTime | reference date for date ranges that use reference date. Note that it could be passed in as an argeument | ||
PageInformation | 1..1 |
pageNumber | xsd:integer | Page number (starting at 1) | |
1..1 |
pageSize | xsd:integer | number of entries per page | ||
Argument | 1..1 |
parameter | xsd:string | Parameter name for a function or the parameter name for an argument | |
1..1 or |
1..1 |
valueData | xsd:string | Vaue that is a literal such as a string or number | |
1..1 |
valueVariable | xsd:string | argumenT 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 | sh:IRI | Argument value that is an iri | ||
Query (subtype of ModelHeading) |
0..1 |
resultFormat | xsd:string | 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 | xsd:boolean | true if you want the results to use IRI prefixes | ||
0..1 |
activeOnly | xsd:boolean | 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 | sh:NodeShape | The main entity to which all matches must be related e.g. Patient or organisation. i.e. the IRI of a data model entity (SHACL shape) | ||
SelectClause (subtype of ModelHeading) |
0..1 |
count | xsd:boolean | If the query result is simply a sum of the main entities found. equivalent to COUNT(ie) | |
0..1 or |
0..* |
property | PropertySelectClause | Information about a property or field to includein the results. Property select supports nesting with selects for the objects that may be values of the property | |
1..1 |
pathToTarget | PathTargetClause | Special function for path query. Information about the target entity when the query is looking to return paths between a source and a target. Both are likely to be passed in as parameters | ||
0..* |
match | MatchClause | The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL | ||
0..1 |
distinct | xsd:boolean | Whether the entity objects returned should be distinct | ||
0..1 or |
1..1 |
entityType | ConceptReference | The entity type for instances this select clause operates on. Options include including subtypes. | |
1..1 |
entityId | ConceptReference | An instance of an enttu for which this select clause operates. As in entity type, optionally to include subtypes, where the entity id is a concept | ||
1..1 |
entityIn | rdfs:Resource | The consept set, value set, or query result set that forms the base population of instances on which the select clause operates. e.g. a parent cohort. | ||
0..* |
groupBy | PropertySelectClause | If the results need to be grouped, the grouping properties. | ||
0..* |
orderLimit | OrderLimitClause | Ordering of instances via a property value and limiting th enumber returned. | ||
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 | xsd:string | An alias or reference term that can be used throughout a query as shorthand for the result set | |
MatchClause | |||||
PropertySelectClause | |||||
PathTargetClause | |||||
ConceptReference | |||||
OrderLimitClause | |||||
Entity | 1..1 |
label | xsd:string | the name of the entity | |
0..1 |
comment | xsd:string | the description of the entity | ||
1..1 |
type | rdfs:Resource | the base type of the entity i.e. one of the high level entity types | ||
1..1 |
status | im:Status | the status of the entity being active, inactive, draft or unassigned | ||
1..1 |
scheme | im:Graph | The code scheme or graph which the entity belongs to |