DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
| Line 9: | Line 9: | ||
|rowspan="6"|<span id="class_QueryRequest">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/ <span style="color:navy"> '''QueryRequest'''</span>]</span> | |rowspan="6"|<span id="class_QueryRequest">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fendhealth.info%2Fim%23QueryRequest/ <span style="color:navy"> '''QueryRequest'''</span>]</span> | ||
|colspan="2"|<span style="color:green">page</span> | |colspan="2"|<span style="color:green">page</span> | ||
|0..1 | |colspan="2"|0..1 | ||
|<span title="Information about paging if the client wishes to page results, including page number and page size">[[#class_PageInformation|PageInformation]]</span> | |<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 | ||
| Line 15: | Line 15: | ||
|colspan="2"|<span style="color:green">textSearch</span> | |colspan="2"|<span style="color:green">textSearch</span> | ||
|0..1 | |colspan="2"|0..1 | ||
|<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span> | |<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 | ||
| Line 21: | Line 21: | ||
|colspan="2"|<span style="color:green">argument</span> | |colspan="2"|<span style="color:green">argument</span> | ||
|0..* | |colspan="2"|0..* | ||
|<span title="A named parameter and a value for passing into a function">[[#class_Argument|Argument]]</span> | |<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 | ||
| Line 40: | Line 40: | ||
|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> | |colspan="2"|<span style="color:green">referenceDate</span> | ||
|colspan="2"|0..1 | |colspan="2"|0..1 | ||
Revision as of 13:49, 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 | |||
| referenceDate | 0..1 | im:DateTime | reference date for date ranges that use reference date. Note that it could be passed in as an argeument | |||