DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
| Line 9: | Line 9: | ||
|rowspan="6"|A request containing a query to be passed as a payload to the queryIM API. | |rowspan="6"|A request containing a query to be passed as a payload to the queryIM API. | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|<span title="optional page number and size if the client is looking for paged results"> [[#rule_page|page]]</span | |colspan="2"|<span title="optional page number and size if the client is looking for paged results"> [[#rule_page|page]]</span> | ||
|- | |- | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|<span title="If a free text search is part of the query"> [[#rule_textSearch|textSearch]]</span | |colspan="2"|<span title="If a free text search is part of the query"> [[#rule_textSearch|textSearch]]</span> | ||
|- | |- | ||
|0..*<br> | |0..*<br> | ||
|colspan="2"|<span title="arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs"> [[#rule_argument|argument]]</span | |colspan="2"|<span title="arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs"> [[#rule_argument|argument]]</span> | ||
|- | |- | ||
|rowspan="2"|1..1<br>or | |rowspan="2"|1..1<br>or | ||
|1..1<br> | |1..1<br> | ||
|<span title="The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach"> [[#rule_query|query]]</span | |<span title="The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach"> [[#rule_query|query]]</span> | ||
|- | |- | ||
| | | | ||
1..1<br> | 1..1<br> | ||
|<span title="The IRI of a predefined query in the information model. i.e. request the system to run query X"> [[#rule_queryIri|queryIri]]</span | |<span title="The IRI of a predefined query in the information model. i.e. request the system to run query X"> [[#rule_queryIri|queryIri]]</span> | ||
|- | |- | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|<span title="reference date for date ranges that use reference date. Note that it could be passed in as an argeument"> [[#rule_referenceDate|referenceDate]]</span | |colspan="2"|<span title="reference date for date ranges that use reference date. Note that it could be passed in as an argeument"> [[#rule_referenceDate|referenceDate]]</span> | ||
|- | |- | ||
|rowspan="2"|<span style="color:green" id="rule_page">'''page'''</span> | |rowspan="2"|<span style="color:green" id="rule_page">'''page'''</span> | ||
|rowspan="2"|Information about paging if the client wishes to page results, including page number and page size | |rowspan="2"|Information about paging if the client wishes to page results, including page number and page size | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|<span title="Page number (starting at 1)"> [[#rule_pageNumber|pageNumber]]</span | |colspan="2"|<span title="Page number (starting at 1)"> [[#rule_pageNumber|pageNumber]]</span> | ||
|- | |- | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|<span title="number of entries per page"> [[#rule_pageSize|pageSize]]</span | |colspan="2"|<span title="number of entries per page"> [[#rule_pageSize|pageSize]]</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_textSearch">'''textSearch'''</span> | |<span style="color:green" id="rule_textSearch">'''textSearch'''</span> | ||
|If a free text search is part of the query | |If a free text search is part of the query | ||
| | | | ||
|colspan="2"|Text | |colspan="2"|<span title="any valid json value characters with json escapes">Text</span> | ||
|- | |- | ||
|rowspan="5"|<span style="color:green" id="rule_argument">'''argument'''</span> | |rowspan="5"|<span style="color:green" id="rule_argument">'''argument'''</span> | ||
|rowspan="5"|A named parameter and a value for passing into a function | |rowspan="5"|A named parameter and a value for passing into a function | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|<span title="Parameter name for a function or the parameter name for an argument"> [[#rule_parameter|parameter]]</span | |colspan="2"|<span title="Parameter name for a function or the parameter name for an argument"> [[#rule_parameter|parameter]]</span> | ||
|- | |- | ||
|rowspan="4"|1..1<br>or | |rowspan="4"|1..1<br>or | ||
|1..1<br> | |1..1<br> | ||
|<span title="Vaue that is a literal such as a string or number"> [[#rule_valueData|valueData]]</span | |<span title="Vaue that is a literal such as a string or number"> [[#rule_valueData|valueData]]</span> | ||
|- | |- | ||
| | | | ||
1..1<br> | 1..1<br> | ||
|<span title="argumetn value which is a variable name to be resolved at run time"> [[#rule_valueVariable|valueVariable]]</span | |<span title="argumetn value which is a variable name to be resolved at run time"> [[#rule_valueVariable|valueVariable]]</span> | ||
|- | |- | ||
| | | | ||
1..1<br> | 1..1<br> | ||
|<span title="Argument value that is the result of a select query"> [[#rule_valueSelect|valueSelect]]</span | |<span title="Argument value that is the result of a select query"> [[#rule_valueSelect|valueSelect]]</span> | ||
|- | |- | ||
| | | | ||
1..1<br> | 1..1<br> | ||
|<span title="Argument value that is an iri"> [[#rule_valueIri|valueIri]]</span | |<span title="Argument value that is an iri"> [[#rule_valueIri|valueIri]]</span> | ||
|- | |- | ||
| | | | ||
| Line 72: | Line 72: | ||
|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"|IRI | |colspan="2"|<span title="international resource identifier">IRI</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_referenceDate">'''referenceDate'''</span> | |<span style="color:green" id="rule_referenceDate">'''referenceDate'''</span> | ||
|reference date for date ranges that use reference date. Note that it could be passed in as an argeument | |reference date for date ranges that use reference date. Note that it could be passed in as an argeument | ||
| | | | ||
|colspan="2"| | |colspan="2"|span title="im date time format">im:DateTime</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_pageNumber">'''pageNumber'''</span> | |<span style="color:green" id="rule_pageNumber">'''pageNumber'''</span> | ||
|Page number (starting at 1) | |Page number (starting at 1) | ||
| | | | ||
|colspan="2"| | |colspan="2"|span title="whole number">Integer</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_pageSize">'''pageSize'''</span> | |<span style="color:green" id="rule_pageSize">'''pageSize'''</span> | ||
|number of entries per page | |number of entries per page | ||
| | | | ||
|colspan="2"| | |colspan="2"|span title="whole number">Integer</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_parameter">'''parameter'''</span> | |<span style="color:green" id="rule_parameter">'''parameter'''</span> | ||
|Parameter name for a function or the parameter name for an argument | |Parameter name for a function or the parameter name for an argument | ||
| | | | ||
|colspan="2"|Text | |colspan="2"|<span title="any valid json value characters with json escapes">Text</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_valueData">'''valueData'''</span> | |<span style="color:green" id="rule_valueData">'''valueData'''</span> | ||
|Vaue that is a literal such as a string or number | |Vaue that is a literal such as a string or number | ||
| | | | ||
|colspan="2"|Text | |colspan="2"|<span title="any valid json value characters with json escapes">Text</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_valueVariable">'''valueVariable'''</span> | |<span style="color:green" id="rule_valueVariable">'''valueVariable'''</span> | ||
|argumetn value which is a variable name to be resolved at run time | |argumetn value which is a variable name to be resolved at run time | ||
| | | | ||
|colspan="2"|Text | |colspan="2"|<span title="any valid json value characters with json escapes">Text</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_valueSelect">'''valueSelect'''</span> | |<span style="color:green" id="rule_valueSelect">'''valueSelect'''</span> | ||
| Line 112: | Line 112: | ||
|Argument value that is an iri | |Argument value that is an iri | ||
| | | | ||
|colspan="2"|IRI | |colspan="2"|<span title="international resource identifier">IRI</span> | ||
|- | |- | ||
|rowspan="1"|<span style="color:green" id="rule_ModelHeading">'''ModelHeading'''<br> (subtype of [[#rule_Entity|Entity]])</span> | |rowspan="1"|<span style="color:green" id="rule_ModelHeading">'''ModelHeading'''<br> (subtype of [[#rule_Entity|Entity]])</span> | ||
|rowspan="1"|General headings such as name description and alias | |rowspan="1"|General headings such as name description and alias | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|<span title="An alias or reference term that can be used throughout a query as shorthand for the result set"> [[#rule_alias|alias]]</span | |colspan="2"|<span title="An alias or reference term that can be used throughout a query as shorthand for the result set"> [[#rule_alias|alias]]</span> | ||
|- | |- | ||
|rowspan="5"|<span style="color:green" id="rule_Entity">'''Entity'''</span> | |rowspan="5"|<span style="color:green" id="rule_Entity">'''Entity'''</span> | ||
|rowspan="5"|The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status | |rowspan="5"|The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|<span title="the name of the entity"> [[#rule_label|label]]</span | |colspan="2"|<span title="the name of the entity"> [[#rule_label|label]]</span> | ||
|- | |- | ||
|0..1<br> | |0..1<br> | ||
|colspan="2"|<span title="the description of the entity"> [[#rule_comment|comment]]</span | |colspan="2"|<span title="the description of the entity"> [[#rule_comment|comment]]</span> | ||
|- | |- | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|<span title="the base type of the entity i.e. one of the high level entity types"> [[#rule_type|type]]</span | |colspan="2"|<span title="the base type of the entity i.e. one of the high level entity types"> [[#rule_type|type]]</span> | ||
|- | |- | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|<span title="the status of the entity being active, inactive, draft or unassigned"> [[#rule_status|status]]</span | |colspan="2"|<span title="the status of the entity being active, inactive, draft or unassigned"> [[#rule_status|status]]</span> | ||
|- | |- | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|<span title="The code scheme or graph which the entity belongs to"> [[#rule_scheme|scheme]]</span | |colspan="2"|<span title="The code scheme or graph which the entity belongs to"> [[#rule_scheme|scheme]]</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_alias">'''alias'''</span> | |<span style="color:green" id="rule_alias">'''alias'''</span> | ||
|An alias or reference term that can be used throughout a query as shorthand for the result set | |An alias or reference term that can be used throughout a query as shorthand for the result set | ||
| | | | ||
|colspan="2"|Text | |colspan="2"|<span title="any valid json value characters with json escapes">Text</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_label">'''label'''</span> | |<span style="color:green" id="rule_label">'''label'''</span> | ||
|the name of the entity | |the name of the entity | ||
| | | | ||
|colspan="2"|Text | |colspan="2"|<span title="any valid json value characters with json escapes">Text</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_comment">'''comment'''</span> | |<span style="color:green" id="rule_comment">'''comment'''</span> | ||
|the description of the entity | |the description of the entity | ||
| | | | ||
|colspan="2"|Text | |colspan="2"|<span title="any valid json value characters with json escapes">Text</span> | ||
|- | |- | ||
|<span style="color:green" id="rule_type">'''type'''</span> | |<span style="color:green" id="rule_type">'''type'''</span> | ||
Revision as of 15:55, 23 August 2022
| Rule/property/API | Overview | Cardinality | Subrule/property or literal type | |
|---|---|---|---|---|
| .../queryIM | A request containing a query to be passed as a payload to the queryIM API. | 0..1 |
page | |
| 0..1 |
textSearch | |||
| 0..* |
argument | |||
| 1..1 or |
1..1 |
query | ||
|
1..1 |
queryIri | |||
| 0..1 |
referenceDate | |||
| page | Information about paging if the client wishes to page results, including page number and page size | 1..1 |
pageNumber | |
| 1..1 |
pageSize | |||
| textSearch | If a free text search is part of the query | Text | ||
| argument | A named parameter and a value for passing into a function | 1..1 |
parameter | |
| 1..1 or |
1..1 |
valueData | ||
|
1..1 |
valueVariable | |||
|
1..1 |
valueSelect | |||
|
1..1 |
valueIri | |||
| query (subtype of ModelHeading) |
A Query definition holding the logical definition of a query in a standard language | |||
| queryIri | The IRI of a predefined query in the information model. i.e. request the system to run query X | IRI | ||
| referenceDate | reference date for date ranges that use reference date. Note that it could be passed in as an argeument | span title="im date time format">im:DateTime | ||
| pageNumber | Page number (starting at 1) | span title="whole number">Integer | ||
| pageSize | number of entries per page | span title="whole number">Integer | ||
| parameter | Parameter name for a function or the parameter name for an argument | Text | ||
| valueData | Vaue that is a literal such as a string or number | Text | ||
| valueVariable | argumetn value which is a variable name to be resolved at run time | Text | ||
| valueSelect | points to a select clause | |||
| valueIri | Argument value that is an iri | IRI | ||
| ModelHeading (subtype of Entity) |
General headings such as name description and alias | 1..1 |
alias | |
| Entity | The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status | 1..1 |
label | |
| 0..1 |
comment | |||
| 1..1 |
type | |||
| 1..1 |
status | |||
| 1..1 |
scheme | |||
| alias | An alias or reference term that can be used throughout a query as shorthand for the result set | Text | ||
| label | the name of the entity | Text | ||
| comment | the description of the entity | Text | ||
| type | the base type of the entity i.e. one of the high level entity types | rdfs:Resource | ||
| status | the status of the entity being active, inactive, draft or unassigned | im:Status | ||
| scheme | The code scheme or graph which the entity belongs to | im:Graph | ||