Adding new semantic use case to the GET LIST API

[agg3fe]

Overview

The purpose of this ticket is to implement the API endpoints for the
use_case_model_mapping
. Needed is a GET endpoint to retrieve the existing mappings.

Explain the topic in 2 sentences

What's the benefit?

What are the Risks/Dependencies ?

Detailed explanation

Current implementation

Proposed improvements

Feature Team

Contributor

• Contributor 1
• Contributor 2

Committer

• Committer 1
• Committer 2

User Stories

• Issue 1, linked to specific repository
• Issue 2, linked to another specific repository

Acceptance Criteria

• Criteria 1
• Criteria 2
• Criteria 3

Test Cases

Test Case 1

Steps

1. Do something
2. Click something
3. Add something

Expected Result

1. Expectation
2. Expectation
3. Expectation

Architectural Relevance

The following items are ensured (answer: yes) after this issue is implemented.

In the context of the standards 126 and 127, typically only one is applicable, depending on the specific use case. Please cross out one of the two standards that does not apply.

• This feature aligns with our current architectural guidelines
  • Data Sovereignty: All data sharing activities across company boundaries follow the Catena-X Regulatory Framework, in particular the Data Exchange Governance, and the Dataspace Protocol via a compliant Connector (like the tractusx-edc or similar, see Connector KIT)
    • CX-0010 Business Partner Number
    • CX-0013 Identity of Member Companies
    • CX-0018 Data Space Connectivity (EDC)
    • CX-0049 DID Document Schema
    • CX-0050 Framework Agreement Credential
    • CX-0149 Verified Company Identity
  • Interoperability: Digital Twins are used (compliant to the Digital Twin KIT and the Industry Core KIT)
    • CX-0001 EDC Discovery API
    • CX-0002 Digital Twins in Catena-X
    • CX-0018 Data Space Connectivity (EDC)
    • CX-0126 Industry Core: Part Type 2.0.0
    • CX-0127 Industry Core: Part Instance 2.0.0
  • Data Format:
    • The data model is based on a published Semantic Model
• The impact on the overall system architecture has been assessed. The Feature does not require changes to the architecture or any existing standard? Please have a look here on the overarching architecture
• Potential risks or conflicts with existing architecture has been assessed

Justification: (Fill this out, if at least one of the checkboxes above cannot be ticked. Contact the Architecture Management Committee to get an approval for the justification)

Additional information

• I am aware that my request may not be developed if no developer can be found for it. I'll try to contribute a developer (bring your own developer)

[mittalVaghela]

Develop a mapping component with the following features:

1. GET Endpoint to Retrieve Mappings

Implement a GET endpoint that retrieves mapping information, returning a structured JSON response containing the following details:

Endpoint Details:

• URL: /api/mappings

• Method: GET

• Response: JSON array of mapping objects, structured as follows:

              {
                "items": [
                  {
                    "urn": "urn:bamm:io.catenax.asset_tracker_links:1.0.0#AssetTrackerLinks",
                    "version": "1.0.0",
                    "name": "AssetTrackerLinks",
                    "type": "BAMM",
                    "status": "DRAFT",
                    "useCase": [
                      "Traceability",
                      "Asset and IoT Device (tracker)"
                    ]
                  },
                  ............
                ],
                "totalItems": 10,
                "currentPage": 0,
                "totalPages": 5,
                "itemCount": 10
              }

2. Requirements

• Mapping Object Fields:

  Each mapping object must include:

   -  urn: string, the unique resource name.
    
    - useCase: array of strings, representing one or more use case names.
  

• Functional Requirements:

    - The endpoint should support filtering by useCase.
  
    - If a user attempts to filter by a non-existent useCase, the response must return an error with the message: "UseCase_not_existing".
  

Current Implementation

Currently, there is no useCase type associated with any model. The existing implementation only returns semantic models without their corresponding use cases.