Test

From Endeavour Knowledge Base
Revision as of 14:54, 23 August 2022 by DavidStables (talk | contribs)
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
property
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 Date
pageNumber Page number (starting at 1) Number
pageSize number of entries per page Number
property 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 Resource shape)
General headings such as name description and alias 1..1
alias
Resource shape The abstract data model for all resources with IRIs in the model i.e. the data model of the entities that are labelled with iri