Skip to content

Commit d464b5e

Browse files
Deprecate GetAllAssetAdministrationShellIdsByAssetLink (#376)
* Deprecate GetAllAssetAdministrationShellIdsByAssetLink * Deprecate GetAllAssetAdministrationShellIdsByAssetLink in interface definition * Add SearchAllAssetAdministrationShellIdsByAssetLink in interface definition * Added AssetLink class * Update link for AssetLink --------- Co-authored-by: sebbader-sap <[email protected]>
1 parent 822c01b commit d464b5e

File tree

2 files changed

+44
-1
lines changed

2 files changed

+44
-1
lines changed

documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,21 @@ a|TLSA according to RFC 6698
260260
a|Decentralized Identifiers according to the W3C Recommendation xref:bibliography.adoc#bib7[[7\]]
261261
|===
262262

263+
=== AssetLink
264+
265+
[.table-with-appendix-table]
266+
[cols="25%,40%,25%,10%"]
267+
|===
268+
h|Class Name 3+e|[[AssetLink]]AssetLink
269+
h|Explanation 3+a|Asset identifier derieved from either SpecificAssetId or GlobalAssetId
270+
h|Inherits from 3+|-
271+
h|semanticId 3+|`\https://admin-shell.io/aas/API/DataTypes/AssetLink/3/1`
272+
273+
h|Attribute h|Explanation h| Type h|Card.
274+
e|name |Name of the Asset identifier, i.e., "globalAssetId", a serial number, manufacturer part ID, or customer part IDs | link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/spec-metamodel/datatypes.html#LabelType[LabelType] |1
275+
e|value |Value of the Asset Identifier | link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/spec-metamodel/datatypes.html#Identifier[Identifier] |1
276+
|===
277+
263278
[#service-description]
264279
=== ServiceDescription
265280

documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1812,7 +1812,7 @@ e| xref:DeleteAllAssetLinksById[DeleteAllAssetLinksById] |Deletes all asset ide
18121812
[.table-with-appendix-table]
18131813
[width=100%,cols="25%,35%,10%,20%,10%"]
18141814
|===
1815-
h|Operation Name 4+e|[[GetAllAssetAdministrationShellIdsByAssetLink]]GetAllAssetAdministrationShellIdsByAssetLink
1815+
h|Operation Name 4+e|[[GetAllAssetAdministrationShellIdsByAssetLink]]GetAllAssetAdministrationShellIdsByAssetLink \<<Deprecated>>
18161816
h|Explanation 4+a|Returns a list of Asset Administration Shell ids based on asset identifier key-value-pairs
18171817
h|semanticId 4+|`\https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/1`
18181818

@@ -1864,6 +1864,34 @@ It is the predefined name “_globalAssetId_” that would refer to the _AssetIn
18641864
|no |link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/spec-metamodel/core.html#SpecificAssetId[SpecificAssetId] |1..*
18651865
|===
18661866

1867+
==== Operation SearchAllAssetAdministrationShellIdsByAssetLink
1868+
1869+
[.table-with-appendix-table]
1870+
[width=100%,cols="25%,35%,10%,20%,10%"]
1871+
|===
1872+
h|Operation Name 4+e|[[SearchAllAssetAdministrationShellIdsByAssetLink]]SearchAllAssetAdministrationShellIdsByAssetLink
1873+
h|Explanation 4+a|Returns a list of Asset Administration Shell IDs linked to specific asset identifiers or the global asset ID
1874+
h|semanticId 4+|`https://admin-shell.io/aas/API/SearchAllAssetAdministrationShellIdsByAssetLink/3/1`
1875+
1876+
h|Name h|Description h|Mand. h|Type h|Card.
1877+
5+h|Input Parameter
1878+
|assetLinks a|
1879+
A list of AssetLinks that all shall match. An AssetLink might be either derived from a SpecificAssetId ("name": "<specificAssetId.name>", "value": "<specificAssetId.value>") or a globalAssetId ("name": "globalAssetId", "value": "<globalAssetId-value>").
1880+
1881+
====
1882+
Note: The name for the globalAssetId is defined in Contraint AASd-116 in IDTA-0001.
1883+
It is the predefined key “_globalAssetId_” that would refer to the _AssetInformation/globalAssetId_.
1884+
====
1885+
1886+
1887+
|yes |link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01002/v3.1/specification/interfaces-payload.html#AssetLink[AssetLink] |1..*
1888+
|limit |The maximum size of the result set |no |nonNegativeInteger |1
1889+
|cursor |The position from which to resume a result listing |no |string |1
1890+
5+h|Output Parameter
1891+
|statusCode |Status code |yes |xref:specification/interfaces-payload.adoc#StatusCode[StatusCode] |1
1892+
|payload |Identifiers of all Asset Administration Shells which contain all asset identifier key-value-pairs in their asset information, i.e. AND-match of key-value-pairs per Asset Administration Shell |no |link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/spec-metamodel/datatypes.html#Identifier[Identifier] |1..*
1893+
|===
1894+
18671895
==== Operation PostAllAssetLinksById
18681896

18691897
[.table-with-appendix-table]

0 commit comments

Comments
 (0)