diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/http-rest-api.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/http-rest-api.adoc index 0a2a1831..90204b95 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/http-rest-api.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/http-rest-api.adoc @@ -72,6 +72,7 @@ Reduced objects can be requested by the path suffix "/$". See xref:bibliography.adoc#bib1[[1]] for further details. Exceptions to this rule are API Operations requiring pagination and error cases. + * By default, blobs are not part of the payload. Using ?extent=WithBLOBValue includes blobs for submodel elements of kind BLOB. * Submodels define a hierarchical structure. @@ -333,7 +334,7 @@ The payload is generated from the technology-neutral specification as described // Previously pointing to Clause 11.4.2 The link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/mappings/mappings.html#value-only-serialization-in-json[serialization of JSON values] is described in xref:bibliography.adoc#bib1[[1]]. -Additional classes needed for payload of the HTTP/REST API specification can be found in xref:specification/interfaces-payload.adoc#metamodel-specification-details[Metamodel Specification Details]. +Additional classes needed for payload of the HTTP/REST API specification can be found in the xref:specification/interfaces-payload.adoc#descriptor[Descriptor Definition]. [#modifier-constraints] == Modifier Constraints diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/query-language.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/query-language.adoc index 42875f76..50cf95a3 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/query-language.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/query-language.adoc @@ -324,9 +324,9 @@ h| Casting Operator h| Description h| Definition | `$time()` | Casts the `value` to `xs:time`. | Defined by https://www.w3.org/TR/xpath-functions/#casting-to-datetimes |=== -Implicite casting is used together with FieldIdentifiers. FieldIdentifiers are generally treated as `xs:string` in the query language. + -If a FieldIdentifier is used in a logicalExpression, it will be implicitely casted to `xs:boolean`, which can only create a valid result for the values true and false. + -If a FieldIdentifier is used in a comparison, the second parameter decides implicite casting. If the second parameter is a constant (string, number, hex, boolean, dateTime, time) or a corresponding explicite casting operator, the value of the FieldIdentifier will be implicitely casted to the corresponding data type. +Implicit casting is used together with FieldIdentifiers. FieldIdentifiers are generally treated as `xs:string` in the query language. + +If a FieldIdentifier is used in a logicalExpression, it will be implicitly casted to `xs:boolean`, which can only create a valid result for the values true and false. + +If a FieldIdentifier is used in a comparison, the second parameter decides implicit casting. If the second parameter is a constant (string, number, hex, boolean, dateTime, time) or a corresponding explicite casting operator, the value of the FieldIdentifier will be implicitely casted to the corresponding data type. == Referring to Elements in Lists and Arrays diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc index 8330d233..860222f8 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc @@ -20,14 +20,9 @@ For metamodel elements like AssetAdministrationShell, Submodel, Identifier, etc. The AAS package format and the AAS Package type are defined in Part 5 xref:bibliography.adoc#bib4[[4\]]. This clause only defines additional classes that are needed for communication with the API. -[#metamodel-specification-details] -== Metamodel Specification Details - -The following type definitions are used to describe specific metamodel elements like Asset Administration Shells and submodels regarding their network and deployment configuration. -They use certain attributes copied from the model element itself to describe it – hence the name _Descriptor_. [#descriptor] -=== Descriptor +== Descriptor [.table-with-appendix-table] [cols="25%,40%,25%,10%"] @@ -51,7 +46,7 @@ e|displayName a|Display name; can be provided in several languages | link:https: e|extension a|An extension of the element |link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/common.html#Extension[Extension] |0..* |=== -=== AssetAdministrationShellDescriptor +== AssetAdministrationShellDescriptor [.table-with-appendix-table] [cols="25%,40%,25%,10%"] @@ -79,7 +74,7 @@ A client, therefore, might decide to skip the lookup on the AssetAdministrationS Nevertheless, in case the information contained in the AssetAdministrationShellDescriptor deviates from the related AssetAdministrationShell, or attributes are missing, the AssetAdministrationShell is always the source of truth. ==== -=== SubmodelDescriptor +== SubmodelDescriptor [.table-with-appendix-table] [cols="25%,40%,25%,10%"] @@ -98,7 +93,7 @@ e|semanticId a|Identifier of the semantic definition of the Submodel |link:https e|supplementalSemanticId a|Identifier of a supplemental semantic definition of the element called supplemental semantic ID of the element |link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/referencing.html#Reference[Reference] |0..* |=== -=== Endpoint +== Endpoint [.table-with-appendix-table] [cols="25%,40%,25%,10%"] @@ -178,7 +173,7 @@ See the following example for descriptor endpoints, that expose two submodel end ] ---- -=== ProtocolInformation +== ProtocolInformation [.table-with-appendix-table] [cols="25%,40%,25%,10%"] @@ -280,7 +275,7 @@ a|TLSA according to RFC 6698 a|Decentralized Identifiers according to the W3C Recommendation xref:bibliography.adoc#bib7[[7\]] |=== -=== AssetLink +== AssetLink [.table-with-appendix-table] [cols="25%,40%,25%,10%"] @@ -379,7 +374,7 @@ An example ServiceDescription object might look like the following, indicating t ---- [[QueryResult]] -=== Query Results +== Query Results Result elements of AAS queries depend on the declared output selector and the target of the query. Possible targets are Asset Administration Shells, Submodels, Concept Descriptions, Asset Administration Shell Descriptors, and Submodel Descriptors. In accordance, also these objects are returned in the Query Result. In addition, their representation can be controlled via the select statements of the input query, e.g., by only selecting the identifiers of the respective objects rather than the whole content. @@ -523,7 +518,7 @@ e|QueryResult |List of Asset Administration Shells _or ---- |=== -=== Simple Data Types +== Simple Data Types All simple data types from link:https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1/spec-metamodel/datatypes.html#predefined_simple_data_types[Part 1] xref:bibliography.adoc#bib1[[1\]] apply also to the specifications described in this document. Additional data types are defined in <>. @@ -540,7 +535,7 @@ Additional data types are defined in <