Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define Matching Strategy for GetAllxyzBySemanticId #342

Open
1 task done
sebbader-sap opened this issue Nov 14, 2024 · 1 comment
Open
1 task done

Define Matching Strategy for GetAllxyzBySemanticId #342

sebbader-sap opened this issue Nov 14, 2024 · 1 comment
Labels

Comments

@sebbader-sap
Copy link
Contributor

What is missing?

GetAllSubmodelsBySemanticId states that the value of the query parameter is a Reference, however, there are no more details given.
Missing:

  1. Is the Reference serialised in JSON and then base64url encoded?
  2. Is the matching for "Exact Matching", "Value Matching", or even "Intelligent Matching"?

How should it be fixed?

Decide on the intended behavior and add it to the respective part of the specifcation.

  • I have signed the required Developer Certificate of Origin (DCO) already.
@BirgitBoss
Copy link
Collaborator

In Design Decisions
semanticIds are included in the parameters that need to be base64url-encoded, see

Identifiers of Identifiables are base64url-encoded to be passed to the HTTP/REST API (see https://www.base64url.com/). 
These may be identifiers for Asset Administration Shells, Submodels, or Concept Descriptions.
Identifiers may also be passed as base64url-encoded query parameters, 
e.g. for semanticId or assetId. 
Such query parameters are typically used when a list of objects may be retrieved in the resulting payload. A list of base64url-encoded ids is simply passed as comma-separated query parameters.

However, it is only a "may"- statement.

I would propose to add a new parameter "matchStrategy" with the values "exact", "value" and "intelligent" with default "exact". For "intelligent" a second parameter "matchSubStrategy" might be needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants