DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
| Line 10: | Line 10: | ||
|colspan="2"|<span style="color:green">page</span> | |colspan="2"|<span style="color:green">page</span> | ||
|0..1 | |0..1 | ||
|<span title="Information about paging if the client wishes to page results, including page number and page size">[[#class_PageInformation|PageInformation]]</span> | |||
|optional page number and size if the client is looking for paged results | |optional page number and size if the client is looking for paged results | ||
|- | |- | ||
|colspan="2"|<span style="color:green">textSearch</span> | |colspan="2"|<span style="color:green">textSearch</span> | ||
|0..1 | |0..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |||
|If a free text search is part of the query | |If a free text search is part of the query | ||
|- | |- | ||
|colspan="2"|<span style="color:green">argument</span> | |colspan="2"|<span style="color:green">argument</span> | ||
|0..* | |0..* | ||
|<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span> | |||
|arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs | |arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs | ||
|- | |- | ||
|rowspan="2"|or | |rowspan="2"|or | ||
|<span style="color:green">query</span> | |<span style="color:green">query</span> | ||
| Line 30: | Line 33: | ||
|The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach | |The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach | ||
|- | |- | ||
| | | | ||
<span style="color:green">queryIri</span> | <span style="color:green">queryIri</span> | ||
| | |||
|1..1 | |1..1 | ||
|<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</span> | |<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</span> | ||
|The IRI of a predefined query in the information model. i.e. request the system to run query X | |The IRI of a predefined query in the information model. i.e. request the system to run query X | ||
|- | |- | ||
colspan="2"|<span style="color:green">referenceDate</span> | |||
|0..1 | |||
|<span title="im date time format">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23DateTime/ im:DateTime]</span> | |||
|reference date for date ranges that use reference date. Note that it could be passed in as an argeument | |||
|- | |||
|- | |- | ||
|} | |} | ||
Revision as of 13:42, 24 August 2022
| Class | Field | c | Type | Comment | ||
|---|---|---|---|---|---|---|
| QueryRequest | page | 0..1 | PageInformation | optional page number and size if the client is looking for paged results | ||
| textSearch | 0..1 | xsd:string | If a free text search is part of the query | |||
| argument | 0..* | Argument | arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs | |||
| or | query | 1..1 | 1..1 | 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 | |
|
queryIri |
1..1 | sh:IRI | The IRI of a predefined query in the information model. i.e. request the system to run query X | |||
| 0..1 | im:DateTime | reference date for date ranges that use reference date. Note that it could be passed in as an argeument | ||||